Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.89 KB

constant-name.md

File metadata and controls

59 lines (38 loc) · 1.89 KB

constant-name - require and specify a prefix for all constant names

All your constants should have a name starting with the parameter you can define in your config object. The second parameter can be a Regexp wrapped in quotes. You can not prefix your constants by "$" (reserved keyword for AngularJS services) ("constant-name": [2, "ng"]) *

Styleguide Reference

Examples

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

/*eslint angular/constant-name: [2,"prefix"]*/

// valid
angular.module('myModule').constant('prefixConstant', function () {
    // ...
});

The following patterns are considered problems when configured "/^xyz/":

/*eslint angular/constant-name: [2,"/^xyz/"]*/

// invalid
angular.module('myModule').constant('otherConstant', function () {
    // ...
}); // error: The otherConstant constant should follow this pattern: /^xyz/

The following patterns are not considered problems when configured "/^xyz/":

/*eslint angular/constant-name: [2,"/^xyz/"]*/

// valid
angular.module('myModule').constant('xyzConstant', function () {
    // ...
});

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

/*eslint angular/constant-name: [2,"xyz"]*/

// invalid
angular.module('myModule').constant('myConstant', function () {
    // ...
}); // error: The myConstant constant should be prefixed by xyz

Version

This rule was introduced in eslint-plugin-angular 0.1.0

Links