eslint.md

ESLint

Running ESLint in your editor

When you run gulp watch, gulp build or any build or test related task, you'll notice that ESLint checks are run. This comes in very handy and contributes to your code quality and consistency. However it would be much easier to not even let those errors occur in the first place.

This guide explains how you set up your editor to perform ESLint checks in your editor as you code.

Here are the installation instructions for the most popular editors based on the Angular 2 survey:

• Sublime - https://github.com/roadhump/SublimeLinter-eslint
• Atom - https://atom.io/packages/linter-eslint
• Webstorm - https://www.jetbrains.com/webstorm/help/using-javascript-code-quality-tools.html#d228115e577

HINTS:

• Generator-M-Ionic provides a local version of ESLint for you. So you don't need to install the eslint package (neither globally nor locally).
• For Atom and Sublime both plugins require to have a parent linting plugin installed.
• It may be necessary that you disable any other style-checking plugin like jscs or jshint while working with ESLint.

Configuring ESLint to suit your needs

You may not be happy with some of the choices we made regarding code styles and linting. If that's the case, you are free to make any changes to the .eslintrc files throughout your project. These are found in the following locations and are valid for the files in the directory and all sub-directories:

.eslintrc         # ESLint base configuration, extends 'recommended'
.eslintignore     # tell ESLint which files to ignore
app/
  └── .eslintrc   # app specific configuration, extends .eslintrc
test/karma/
  └── .eslintrc   # karma specific configuration, extends app/.eslintrc
test/protractor/
  └── .eslintrc   # protractor specific configuration, extends app/.eslintrc

Here are some good places to start figuring out your own configuration:

• All the rules that are built-in and ship with ESLint - http://eslint.org/docs/rules/
• Configuring ESLint - http://eslint.org/docs/user-guide/configuring.html
  • Environments (like browser, node, ...)
  • Globals if environments don't suffice
  • Rules, how they are configured.
  • Extending other configuration files