option to disable implicit matching

closes #4

Author: Andrew Schmadel

README.md

@@ -29,6 +29,21 @@ and add the plugin to your `.babelrc` file:
 }
 ```
 
+## Options
+
+### `explicitOnly`
+
+By default, this plugin will attempt to add annotations to common AngularJS code patterns.  This behavior can be disabled (requiring you to mark up functions with `/* @ngInject */` or `'ngInject'`).
+
+To pass this option to the plugin, [add it to your Babel configuration](https://babeljs.io/docs/plugins/#plugin-options):
+
+```json
+{
+  "presets": ["es2015"],
+  "plugins": [["angularjs-annotate", { "explicitOnly" : true}]]
+}
+```
+
 ## Usage
 
 See [ng-annotate](https://github.com/olov/ng-annotate)'s documentation and the [test sources](tests/) for details about the patterns that can be automatically detected by ng-annotate and this plugin, as well as information about how to explicitly mark functions and classes for annotation. 

babel-ng-annotate.js

@@ -57,9 +57,11 @@ module.exports = function() {
         enter(path) {
           ngInject.inspectAssignment(path, ctx);
         },
-        exit(path) {
-          let targets = matchProviderGet(path);
-          addTargets(targets);
+        exit(path, state) {
+          if(!state.opts.explicitOnly){
+            let targets = matchProviderGet(path);
+            addTargets(targets);
+          }
         }
       },
       VariableDeclarator: {
@@ -81,15 +83,19 @@ module.exports = function() {
         enter(path) {
           ngInject.inspectObjectExpression(path, ctx);
         },
-        exit(path) {
-          let targets = matchProviderGet(path);
-          addTargets(targets);
+        exit(path, state) {
+          if(!state.opts.explicitOnly){
+            let targets = matchProviderGet(path);
+            addTargets(targets);
+          }
         }
       },
       ReturnStatement: {
-        exit(path) {
-          let targets = matchDirectiveReturnObject(path);
-          addTargets(targets);
+        exit(path, state) {
+          if(!state.opts.explicitOnly){
+            let targets = matchDirectiveReturnObject(path);
+            addTargets(targets);
+          }
         }
       },
       FunctionExpression: {
@@ -111,9 +117,9 @@ module.exports = function() {
         enter(path) {
           ngInject.inspectCallExpression(path, ctx);
         },
-        exit(path) {
-          let targets = match(path, ctx);
-          addTargets(targets);
+        exit(path, state) {
+            let targets = match(path, ctx, state.opts.explicitOnly);
+            addTargets(targets);
         }
       },
       ExportDeclaration: {
@@ -123,6 +129,8 @@ module.exports = function() {
       },
       Program: {
         enter(path, file) {
+          file.opts.explicitOnly = file.opts.explicitOnly || false;
+
           ctx.suspects = [];
           ctx.blocked = [];
           ctx.fragments = [];

ng-annotate-main.js

@@ -16,7 +16,7 @@ const chainedUrlRouterProvider = 2;
 const chainedStateProvider = 3;
 const chainedRegular = 4;
 
-function match(path, ctx, matchPlugins) {
+function match(path, ctx, explicitOnly) {
     const node = path.node;
     const isMethodCall = (
         t.isCallExpression(node) &&
@@ -28,6 +28,10 @@ function match(path, ctx, matchPlugins) {
         return false;
     }
 
+    if(explicitOnly){
+        return false;
+    }
+
     // matchInjectorInvoke must happen before matchRegular
     // to prevent false positive ($injector.invoke() outside module)
     // matchProvide must happen before matchRegular

package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-angularjs-annotate",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Babel plugin to add angularjs dependency injection annotations",
   "main": "babel-ng-annotate.js",
   "repository": {

tests/es6.js

@@ -4,6 +4,7 @@ module.exports = {
   tests: [
   {
     name: "simple class",
+    implicit: true,
     input: function(){
           class svc {
               constructor(dep1){
@@ -24,6 +25,7 @@ module.exports = {
   },
   {
     name: "exported class",
+    implicit: true,
     noES5: true, // this works with the ES2015 preset, but the transformations
                  // make it difficult to test
     input: `
