ember-cli-eslint

ESLint for Ember CLI apps and addons

Installation

ESLint 4 (for Node 4 and above):

ember install ember-cli-eslint@4

ESLint 3 (for Node 4 and above):

ember install ember-cli-eslint@3

ESLint 2 (for Node 0.10 and above):

ember install ember-cli-eslint@2

After installation, an .eslintrc.js file will be placed in both the root ofyour project and the /tests directory.

Furthermore, a .eslintignore file can be used to exclude files fromlinting while the linter is running. Its syntax is identical to.gitignore files.

Disabling JSHint

Congratulations! You've made the leap into the next generation of JavaScriptlinting. At the moment, however, ember-cli defaults to generatingapplications and addons with a jshint configuration.

module.exports = function(defaults) {
  const app = new EmberApp(defaults, {
    'ember-cli-qunit': {
      useLintTree: false
    }
  });
};

module.exports = function(defaults) {
  const app = new EmberApp(defaults, {
    'ember-cli-mocha': {
      useLintTree: false
    }
  });
};

const isTesting = process.env.EMBER_ENV === 'test';

module.exports = function(defaults) {
  const app = new EmberApp(defaults, {
    hinting: !isTesting,
  });
};

Usage

ESLint will be run by ember-cli-qunit or ember-cli-mocha automaticallywhen you run ember test. If ESLint is not being run automatically, tryupdating your ember-cli and/or ember-cli-qunit/ember-cli-mochadependencies.

Configuration

ember-cli-eslint can be configured through the eslint key in yourember-cli-build.js file:

let app = new EmberApp(defaults, {
  eslint: {
    testGenerator: 'qunit',
    group: true,
    rulesDir: 'eslint-rules',
    extensions: ['js'],
  }
});

• testGenerator is automatically detected if ember-qunit/ember-cli-qunitor ember-mocha/ember-cli-mocha are used, but can also be set to qunitand mocha manually.

• group can be set to false to go back to the previous behavior whereevery generated test was contained in its own separate module.

• rulesDir is the name of the directory for your custom eslint rules.It defaults to eslint-rules.

• extensions is an array containing the file extensions to lint. If you want to lint JavaScript and TypeScript files for example it should be set to ['js', 'ts']. NOTE: If you add Typescript files @typescript/eslint-parser has to be installed and specified as the parser. For more information take a look at the @typescript/eslint-parser

On Build Files

Please note that if you are using this to lint files which are part of the buildprocess (ie. index.js, ember-cli-build.js, config/), whether in an application oras part of an addon, they will not be linted. It is recommended that eslint issetup separately to lint these files and can be setup as an npm script and run aspart of a CI process.

Contributing

Installation

• git clone this repository
• cd ember-cli-eslint
• npm install
• bower install

Running

• ember server
• Visit your app at http://localhost:4200.

Running Tests

• npm test (Runs ember try:testall to test your addon against multiple Ember versions)
• ember test
• ember test --server
• ember try:each

Linting

• npm run lint:hbs
• npm run lint:js
• npm run lint:js -- --fix

Running the dummy application

• ember serve
• Visit the dummy application at http://localhost:4200.

For more information on using ember-cli, visit https://ember-cli.com/.

License

This project is licensed under the MIT License.