ember-cliember-cli-eslint
ESLint for Ember CLI apps and addons
Installation
ESLint 4 (for Node 4 and above):
ember install ember-cli-eslint@4ESLint 3 (for Node 4 and above):
ember install ember-cli-eslint@3ESLint 2 (for Node 0.10 and above):
ember install ember-cli-eslint@2After installation, an .eslintrc.js file will be placed in both the root of
your project and the /tests directory.
Furthermore, a .eslintignore file can be used to exclude files from
linting 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 JavaScript
linting. At the moment, however, ember-cli defaults to generating
applications and addons with a jshint configuration.
ember-cli >= 2.5.0
As of ember-cli v.2.5.0,
jshint is provided through its own ember-cli-jshint addon.
Running npm uninstall --save-dev ember-cli-jshint, in addition to removing
any .jshintrc files from your project should guarantee that its behavior
is disabled.
ember-cli < 2.5.0
Controlling linting is a bit trickier on versions of ember-cli prior to
2.5.0. Within your ember-cli-build.js file, ember-cli-qunit or
ember-cli-mocha can be configured to have their default linting process
disabled during:
module.exports = function(defaults) {
const app = new EmberApp(defaults, {
'ember-cli-qunit': {
useLintTree: false
}
});
};or
module.exports = function(defaults) {
const app = new EmberApp(defaults, {
'ember-cli-mocha': {
useLintTree: false
}
});
};Alongside this setting, the hinting property can then be used to
enable/disable globally:
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 automatically
when you run ember test. If ESLint is not being run automatically, try
updating your ember-cli and/or ember-cli-qunit/ember-cli-mocha
dependencies.
Configuration
ember-cli-eslint can be configured through the eslint key in your
ember-cli-build.js file:
let app = new EmberApp(defaults, {
eslint: {
testGenerator: 'qunit',
group: true,
rulesDir: 'eslint-rules',
extensions: ['js'],
}
});testGeneratoris automatically detected ifember-qunit/ember-cli-qunitorember-mocha/ember-cli-mochaare used, but can also be set toqunitandmochamanually.groupcan be set tofalseto go back to the previous behavior where every generated test was contained in its own separate module.rulesDiris the name of the directory for your custom eslint rules. It defaults toeslint-rules.extensionsis 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 filestypescript-eslint-parserhas to be installed and specified as the parser. For more information take a look at thetypescript-eslint-parser
On Build Files
Please note that if you are using this to lint files which are part of the build
process (ie. index.js, ember-cli-build.js, config/), whether in an application or
as part of an addon, they will not be linted. It is recommended that eslint is
setup separately to lint these files and can be setup as an npm script and run as
part of a CI process.
Contributing
Installation
git clonethis repositorycd ember-cli-eslintnpm installbower install
Running
ember server- Visit your app at http://localhost:4200.
Running Tests
npm test(Runsember try:testallto test your addon against multiple Ember versions)ember testember test --serverember try:each
Linting
npm run lint:hbsnpm run lint:jsnpm 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.