@@ -46,6 +48,7 @@ module.exports = {
   },
   {
     name: "exported annotated function",
+    explicit: true,
     input: `
       /* @ngInject */
       export default function svc(dep1){}
@@ -58,6 +61,7 @@ module.exports = {
   },
   {
     name: "annotated class",
+    explicit: true,
     input: function(){
       /* @ngInject */
       class svc {
@@ -81,6 +85,7 @@ module.exports = {
   {
     name: "exported annotated class",
     noES5: true,
+    explicit: true,
     input: `
       /* @ngInject */
       export default class svc {
@@ -103,6 +108,7 @@ module.exports = {
   },
   {
     name: "annotated constructor",
+    explicit: true,
     input: function(){
       class svc {
           /* @ngInject */
@@ -125,6 +131,7 @@ module.exports = {
   },
   {
     name: "constructor with prologue directive",
+    explicit: true,
     input: function(){
       class svc {
           constructor(dep1){

tests/inside_module.js

@@ -4,6 +4,7 @@ module.exports = {
   {
     name: "Injector invoke",
     contextDependent: true,
+    implicit: true,
     input: function(){
       $injector.invoke(function($compile) {
           $compile(myElement)(scope);
@@ -17,6 +18,7 @@ module.exports = {
   },
   {
     name: "httpProvider",
+    implicit: true,
     contextDependent: true,
     input: function(){
       $httpProvider.interceptors.push(function($scope) { a });
@@ -29,6 +31,7 @@ module.exports = {
   },
   {
     name: "$routeProvider",
+    implicit: true,
     contextDependent: true,
     input: function(){
       $routeProvider.when("path", {

tests/issues.js

@@ -3,6 +3,7 @@ module.exports = {
   tests: [
     {
       name: "regression-test for https://github.com/olov/ng-annotate/issues/221",
+      explicit: true,
       input: function(){
         var FooBar = (function (_super) {
             __extends(FooBar, _super);
@@ -87,6 +88,7 @@ module.exports = {
     {
       name: "$stateProvider.decorator should not be injected",
       // not a module declaration short-form, see https://github.com/olov/ng-annotate/issues/82
+      implicit: true,
       input: function(){
         $stateProvider.decorator('parent', function (state, parentFn) {
           doStuff();
@@ -118,6 +120,7 @@ module.exports = {
     },
     {
       name: "empty var declarator",
+      implicit: true,
       input: function(){
         var MyCtrl12;
         angular.module("MyMod").controller('MyCtrl', MyCtrl12);
@@ -129,6 +132,7 @@ module.exports = {
     },
     {
       name: "issue 115",
+      explicit: true,
       input: function(){
         module.exports = function() {
             "use strict";
@@ -158,6 +162,7 @@ module.exports = {
     },
     {
       name: "issue 135",
+      explicit: true,
       input: function(){
         var MyCtrl = (function() {
             /*@ngInject*/

tests/modals.js

@@ -3,6 +3,7 @@ module.exports = {
     tests: [
       {
         name: "Modal Open",
+        implicit: true,
         contextDependent: true,
         input: function(){
           $modal.open({
@@ -32,6 +33,7 @@ module.exports = {
       {
         name: "uibModal Open",
         contextDependent: true,
+        implicit: true,
         input: function(){
           $uibModal.open({
               templateUrl: "str",
@@ -59,6 +61,7 @@ module.exports = {
       },
       {
         name: "Material Design Modal",
+        implicit: true,
         contextDependent: true,
         input: function(){
           $mdDialog.show({
@@ -88,6 +91,7 @@ module.exports = {
       {
         name: "Material Design Bottom Sheet",
         contextDependent: true,
+        implicit: true,
         input: function(){
           $mdBottomSheet.show({
               templateUrl: "str",
@@ -116,6 +120,7 @@ module.exports = {
       {
         name: "Material Design Toast",
         contextDependent: true,
+        implicit: true,
         input: function(){
           $mdToast.show({
               templateUrl: "str",

tests/ngInject-arrow.js

@@ -257,6 +257,7 @@ module.exports = {
         var MyDirective2 = ($stateProvider) => {
             $stateProvider.state('astate', {
                 resolve: {
+                    /* @ngInject */
                     yoyo: (ma) => {
                     },
                 }
@@ -268,6 +269,7 @@ module.exports = {
         var MyDirective2 = ($stateProvider) => {
             $stateProvider.state('astate', {
                 resolve: {
+                    /* @ngInject */
                     yoyo: ['ma', (ma) => {
                     }],
                 }
@@ -276,5 +278,5 @@ module.exports = {
         MyDirective2.$inject = ['$stateProvider'];
       }
     }
-  ]
+  ].map(t => { t.explicit=true; return t; })
 }

tests/ngInject.js

@@ -366,6 +366,7 @@ module.exports = {
         function MyDirective2($stateProvider) {
             $stateProvider.state('astate', {
                 resolve: {
+                    /* @ngInject */
                     yoyo: function(ma) {
                     },
                 }
@@ -379,12 +380,13 @@ module.exports = {
         function MyDirective2($stateProvider) {
             $stateProvider.state('astate', {
                 resolve: {
+                    /* @ngInject */
                     yoyo: ['ma', function(ma) {
                     }],
                 }
             });
         }
       }
     }
-  ]
+  ].map(t => { t.explicit=true; return t; })
 }