Merge pull request #195 from tilmanpotthof/issue-179/ng_file_name-add-ignorePrefix-option

Issue #179 - add options ignorePrefix with tests and documentation

Author: EmmanuelDemey

README.md

@@ -85,7 +85,7 @@ We provide also three samples :
 | 'directive-name': 0                                       | All your directives 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 directives by "ng" (reserved keyword for AngularJS directives) ("directive-name":  [2, "ng"]) [Y073](https://github.com/johnpapa/angular-styleguide#style-y073), [Y126](https://github.com/johnpapa/angular-styleguide#style-y126) |
 | 'document-service': 2                                     | Instead of the default document object, you should prefer the AngularJS wrapper service $document. [Y180](https://github.com/johnpapa/angular-styleguide#style-y180) |
 | 'empty-controller': 0                                     | If you have one empty controller, maybe you have linked it in your Router configuration or in one of your views. You can remove this declaration because this controller is useless |
-| 'file-name': 0                                            | All your file names should match the angular component name. The second parameter can be a config object [2, {nameStyle: 'dash', typeSeparator: 'dot', ignoreTypeSuffix: true}] to match `avenger-profile.directive.js` or `avanger-api.service.js`. Possible values for `typeSeparator` and `nameStyle` are `dot`, `dash` and `underscore`. The options `ignoreTypeSuffix` ignores camel cased suffixes like `someController` or `myService`. [Y120](https://github.com/johnpapa/angular-styleguide#style-y120) [Y121](https://github.com/johnpapa/angular-styleguide#style-y121) |
+| 'file-name': 0                                            | All your file names should match the angular component name. The second parameter can be a config object [2, {nameStyle: 'dash', typeSeparator: 'dot', ignoreTypeSuffix: true, ignorePrefix: 'ui'}] to match 'avenger-profile.directive.js' or 'avanger-api.service.js'. Possible values for 'typeSeparator' and 'nameStyle' are 'dot', 'dash' and 'underscore'. The options 'ignoreTypeSuffix' ignores camel cased suffixes like 'someController' or 'myService' and 'ignorePrefix' ignores namespace prefixes like 'ui'. [Y120](https://github.com/johnpapa/angular-styleguide#style-y120) [Y121](https://github.com/johnpapa/angular-styleguide#style-y121) |
 | 'filter-name': 0                                          | All your filters 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. ("filter-name":  [2, "ng"]) |
 | 'foreach': 0                                              | You should use the angular.forEach method instead of the default JavaScript implementation [].forEach. |
 | 'function-type': 0                                        | Anonymous or named functions inside AngularJS components. The first parameter sets which type of function is required and can be 'named' or 'anonymous'. The second parameter is an optional list of angular object names. [Y024](https://github.com/johnpapa/angular-styleguide/blob/master/README.md#style-y024) |

rules/file-name.js

@@ -27,6 +27,9 @@ module.exports = (function () {
         firstToUpper: function (value) {
             return value[0].toUpperCase() + value.slice(1);
         },
+        firstToLower: function (value) {
+            return value[0].toLowerCase() + value.slice(1);
+        },
         removeTypeSuffix: function (name, type) {
             var nameTypeLengthDiff = name.length - type.length;
             if (nameTypeLengthDiff <= 0) {
@@ -39,6 +42,13 @@ module.exports = (function () {
                 return name;
             }
         },
+        removePrefix: function (name, options) {
+            if (new RegExp('^' + options.ignorePrefix + '[A-Z]').test(name)) {
+                return this.firstToLower(name.slice(options.ignorePrefix.length));
+            } else {
+                return name;
+            }
+        },
         transformComponentName: function (name, options) {
             var nameStyle = options.nameStyle;
             var nameSeparator = separators[nameStyle];
@@ -54,6 +64,9 @@ module.exports = (function () {
             if (options.ignoreTypeSuffix) {
                 name = filenameUtil.removeTypeSuffix(name, type);
             }
+            if (options.ignorePrefix && options.ignorePrefix.length > 0) {
+                name = filenameUtil.removePrefix(name, options);
+            }
             if (options.nameStyle) {
                 name = filenameUtil.transformComponentName(name, options);
             }

test/file-name.js

@@ -124,6 +124,31 @@ eslintTester.run('file-name', rule, {
             typeSeparator: 'dot',
             nameStyle: 'underscore'
         }]
+    }, {
+        // ignorePrefix xp with typeSeparator dot and ignoreTypeSuffix
+        filename: 'src/app/asset.service.js',
+        code: 'angular.factory("xpAssetService", xpAssetService)',
+        options: [{
+            typeSeparator: 'dot',
+            ignoreTypeSuffix: true,
+            ignorePrefix: 'xp'
+        }]
+    }, {
+        // ignorePrefix st with typeSeparator dash
+        filename: 'src/app/appUtils-service.js',
+        code: 'angular.factory("stAppUtils", stAppUtils)',
+        options: [{
+            typeSeparator: 'dash',
+            ignorePrefix: 'st'
+        }]
+    }, {
+        // test to detect false positives for ignorePrefix
+        filename: 'staging_service.js',
+        code: 'angular.factory("staging", staging)',
+        options: [{
+            typeSeparator: 'underscore',
+            ignorePrefix: 'st'
+        }]
     }],
     invalid: [{
         filename: 'src/app/filters.js',
@@ -170,5 +195,15 @@ eslintTester.run('file-name', rule, {
             nameStyle: 'dash'
         }],
         errors: [{ message: 'Filename must be "avanger-profile.directive.js"'}]
+    }, {
+        // ignorePrefix xp
+        filename: 'src/app/xpAsset.service.js',
+        code: 'angular.factory("xpAssetService", xpAssetService)',
+        options: [{
+            typeSeparator: 'dot',
+            ignoreTypeSuffix: true,
+            ignorePrefix: 'xp'
+        }],
+        errors: [{ message: 'Filename must be "asset.service.js"'}]
     }]
 });