new rule provider-name

Author: oriSomething

Diff for: docs/provider-name.md

@@ -0,0 +1,59 @@
+<!-- WARNING: Generated documentation. Edit docs and examples in the rule and examples file ('rules/provider-name.js', 'examples/provider-name.js'). -->
+
+# provider-name - require and specify a prefix for all provider names
+
+All your providers 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 providers by "$" (reserved keyword for AngularJS services) ("provider-name":  [2, "ng"])
+*
+
+**Styleguide Reference**
+
+* [y125 by johnpapa - Naming - Factory and Service Names](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125)
+
+## Examples
+
+The following patterns are **not** considered problems when configured `"prefix"`:
+
+    /*eslint angular/provider-name: [2,"prefix"]*/
+
+    // valid
+    angular.module('myModule').provider('prefixProvider', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/provider-name: [2,"/^xyz/"]*/
+
+    // invalid
+    angular.module('myModule').provider('otherProvider', function () {
+        // ...
+    }); // error: The otherProvider provider should follow this pattern: /^xyz/
+
+The following patterns are **not** considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/provider-name: [2,"/^xyz/"]*/
+
+    // valid
+    angular.module('myModule').provider('xyzProvider', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"xyz"`:
+
+    /*eslint angular/provider-name: [2,"xyz"]*/
+
+    // invalid
+    angular.module('myModule').provider('myProvider', function () {
+        // ...
+    }); // error: The myProvider provider should be prefixed by xyz
+
+## Version
+
+This rule was introduced in eslint-plugin-angular 1.4.1
+
+## Links
+
+* [Rule source](../rules/provider-name.js)
+* [Example source](../examples/provider-name.js)

Diff for: examples/provider-name.js

@@ -0,0 +1,19 @@
+// example - valid: true, options: ["prefix"]
+angular.module('myModule').provider('prefixProvider', function () {
+    // ...
+});
+
+// example - valid: true, options: ["/^xyz/"]
+angular.module('myModule').provider('xyzProvider', function () {
+    // ...
+});
+
+// example - valid: false, options: ["xyz"], errorMessage: "The myProvider provider should be prefixed by xyz"
+angular.module('myModule').provider('myProvider', function () {
+    // ...
+});
+
+// example - valid: false, options: ["/^xyz/"], errorMessage: "The otherProvider provider should follow this pattern\: /^xyz/"
+angular.module('myModule').provider('otherProvider', function () {
+    // ...
+});

Diff for: rules/provider-name.js

@@ -0,0 +1,56 @@
+/**
+ * require and specify a prefix for all provider names
+ *
+ * All your providers 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 providers by "$" (reserved keyword for AngularJS services) ("provider-name":  [2, "ng"])
+ **
+ * @styleguideReference {johnpapa} `y125` Naming - Factory and Service Names
+ * @version 0.1.0
+ * @category naming
+ */
+'use strict';
+
+
+var utils = require('./utils/utils');
+
+
+module.exports = function(context) {
+    return {
+
+        CallExpression: function(node) {
+            var prefix = context.options[0];
+            var convertedPrefix; // convert string from JSON .eslintrc to regex
+            var isProvider;
+
+            if (prefix === undefined) {
+                return;
+            }
+
+            convertedPrefix = utils.convertPrefixToRegex(prefix);
+            isProvider = utils.isAngularProviderDeclaration(node);
+
+            if (isProvider) {
+                var name = node.arguments[0].value;
+
+                if (name !== undefined && name.indexOf('$') === 0) {
+                    context.report(node, 'The {{provider}} provider should not start with "$". This is reserved for AngularJS services', {
+                        provider: name
+                    });
+                } else if (name !== undefined && !convertedPrefix.test(name)) {
+                    if (typeof prefix === 'string' && !utils.isStringRegexp(prefix)) {
+                        context.report(node, 'The {{provider}} provider should be prefixed by {{prefix}}', {
+                            provider: name,
+                            prefix: prefix
+                        });
+                    } else {
+                        context.report(node, 'The {{provider}} provider should follow this pattern: {{prefix}}', {
+                            provider: name,
+                            prefix: prefix.toString()
+                        });
+                    }
+                }
+            }
+        }
+    };
+};

Diff for: test/provider-name.js

@@ -0,0 +1,63 @@
+'use strict';
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+var rule = require('../rules/provider-name');
+var RuleTester = require('eslint').RuleTester;
+var commonFalsePositives = require('./utils/commonFalsePositives');
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+var eslintTester = new RuleTester();
+var valid = [];
+var invalid = [];
+
+
+/**
+ * New Behaviour
+ */
+
+valid.push({
+    code: 'app.provider("eslintProvider", function() {});',
+    options: ['eslint']
+}, {
+    code: 'app.provider("eslintProvider", function() {});',
+    options: [/^eslint/]
+}, {
+    code: 'app.provider("eslintProvider", function() {});',
+    options: [undefined]
+}, {
+    code: 'app.provider("eslintProvider", function() {});',
+    options: ['/^eslint/']
+});
+
+invalid.push({
+    code: 'app.provider("Provider", function() {});',
+    options: ['eslint'],
+    errors: [{message: 'The Provider provider should be prefixed by eslint'}]
+}, {
+    code: 'app.provider("esLintProvider", function() {});',
+    options: ['eslint'],
+    errors: [{message: 'The esLintProvider provider should be prefixed by eslint'}]
+}, {
+    code: 'app.provider("Provider", function() {});',
+    options: [/^eslint/],
+    errors: [{message: 'The Provider provider should follow this pattern: /^eslint/'}]
+}, {
+    code: 'app.provider("Provider", function() {});',
+    options: ['/^eslint/'],
+    errors: [{message: 'The Provider provider should follow this pattern: /^eslint/'}]
+}, {
+    code: 'app.provider("$Provider", function() {});',
+    options: [/^eslint/],
+    errors: [{message: 'The $Provider provider should not start with "$". This is reserved for AngularJS services'}]
+});
+
+eslintTester.run('provider-name', rule, {
+    valid: valid.concat(commonFalsePositives),
+    invalid: invalid
+});