Skip to content

Latest commit

 

History

History
120 lines (84 loc) · 3.93 KB

di.md

File metadata and controls

120 lines (84 loc) · 3.93 KB
Raw

di - require a consistent DI syntax

All your DI should use the same syntax : the Array, function, or $inject syntaxes ("di": [2, "array, function, or $inject"])

Rule based on Angular 1.x

Examples

The following patterns are considered problems with default config;

/*eslint angular/di: 2*/

// invalid
angular.module('myModule').factory('myService', ['$http', '$log', 'anotherService', function ($http, $log, anotherService) {
    // ...
}]); // error: You should use the function syntax for DI

The following patterns are not considered problems with default config;

/*eslint angular/di: 2*/

// valid
angular.module('myModule').factory('myService', function ($http, $log, anotherService) {
   // ...
});

The following patterns are considered problems when configured "array":

/*eslint angular/di: [2,"array"]*/

// invalid
angular.module('myModule').factory('myService', ['$http', '$log', 'anotherService', function ($http, $log) {
    // ...
}]); // error: The signature of the method is incorrect

// invalid
angular.module('myModule').factory('myService', ['$http', '$log', function ($log, $http) {
    // ...
}]); // error: You have an error in your DI configuration. Each items of the array should match exactly one function parameter

// invalid
angular.module('myModule').factory('myService', ['$http', function ($http, $log) {
    // ...
}]); // error: The signature of the method is incorrect

The following patterns are not considered problems when configured "array":

/*eslint angular/di: [2,"array"]*/

// valid
angular.module('myModule').factory('myService', ['$http', '$log', 'anotherService', function ($http, $log, anotherService) {
    // ...
}]);

The following patterns are not considered problems when configured "array" and {"matchNames":false}:

/*eslint angular/di: [2,"array",{"matchNames":false}]*/

// valid
angular.module('myModule').factory('myService', ['eslintService', function (service) {
    // ...
}]);

The following patterns are considered problems when configured "$inject":

/*eslint angular/di: [2,"$inject"]*/

// invalid
angular.module('myModule').factory('myService', myServiceFn);
myServiceFn.$inject=['$http', '$log', 'anotherService'];
function myServiceFn($http, $log) {
    // ...
} // error: The signature of the method is incorrect

// invalid
angular.module('myModule').factory('myService', myServiceFn);
myServiceFn.$inject=['$http', '$log'];
function myServiceFn($http, $log, anotherService) {
    // ...
} // error: The signature of the method is incorrect

// invalid
angular.module('myModule').factory('myService', myServiceFn);
myServiceFn.$inject=['$log', '$http'];
function myServiceFn($http, $log) {
    // ...
} // error: You have an error in your DI configuration. Each items of the array should match exactly one function parameter

The following patterns are not considered problems when configured "$inject":

/*eslint angular/di: [2,"$inject"]*/

// valid
angular.module('myModule').factory('myService', myServiceFn);
myServiceFn.$inject=['$http', '$log', 'anotherService'];
function myServiceFn($http, $log, anotherService) {
    // ...
}

The following patterns are not considered problems when configured "$inject" and {"matchNames":false}:

/*eslint angular/di: [2,"$inject",{"matchNames":false}]*/

// valid
angular.module('myModule').factory('myService', myServiceFn);
myServiceFn.$inject=['eslintService'];
function myServiceFn(Service) {
    // ...
}

Version

This rule was introduced in eslint-plugin-angular 0.1.0

Links