eslint-plugin-angular

This repository will give access to new rules for the ESLint tool. You should use it only if you are developing an AngularJS application.

Since the 0.0.4 release, some rules defined in John Papa's Guideline have been implemented. In the description below, you will have a link to the corresponding part of the guideline, in order to have more information.

Usage

1. Install eslint as a dev-dependency:

   npm install --save-dev eslint
   

2. Install eslint-plugin-angular as a dev-dependency:

   npm install --save-dev eslint-plugin-angular
   

3. Enable the plugin by adding it to your .eslintrc:

   plugins:
     - angular
   

4. You can also configure these rules in your .eslintrc. All rules defined in this plugin have to be prefixed by 'angular/'

   plugins:
     - angular
   rules:
     - angular/ng_controller_name: 0
   

We provide also three samples :

• demo/npm (launch: npm run lint)
• demo/grunt (launch: grunt)
• demo/gulp (launch: gulp)

Rules

Name and Default	Description
'ng_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.
'ng_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. The second parameter can be a Regexp for identifying controller functions (when using something like Browserify)
'ng_controller_as_route': 2	You should use Angular's controllerAs syntax when defining routes or states. Implements route part Y031
'ng_controller_as_vm': [2, 'vm']	You should use a capture variable for 'this' when using the controllerAs syntax. Y031. 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)
'ng_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. ("ng_controller_name": [2, "ng"]) Y123, Y124
'ng_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)
'ng_di': [2, 'function']	All your DI should use the same syntax : the Array or function syntaxes ("ng_di": [2, "function or array"])
'ng_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) ("ng_directive_name": [2, "ng"]) Y073, Y126
'ng_document_service': 2	Instead of the default document object, you should prefer the AngularJS wrapper service $document. Y180
'ng_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
'ng_foreach': 0	You should use the angular.forEach method instead of the default JavaScript implementation [].forEach.
'ng_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. ("ng_filter_name": [2, "ng"])
'ng_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
'ng_interval_service': 2	Instead of the default setInterval function, you should use the AngularJS wrapper service $interval Y181
'ng_json_functions': 2	You should use angular.fromJson or angular.toJson instead of JSON.parse and JSON.stringify
'ng_module_getter':2	When using a module, avoid using a variable and instead use chaining with the getter syntax Y022
'ng_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) ("ng_module_name": [2, "ng"]) Y127
'ng_module_setter':2	Declare modules without a variable using the setter syntax.Y021
'ng_no_digest': 2	The scope's $digest() method shouldn't be used. You should prefer the $apply method.
'ng_no_jquery_angularelement': 2	You should not wrap angular.element object into jQuery(), because angular.element already return jQLite element
'ng_no_private_call': 2	All scope's properties/methods starting with $$ are used internally by AngularJS. You should not use them directly.
'ng_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']})
'ng_no_service_method': 2	You should prefer the factory() method instead of service() Y040
'ng_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
'ng_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) ("ng_service_name": [2, "ng"]) Y125
'ng_timeout_service': 2	Instead of the default setTimeout function, you should use the AngularJS wrapper service $timeout Y181
'ng_typecheck_array': 2	You should use the angular.isArray method instead of the default JavaScript implementation (typeof [] === "[object Array]").
'ng_typecheck_date': 2	You should use the angular.isDate method instead of the default JavaScript implementation (typeof new Date() === "[object Date]").
'ng_typecheck_function': 2	You should use the angular.isFunction method instead of the default JavaScript implementation (typeof function(){} ==="[object Function]").
'ng_typecheck_number': 2	You should use the angular.isNumber method instead of the default JavaScript implementation (typeof 3 === "[object Number]").
'ng_typecheck_object': 2	You should use the angular.isObject method instead of the default JavaScript implementation (typeof {} === "[object Object]").
'ng_typecheck_regexp': 2	You should use the angular.isRegexp method instead of the default JavaScript implementation (toString.call(/^A/) === "[object RegExp]").
'ng_typecheck_string': 2	You should use the angular.isString method instead of the default JavaScript implementation (typeof "" === "[object String]").
'ng_window_service': 2	Instead of the default window object, you should prefer the AngularJS wrapper service $window. Y180

Need your help

It is an opensource project. Any help will be very useful. You can :

• Create issue
• Send Pull Request
• Write Documentation
• Add new Features
• Add new Rules
• Improve the quality
• Reply to issues

All contributions should be pushed in the current GIT branch.

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
• Create an unit test for this rule in the test directory
• 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.

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 :

{
    "rules": {
        "no-use-before-define": 0
    }
}

Who uses it ?

• argo
• generator-gillespie59-angular
• generator-ng-poly

Team

Emmanuel DEMEY