Merge pull request #428 from Gillespie59/development

1.6.0

Author: EmmanuelDemey

README.md

@@ -136,12 +136,16 @@ These rules prevent you from using deprecated angular features.
 These rules help you to specify several naming conventions.
 
  * [component-name](docs/component-name.md) - require and specify a prefix for all component names
+ * [constant-name](docs/constant-name.md) - require and specify a prefix for all constant names ([y125](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125))
  * [controller-name](docs/controller-name.md) - require and specify a prefix for all controller names ([y123](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y123), [y124](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y124))
  * [directive-name](docs/directive-name.md) - require and specify a prefix for all directive names ([y073](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y073), [y126](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y126))
+ * [factory-name](docs/factory-name.md) - require and specify a prefix for all factory names ([y125](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125))
  * [file-name](docs/file-name.md) - require and specify a consistent component name pattern ([y120](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y120), [y121](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y121))
  * [filter-name](docs/filter-name.md) - require and specify a prefix for all filter names
  * [module-name](docs/module-name.md) - require and specify a prefix for all module names ([y127](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y127))
+ * [provider-name](docs/provider-name.md) - require and specify a prefix for all provider names ([y125](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125))
  * [service-name](docs/service-name.md) - require and specify a prefix for all service names ([y125](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125))
+ * [value-name](docs/value-name.md) - require and specify a prefix for all value names ([y125](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125))
 
 ### Conventions
 

docs/constant-name.md

