--plugin support

Author: olov

README.md

@@ -32,6 +32,9 @@ Use the `--single_quotes` option to output `'$scope'` instead of `"$scope"`.
 Use the `--regexp` option in case you want to restrict matching further (rarely used). See
 description further down.
 
+Use the `--plugin` option to load user plugins (experimental, 0.9.x may change API). See
+[plugin-example.js](plugin-example.js) for more info.
+
 
 ## Tools support
 * [Grunt](http://gruntjs.com/): [grunt-ng-annotate](https://npmjs.org/package/grunt-ng-annotate)
@@ -161,6 +164,7 @@ ng-annotate can be used as a library. See [ng-annotate.js](ng-annotate.js) for f
 options and return value.
 
     var ngAnnotate = require("ng-annotate");
-    var res = ngAnnotate(src, {add: true})
+    var somePlugin = require("./some/path/some-plugin");
+    var res = ngAnnotate(src, {add: true, plugin: [somePlugin]})
     var errorstringArray = res.errors;
     var transformedSource = res.src;

ng-annotate-main.js

@@ -15,7 +15,7 @@ const chainedUrlRouterProvider = 2;
 const chainedStateProvider = 3;
 const chainedRegular = 4;
 
-function match(node, re) {
+function match(node, re, matchPlugins) {
     const isMethodCall = (
         node.type === "CallExpression" &&
             node.callee.type === "MemberExpression" &&
@@ -26,6 +26,7 @@ function match(node, re) {
         (matchRegular(node, re) || matchNgRoute(node) || matchUiRouter(node) || matchHttpProvider(node)));
 
     return matchMethodCalls ||
+        (matchPlugins && matchPlugins(node)) ||
         matchDirectiveReturnObject(node) ||
         matchProviderGet(node);
 }
@@ -391,7 +392,22 @@ module.exports = function ngAnnotate(src, options) {
         stringify: stringify,
     };
 
+    const plugins = options.plugin || [];
+    function matchPlugins(node, isMethodCall) {
+        for (let i = 0; i < plugins.length; i++) {
+            const res = plugins[i].match(node, isMethodCall);
+            if (res) {
+                return res;
+            }
+        }
+        return false;
+    }
+    const matchPluginsOrNull = (plugins.length === 0 ? null : matchPlugins);
+
     ngInjectComments.init(ctx);
+    plugins.forEach(function(plugin) {
+        plugin.init(ctx);
+    });
 
     traverse(ast, {pre: function(node) {
         const pos = node.range[0];
@@ -400,7 +416,7 @@ module.exports = function ngAnnotate(src, options) {
             trigger.fn.call(null, node, trigger.ctx);
         }
     }, post: function(node) {
-        let targets = match(node, re);
+        let targets = match(node, re, matchPluginsOrNull);
         if (!targets) {
             return;
         }

ng-annotate.js

@@ -26,6 +26,9 @@ const optimist = require("optimist")
     })
     .options("regexp", {
         describe: "detect short form myMod.controller(...) iff myMod matches regexp",
+    })
+    .options("plugin", {
+        describe: "use plugin with path (experimental)",
     });
 
 const argv = optimist.argv;
@@ -68,7 +71,22 @@ function addOption(opt) {
     }
 }
 
-["add", "remove", "regexp", "single_quotes"].forEach(addOption);
+["add", "remove", "regexp", "single_quotes", "plugin"].forEach(addOption);
+
+if (config.plugin) {
+    if (!Array.isArray(config.plugin)) {
+        config.plugin = [config.plugin];
+    }
+    config.plugin = config.plugin.map(function(path) {
+        const absPath = tryor(fs.realpathSync.bind(fs, path), null);
+        if (!absPath) {
+            exit(fmt('error: plugin file not found {0}', path));
+        }
+        // the require below may throw an exception on parse-error
+        // that is fine because it gives the user the line info
+        return require(absPath);
+    });
+}
 
 const ret = ngAnnotate(src, config);
 

plugin-example.js

@@ -0,0 +1,30 @@
+var ctx;
+module.exports = {
+    init: function(_ctx) {
+        console.error("plugin init called, got ctx with keys " + Object.keys(_ctx));
+
+        // ctx contains a bunch of helpers and data
+        // stash it away so you can use it inside match
+        ctx = _ctx;
+
+        // if you want to setup position triggers now, checkout nginject-comments.js
+    },
+    match: function(node) {
+        console.error("plugin match called, node with type " + node.type);
+
+        // if you think you have a match, return the found target node
+        // (may or may not be the passed in argument node)
+        // you may also return an array of target nodes
+
+        // ng-annotate will then execute replaceRemoveOrInsertArrayForTarget
+        // on every target, i.e. it may remove an array (if --remove) and it may
+        // add an array (if --add)
+
+        // please consider filing an issue if you need to workaround a defect or
+        // an obviously missing feature in ng-annotate. we'll try to fix it!
+
+        // you know about /* @ngInject */, don't you? (you may not need a plugin)
+
+        // please consider sending a pull request if your plugin is of general use
+    },
+};