Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.36 KB

di-order.md

File metadata and controls

112 lines (76 loc) · 3.36 KB
Raw

di-order - require DI parameters to be sorted alphabetically

Injected dependencies should be sorted alphabetically. If the second parameter is set to false, values which start and end with an underscore those underscores are stripped. This means for example that _$httpBackend_ goes before _$http_.

Rule based on Angular 1.x

Examples

The following patterns are considered problems with default config;

/*eslint angular/di-order: 2*/

// invalid
angular.module('myModule').factory('myService', function($q, $http) {
    // ...
}); // error: Injected values should be sorted alphabetically

// invalid
angular.module('myModule').controller('SomeController', function(myService, $http) {
    // ...
}); // error: Injected values should be sorted alphabetically

// invalid
angular.module('myModule').filter('myFilter', function(someService, myService) {
    // ...
}); // error: Injected values should be sorted alphabetically

The following patterns are not considered problems with default config;

/*eslint angular/di-order: 2*/

// valid
angular.module('myModule').factory('myService', function($http, $location, $q, myService, someService) {
    // ...
});

// valid
beforeEach(inject(function (_$compile_, $httpBackend, _$log_, _$rootScope_) {
    // ...
}));

// valid
angular.module('myModule').factory('myService', function(CONFIG, URLs, authService, zero) {
    // ...
});

The following patterns are not considered problems when configured true and "case_sensitive":

/*eslint angular/di-order: [2,true,"case_sensitive"]*/

// valid
angular.module("").animation("", function(Authentication, analytics) {
    // ...
});

The following patterns are not considered problems when configured true and "case_insensitive":

/*eslint angular/di-order: [2,true,"case_insensitive"]*/

// valid
angular.module("").animation("", function(analytics, Authentication) {
    // ...
});

The following patterns are considered problems when configured true:

/*eslint angular/di-order: [2,true]*/

// invalid
beforeEach(inject(function ($httpBackend, _$compile_, _$log_, _$rootScope_) {
    // ...
})); // error: Injected values should be sorted alphabetically

The following patterns are not considered problems when configured true:

/*eslint angular/di-order: [2,true]*/

// valid
beforeEach(inject(function (_$compile_, $httpBackend, _$log_, _$rootScope_) {
    // ...
}));

The following patterns are considered problems when configured false:

/*eslint angular/di-order: [2,false]*/

// invalid
beforeEach(inject(function (_$compile_, $httpBackend, _$log_, _$rootScope_) {
    // ...
})); // error: Injected values should be sorted alphabetically

The following patterns are not considered problems when configured false:

/*eslint angular/di-order: [2,false]*/

// valid
beforeEach(inject(function ($httpBackend, _$compile_, _$log_, _$rootScope_) {
    // ...
}));

Version

This rule was introduced in eslint-plugin-angular 0.6.0

Links