@@ -0,0 +1,59 @@
+<!-- WARNING: Generated documentation. Edit docs and examples in the rule and examples file ('rules/constant-name.js', 'examples/constant-name.js'). -->
+
+# 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**
+
+* [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/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
+
+* [Rule source](../rules/constant-name.js)
+* [Example source](../examples/constant-name.js)

docs/factory-name.md

@@ -0,0 +1,59 @@
+<!-- WARNING: Generated documentation. Edit docs and examples in the rule and examples file ('rules/factory-name.js', 'examples/factory-name.js'). -->
+
+# factory-name - require and specify a prefix for all factory names
+
+All your factorys 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 factorys by "$" (reserved keyword for AngularJS services) ("factory-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/factory-name: [2,"prefix"]*/
+
+    // valid
+    angular.module('myModule').factory('prefixFactory', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/factory-name: [2,"/^xyz/"]*/
+
+    // invalid
+    angular.module('myModule').factory('otherFactory', function () {
+        // ...
+    }); // error: The otherFactory factory should follow this pattern: /^xyz/
+
+The following patterns are **not** considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/factory-name: [2,"/^xyz/"]*/
+
+    // valid
+    angular.module('myModule').factory('xyzFactory', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"xyz"`:
+
+    /*eslint angular/factory-name: [2,"xyz"]*/
+
+    // invalid
+    angular.module('myModule').factory('myFactory', function () {
+        // ...
+    }); // error: The myFactory factory should be prefixed by xyz
+
+## Version
+
+This rule was introduced in eslint-plugin-angular 0.1.0
+
+## Links
+
+* [Rule source](../rules/factory-name.js)
+* [Example source](../examples/factory-name.js)

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 0.1.0
+
+## Links
+
+* [Rule source](../rules/provider-name.js)
+* [Example source](../examples/provider-name.js)

docs/service-name.md

@@ -15,39 +15,39 @@ You can not prefix your services by "$" (reserved keyword for AngularJS services
 
 ## Examples
 
-The following patterns are **not** considered problems when configured `"prefix"`:
+The following patterns are **not** considered problems when configured `"prefix"` and `{"oldBehavior":false}`:
 
-    /*eslint angular/service-name: [2,"prefix"]*/
+    /*eslint angular/service-name: [2,"prefix",{"oldBehavior":false}]*/
 
     // valid
-    angular.module('myModule').factory('prefixService', function () {
+    angular.module('myModule').service('prefixService', function () {
         // ...
     });
 
-The following patterns are considered problems when configured `"/^xyz/"`:
+The following patterns are considered problems when configured `"/^xyz/"` and `{"oldBehavior":false}`:
 
-    /*eslint angular/service-name: [2,"/^xyz/"]*/
+    /*eslint angular/service-name: [2,"/^xyz/",{"oldBehavior":false}]*/
 
     // invalid
-    angular.module('myModule').factory('otherService', function () {
+    angular.module('myModule').service('otherService', function () {
         // ...
     }); // error: The otherService service should follow this pattern: /^xyz/
 
-The following patterns are **not** considered problems when configured `"/^xyz/"`:
+The following patterns are **not** considered problems when configured `"/^xyz/"` and `{"oldBehavior":false}`:
 
-    /*eslint angular/service-name: [2,"/^xyz/"]*/
+    /*eslint angular/service-name: [2,"/^xyz/",{"oldBehavior":false}]*/
 
     // valid
-    angular.module('myModule').factory('xyzService', function () {
+    angular.module('myModule').service('xyzService', function () {
         // ...
     });
 
-The following patterns are considered problems when configured `"xyz"`:
+The following patterns are considered problems when configured `"xyz"` and `{"oldBehavior":false}`:
 
-    /*eslint angular/service-name: [2,"xyz"]*/
+    /*eslint angular/service-name: [2,"xyz",{"oldBehavior":false}]*/
 
     // invalid
-    angular.module('myModule').factory('myService', function () {
+    angular.module('myModule').service('myService', function () {
         // ...
     }); // error: The myService service should be prefixed by xyz
 

docs/value-name.md

@@ -0,0 +1,59 @@
+<!-- WARNING: Generated documentation. Edit docs and examples in the rule and examples file ('rules/value-name.js', 'examples/value-name.js'). -->
+
+# value-name - require and specify a prefix for all value names
+
+All your values 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 values by "$" (reserved keyword for AngularJS services) ("value-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/value-name: [2,"prefix"]*/
+
+    // valid
+    angular.module('myModule').value('prefixValue', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/value-name: [2,"/^xyz/"]*/
+
+    // invalid
+    angular.module('myModule').value('otherValue', function () {
+        // ...
+    }); // error: The otherValue value should follow this pattern: /^xyz/
+
+The following patterns are **not** considered problems when configured `"/^xyz/"`:
+
+    /*eslint angular/value-name: [2,"/^xyz/"]*/
+
+    // valid
+    angular.module('myModule').value('xyzValue', function () {
+        // ...
+    });
+
+The following patterns are considered problems when configured `"xyz"`:
+
+    /*eslint angular/value-name: [2,"xyz"]*/
+
+    // invalid
+    angular.module('myModule').value('myValue', function () {
+        // ...
+    }); // error: The myValue value should be prefixed by xyz
+
+## Version
+
+This rule was introduced in eslint-plugin-angular 0.1.0
+
+## Links
+
+* [Rule source](../rules/value-name.js)
+* [Example source](../examples/value-name.js)

examples/constant-name.js

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

examples/factory-name.js

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

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 () {
+    // ...
+});

examples/service-name.js

@@ -1,20 +1,20 @@
-// example - valid: true, options: ["prefix"]
-angular.module('myModule').factory('prefixService', function () {
+// example - valid: true, options: ["prefix", {oldBehavior: false}]
+angular.module('myModule').service('prefixService', function () {
     // ...
 });
 
-// example - valid: true, options: ["/^xyz/"]
-angular.module('myModule').factory('xyzService', function () {
+// example - valid: true, options: ["/^xyz/", {oldBehavior: false}]
+angular.module('myModule').service('xyzService', function () {
     // ...
 });
 
-// example - valid: false, options: ["xyz"], errorMessage: "The myService service should be prefixed by xyz"
-angular.module('myModule').factory('myService', function () {
+// example - valid: false, options: ["xyz", {oldBehavior: false}], errorMessage: "The myService service should be prefixed by xyz"
+angular.module('myModule').service('myService', function () {
     // ...
 });
 
-// example - valid: false, options: ["/^xyz/"], errorMessage: "The otherService service should follow this pattern\: /^xyz/"
-angular.module('myModule').factory('otherService', function () {
+// example - valid: false, options: ["/^xyz/", {oldBehavior: false}], errorMessage: "The otherService service should follow this pattern\: /^xyz/"
+angular.module('myModule').service('otherService', function () {
     // ...
 });