eslint-plugin-angular
Advanced tools
eslint-plugin-angular - npm Package Compare versions
Comparing version 0.10.1 to 0.10.2
| { | ||
| "name": "eslint-plugin-angular", | ||
| "version": "0.10.1", | ||
| "version": "0.10.2", | ||
| "description": "ESLint rules for AngularJS projects", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
214
README.md
@@ -7,2 +7,6 @@ [](https://travis-ci.org/Gillespie59/eslint-plugin-angular) | ||
| ## Summary | ||
| This repository will give access to new rules for the ESLint tool. You should use it only if you are developing an AngularJS application. | ||
@@ -12,3 +16,21 @@ | ||
| # Usage with [shareable](http://eslint.org/docs/developer-guide/shareable-configs.html) config | ||
| ## Contents | ||
| - [Usage with shareable config](#usage-with-shareable-config) | ||
| - [Usage without shareable config](#usage-without-shareable-config) | ||
| - [Sample configs](sample-configs) | ||
| - [Defaults](#defaults) | ||
| - [Rules](#rules) | ||
| - [Need your help](#need-your-help) | ||
| - [How to create a new rule](#how-to-create-a-new-rule) | ||
| - [Default ESLint configuration file](#default-eslint-configuration-file) | ||
| - [Who uses it?](#who-uses-it) | ||
| - [Team](#team) | ||
| ## Usage with [shareable](http://eslint.org/docs/developer-guide/shareable-configs.html) config | ||
| Users may use the shareable [eslint-config-angular](https://github.com/dustinspecker/eslint-config-angular) to quickly setup eslint-plugin-angular. It also marks Angular as a global variable and defines required ESLint rules to use this plugin. | ||
@@ -40,4 +62,6 @@ | ||
| # Usage without shareable config | ||
| ## Usage without shareable config | ||
| 1. Install `eslint` as a dev-dependency: | ||
@@ -70,57 +94,121 @@ | ||
| We provide also three samples : | ||
| * demo/npm (launch: npm run lint) | ||
| * demo/grunt (launch: grunt) | ||
| * demo/gulp (launch: gulp) | ||
| # Rules | ||
| | Name and Default | Description | | ||
| ## Sample configs | ||
| - [demo/npm](https://github.com/Gillespie59/eslint-plugin-angular/tree/master/demo/npm) (launch: npm run lint) | ||
| - [demo/grunt](https://github.com/Gillespie59/eslint-plugin-angular/tree/master/demo/grunt) (launch: grunt) | ||
| - [demo/gulp](https://github.com/Gillespie59/eslint-plugin-angular/tree/master/demo/gulp) (launch: gulp) | ||
| ## Defaults | ||
| ```json | ||
| { | ||
| "plugins": [ | ||
| "angular/angular" | ||
| ], | ||
| "rules": { | ||
| "angular/angularelement": 1, | ||
| "angular/controller-as": 2, | ||
| "angular/controller-as-route": 2, | ||
| "angular/controller-as-vm": [2, "vm"], | ||
| "angular/controller-name": [2, "/[A-Z].*Controller$/"], | ||
| "angular/deferred": 0, | ||
| "angular/definedundefined": 2, | ||
| "angular/di": [2, "function"], | ||
| "angular/di-order": [0, true], | ||
| "angular/directive-name": 0, | ||
| "angular/document-service": 2, | ||
| "angular/empty-controller": 0, | ||
| "angular/file-name": 0, | ||
| "angular/filter-name": 0, | ||
| "angular/foreach": 0, | ||
| "angular/function-type": 0, | ||
| "angular/interval-service": 2, | ||
| "angular/json-functions": 2, | ||
| "angular/log": 2, | ||
| "angular/module-getter": 2, | ||
| "angular/module-name": 0, | ||
| "angular/module-setter": 2, | ||
| "angular/no-angular-mock": 0, | ||
| "angular/no-controller": 0, | ||
| "angular/no-cookiestore": 2, | ||
| "angular/no-digest": 2, | ||
| "angular/no-jquery-angularelement": 2, | ||
| "angular/no-private-call": 2, | ||
| "angular/no-service-method": 2, | ||
| "angular/no-services": [2, ["$http", "$resource", "Restangular"]], | ||
| "angular/on-watch": 2, | ||
| "angular/rest-service": 0, | ||
| "angular/service-name": 2, | ||
| "angular/timeout-service": 2, | ||
| "angular/typecheck-array": 2, | ||
| "angular/typecheck-date": 2, | ||
| "angular/typecheck-function": 2, | ||
| "angular/typecheck-number": 2, | ||
| "angular/typecheck-object": 2, | ||
| "angular/typecheck-regexp": 2, | ||
| "angular/typecheck-string": 2, | ||
| "angular/watchers-execution": [0, "$digest"], | ||
| "angular/window-service": 2 | ||
| } | ||
| } | ||
| ``` | ||
| ## Rules | ||
| | Name | Description | | ||
| | ------------- | ------------- | | ||
| | 'angularelement': 1 | The angular.element method should be used instead of the $ or jQuery object (if you are using jQuery of course). If the jQuery library is imported, angular.element will be a wrapper around the jQuery object. | | ||
| | 'controller-as': 2 | You should not set properties on $scope in controllers. Use controllerAs syntax and add data to 'this'. Implements 'this' check part of [Y031](https://github.com/johnpapa/angular-styleguide#style-y031). The second parameter can be a Regexp for identifying controller functions (when using something like Browserify) | | ||
| | 'controller-as-route': 2 | You should use Angular's controllerAs syntax when defining routes or states. Implements route part [Y031](https://github.com/johnpapa/angular-styleguide#style-y031) | | ||
| | 'controller-as-vm': [2, 'vm'] | You should use a capture variable for 'this' when using the controllerAs syntax. [Y031](https://github.com/johnpapa/angular-styleguide#style-y032). The second parameter specifies the capture variable you want to use in your application. The third parameter can be a Regexp for identifying controller functions (when using something like Browserify) | | ||
| | 'controller-name': [2, /[A-Z].*Controller$/] | All your controllers 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. ("controller-name": [2, "ng"]) [Y123](https://github.com/johnpapa/angular-styleguide#style-y123), [Y124](https://github.com/johnpapa/angular-styleguide#style-y124)| | ||
| | 'deferred': 0 | When you want to create a new promise, you should not use the $q.deferred anymore. Prefer the new syntax : $q(function(resolve, reject){}) | | ||
| | 'definedundefined': 2 | You should use the angular.isUndefined or angular.isDefined methods instead of using the keyword undefined. We also check the use of !angular.isUndefined and !angular.isDefined (should prefer the reverse function)| | ||
| | 'di': [2, 'function'] | All your DI should use the same syntax : the Array or function syntaxes ("di": [2, "function or array"])| | ||
| | 'di-order': [0, true] | 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_`. | | ||
| | '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, 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) | | ||
| | 'interval-service': 2 | Instead of the default setInterval function, you should use the AngularJS wrapper service $interval [Y181](https://github.com/johnpapa/angular-styleguide#style-y181) | | ||
| | 'json-functions': 2 | You should use angular.fromJson or angular.toJson instead of JSON.parse and JSON.stringify | | ||
| | 'log': 2 | You should use $log service instead of console for the methods 'log', 'debug', 'error', 'info', 'warn' | | ||
| | 'module-getter':2 | When using a module, avoid using a variable and instead use chaining with the getter syntax [Y022](https://github.com/johnpapa/angular-styleguide#style-y022)| | ||
| | 'module-name': 0 | When you create a new module, its name should start 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 modules by "ng" (reserved keyword for AngularJS modules) ("module-name": [2, "ng"]) [Y127](https://github.com/johnpapa/angular-styleguide#style-y127)| | ||
| | 'module-setter':2 | Declare modules without a variable using the setter syntax.[Y021](https://github.com/johnpapa/angular-styleguide#style-y021) | | ||
| | 'no-angular-mock': 0 | All methods defined in the angular.mock object are also available in the object window. So you can remove angular.mock from your code | | ||
| | 'no-controller': 0 | According to the Component-First pattern, we should avoid the use of AngularJS controller. | | ||
| | 'no-cookiestore':2 | In Angular 1.4, the $cookieStore service is now deprected. Please use the $cookies service instead| | ||
| | 'no-digest': 2 | DEPRECATED! The scope's $digest() method shouldn't be used. You should prefer the $apply method. | | ||
| | 'no-jquery-angularelement': 2 | You should not wrap angular.element object into jQuery(), because angular.element already return jQLite element| | ||
| | 'no-private-call': 2 | All scope's properties/methods starting with $$ are used internally by AngularJS. You should not use them directly. | | ||
| | 'no-service-method': 2 | You should prefer the factory() method instead of service() [Y040](https://github.com/johnpapa/angular-styleguide#style-y040)| | ||
| | 'no-services': [2, ['$http', '$resource', 'Restangular']] | Some services should be used only in a specific AngularJS service (Ajax-based service for example), in order to follow the separation of concerns paradigm. The second parameter specifies the services. The third parameter can be a list of angular objects (controller, factory, etc.). Or second parameter can be an object, where keys are angular object names and value is a list of services (like {controller: ['$http'], factory: ['$q']}) | | ||
| | 'on-watch': 2 | Watch and On methods on the scope object should be assigned to a variable, in order to be deleted in a $destroy event handler | | ||
| | 'rest-service': 0 | Check the service used to send request to your REST API. This rule can have one parameter, with one of the following values: $http, $resource or Restangular ('rest-service': [0, '$http']). | | ||
| | 'service-name': 2 | All your services 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 services by "$" (reserved keyword for AngularJS services) ("service-name": [2, "ng"]) [Y125](https://github.com/johnpapa/angular-styleguide#style-y125) | | ||
| | 'timeout-service': 2 | Instead of the default setTimeout function, you should use the AngularJS wrapper service $timeout [Y181](https://github.com/johnpapa/angular-styleguide#style-y181) | | ||
| | 'typecheck-array': 2 | You should use the angular.isArray method instead of the default JavaScript implementation (typeof [] === "[object Array]"). | | ||
| | 'typecheck-date': 2 | You should use the angular.isDate method instead of the default JavaScript implementation (typeof new Date() === "[object Date]"). | | ||
| | 'typecheck-function': 2 | You should use the angular.isFunction method instead of the default JavaScript implementation (typeof function(){} ==="[object Function]"). | | ||
| | 'typecheck-number': 2 | You should use the angular.isNumber method instead of the default JavaScript implementation (typeof 3 === "[object Number]"). | | ||
| | 'typecheck-object': 2 | You should use the angular.isObject method instead of the default JavaScript implementation (typeof {} === "[object Object]"). | | ||
| | 'typecheck-regexp': 2 | You should use the angular.isRegexp method instead of the default JavaScript implementation (toString.call(/^A/) === "[object RegExp]"). | | ||
| | 'typecheck-string': 2 | You should use the angular.isString method instead of the default JavaScript implementation (typeof "" === "[object String]"). | | ||
| | 'watchers-execution': [0, '$digest'] | For the execution of the watchers, the $digest method will start from the scope in which we call the method. This will cause an performance improvement comparing to the $apply method, who start from the $rootScope | | ||
| | 'window-service': 2 | Instead of the default window object, you should prefer the AngularJS wrapper service $window. [Y180](https://github.com/johnpapa/angular-styleguide#style-y180) | | ||
| | angularelement | The angular.element method should be used instead of the $ or jQuery object (if you are using jQuery of course). If the jQuery library is imported, angular.element will be a wrapper around the jQuery object. | | ||
| | controller-as | You should not set properties on $scope in controllers. Use controllerAs syntax and add data to 'this'. Implements 'this' check part of [Y031](https://github.com/johnpapa/angular-styleguide#style-y031). The second parameter can be a Regexp for identifying controller functions (when using something like Browserify) | | ||
| | controller-as-route | You should use Angular's controllerAs syntax when defining routes or states. Implements route part [Y031](https://github.com/johnpapa/angular-styleguide#style-y031) | | ||
| | controller-as-vm | You should use a capture variable for 'this' when using the controllerAs syntax. [Y031](https://github.com/johnpapa/angular-styleguide#style-y032). The second parameter specifies the capture variable you want to use in your application. The third parameter can be a Regexp for identifying controller functions (when using something like Browserify) | | ||
| | controller-name | All your controllers 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. ("controller-name": [2, "ng"]) [Y123](https://github.com/johnpapa/angular-styleguide#style-y123), [Y124](https://github.com/johnpapa/angular-styleguide#style-y124)| | ||
| | deferred | When you want to create a new promise, you should not use the $q.deferred anymore. Prefer the new syntax : $q(function(resolve, reject){}) | | ||
| | definedundefined | You should use the angular.isUndefined or angular.isDefined methods instead of using the keyword undefined. We also check the use of !angular.isUndefined and !angular.isDefined (should prefer the reverse function)| | ||
| | di | All your DI should use the same syntax : the Array or function syntaxes ("di": [2, "function or array"])| | ||
| | di-order | 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_`. | | ||
| | directive-name | 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 | 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 | 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 | 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 | 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 | You should use the angular.forEach method instead of the default JavaScript implementation [].forEach. | | ||
| | function-type | 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) | | ||
| | interval-service | Instead of the default setInterval function, you should use the AngularJS wrapper service $interval [Y181](https://github.com/johnpapa/angular-styleguide#style-y181) | | ||
| | json-functions | You should use angular.fromJson or angular.toJson instead of JSON.parse and JSON.stringify | | ||
| | log | You should use $log service instead of console for the methods 'log', 'debug', 'error', 'info', 'warn' | | ||
| | module-getter | When using a module, avoid using a variable and instead use chaining with the getter syntax [Y022](https://github.com/johnpapa/angular-styleguide#style-y022)| | ||
| | module-name | When you create a new module, its name should start 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 modules by "ng" (reserved keyword for AngularJS modules) ("module-name": [2, "ng"]) [Y127](https://github.com/johnpapa/angular-styleguide#style-y127)| | ||
| | module-setter | Declare modules without a variable using the setter syntax.[Y021](https://github.com/johnpapa/angular-styleguide#style-y021) | | ||
| | no-angular-mock | All methods defined in the angular.mock object are also available in the object window. So you can remove angular.mock from your code | | ||
| | no-controller | According to the Component-First pattern, we should avoid the use of AngularJS controller. | | ||
| | no-cookiestore | In Angular 1.4, the $cookieStore service is now deprected. Please use the $cookies service instead| | ||
| | no-digest | DEPRECATED! The scope's $digest() method shouldn't be used. You should prefer the $apply method. | | ||
| | no-jquery-angularelement | You should not wrap angular.element object into jQuery(), because angular.element already return jQLite element| | ||
| | no-private-call | All scope's properties/methods starting with $$ are used internally by AngularJS. You should not use them directly. | | ||
| | no-service-method | You should prefer the factory() method instead of service() [Y040](https://github.com/johnpapa/angular-styleguide#style-y040)| | ||
| | no-services | Some services should be used only in a specific AngularJS service (Ajax-based service for example), in order to follow the separation of concerns paradigm. The second parameter specifies the services. The third parameter can be a list of angular objects (controller, factory, etc.). Or second parameter can be an object, where keys are angular object names and value is a list of services (like {controller: ['$http'], factory: ['$q']}) | | ||
| | on-watch | Watch and On methods on the scope object should be assigned to a variable, in order to be deleted in a $destroy event handler | | ||
| | rest-service | Check the service used to send request to your REST API. This rule can have one parameter, with one of the following values: $http, $resource or Restangular ('rest-service': [0, '$http']). | | ||
| | service-name | All your services 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 services by "$" (reserved keyword for AngularJS services) ("service-name": [2, "ng"]) [Y125](https://github.com/johnpapa/angular-styleguide#style-y125) | | ||
| | timeout-service | Instead of the default setTimeout function, you should use the AngularJS wrapper service $timeout [Y181](https://github.com/johnpapa/angular-styleguide#style-y181) | | ||
| | typecheck-array | You should use the angular.isArray method instead of the default JavaScript implementation (typeof [] === "[object Array]"). | | ||
| | typecheck-date | You should use the angular.isDate method instead of the default JavaScript implementation (typeof new Date() === "[object Date]"). | | ||
| | typecheck-function | You should use the angular.isFunction method instead of the default JavaScript implementation (typeof function(){} ==="[object Function]"). | | ||
| | typecheck-number | You should use the angular.isNumber method instead of the default JavaScript implementation (typeof 3 === "[object Number]"). | | ||
| | typecheck-object | You should use the angular.isObject method instead of the default JavaScript implementation (typeof {} === "[object Object]"). | | ||
| | typecheck-regexp | You should use the angular.isRegexp method instead of the default JavaScript implementation (toString.call(/^A/) === "[object RegExp]"). | | ||
| | typecheck-string | You should use the angular.isString method instead of the default JavaScript implementation (typeof "" === "[object String]"). | | ||
| | watchers-execution | For the execution of the watchers, the $digest method will start from the scope in which we call the method. This will cause an performance improvement comparing to the $apply method, who start from the $rootScope | | ||
| | window-service | Instead of the default window object, you should prefer the AngularJS wrapper service $window. [Y180](https://github.com/johnpapa/angular-styleguide#style-y180) | | ||
| # Need your help | ||
| ## Need your help | ||
| It is an opensource project. Any help will be very useful. You can : | ||
@@ -137,9 +225,12 @@ - Create issue | ||
| ## How to create a new rule | ||
| Here are the things you should do before sending a Pull Request with a new Rule : | ||
| * Create a JavaScript file for the new rule in the rules directory (the name of the file should be prefixed by 'ng' for Angular 1 rules, or 'ng2' for Angular 2 rules) | ||
| * Create an unit test for this rule in the test directory (with the same name) | ||
| * Update the main index.js file, in order to add the new rule in the 'rules' property, and set the default configuration in the rulesConfig property | ||
| * Update the "Rules" part of the README.md file with a small description of the rule and its default configuration. | ||
| - Create a JavaScript file for the new rule in the rules directory (the name of the file should be prefixed by 'ng' for Angular 1 rules, or 'ng2' for Angular 2 rules) | ||
| - Create an unit test for this rule in the test directory (with the same name) | ||
| - Update the main index.js file, in order to add the new rule in the 'rules' property, and set the default configuration in the rulesConfig property | ||
| - Update the "Rules" part of the README.md file with a small description of the rule and its default configuration. | ||
@@ -179,4 +270,6 @@ We can use a property, defined in the ESLint configuration file, in order to know which version is used : Angular 1 or Angular 2. based on this property, you can create rules for each version. | ||
| ## Default ESLint Configuration file | ||
| ## Default ESLint configuration file | ||
| Here is the basic configuration for the rules defined in the ESLint plugin, in order to be compatible with the guideline provided by @johnpapa : | ||
@@ -192,3 +285,6 @@ | ||
| ## Who uses it ? | ||
| ## Who uses it? | ||
| - [argo](https://github.com/albertosantini/argo) | ||
@@ -198,2 +294,4 @@ - [generator-gillespie59-angular](https://github.com/Gillespie59/generator-gillespie59-angular/) | ||
| ## Team | ||
@@ -200,0 +298,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.64%
187091
- Number of lines in readme file
- increased by50%
294
No dependency changes