eslint-plugin-ember
Advanced tools
eslint-plugin-ember is an ESLint plugin that provides linting rules specific to Ember.js applications. It helps developers follow best practices and maintain consistency in their Ember.js codebase.
Best Practices
This rule enforces the best practice of avoiding the use of observers in Ember.js applications. Observers can lead to unpredictable behavior and are generally discouraged.
module.exports = {
rules: {
'ember/no-observers': 'error'
}
};Stylistic Issues
This rule ensures that developers use Ember's `get` and `set` methods for property access and assignment, which is a stylistic convention in Ember.js.
module.exports = {
rules: {
'ember/use-ember-get-and-set': 'error'
}
};Ember-Specific Rules
This rule disallows the use of jQuery in Ember.js applications, encouraging developers to use native DOM APIs or Ember's own abstractions.
module.exports = {
rules: {
'ember/no-jquery': 'error'
}
};eslint-plugin-react provides linting rules for React applications. It helps enforce best practices and coding standards specific to React, similar to how eslint-plugin-ember does for Ember.js.
eslint-plugin-vue offers linting rules for Vue.js applications. It ensures that Vue.js code adheres to best practices and stylistic conventions, much like eslint-plugin-ember does for Ember.js.
eslint-plugin-angular provides linting rules for Angular applications. It helps maintain code quality and consistency in Angular projects, similar to the role of eslint-plugin-ember in Ember.js projects.
An ESlint plugin that provides set of rules for Ember Applications based on commonly known good practices.
npm install --save-dev eslint-plugin-ember
.eslintrc.js:// .eslintrc.js
module.exports = {
plugins: [
'ember'
],
extends: [
'eslint:recommended',
'plugin:ember/recommended'
],
rules: {
// override rules' settings here
}
}
Possible configurations:
If you don't want to use predefined settings, you can use it as a plain plugin and choose which rules you'd like to use by yourself like this:
module.exports = {
plugins: [
'ember'
],
extends: [
'eslint:recommended'
],
rules: {
// add rules' settings here, eg.:
'ember/local-modules': 2
}
}
All rules from this plugin have to be prefixed with ember/
Rules are grouped by category to help you understand their purpose.
All rules below with a check mark :white_check_mark: are enabled by default while using plugin:ember/base or plugin:ember/recommended configs.
The --fix option on the command line automatically fixes problems reported by rules which have a wrench :wrench: below.
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | alias-model-in-controller | Enforces aliasing model in controller |
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | avoid-leaking-state-in-components | Avoids state leakage |
| :white_check_mark: | closure-actions | Enforces usage of closure actions |
| :white_check_mark: | no-attrs-snapshot | Disallow use of attrs snapshot in didReceiveAttrs and didUpdateAttrs |
| :white_check_mark: | no-on-calls-in-components | Prevents usage of on calls in components |
| Rule ID | Description | |
|---|---|---|
| avoid-leaking-state-in-ember-objects | Avoids state leakage |
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | jquery-ember-run | Prevents usage of jQuery without Ember Run Loop |
| local-modules | Enforces usage of local modules | |
| :white_check_mark: | named-functions-in-promises | Enforces usage of named functions in promises |
| new-module-imports | Use "New Module Imports" from Ember RFC #176 | |
| no-attrs-in-components | Disallow usage of this.attrs in components | |
| no-duplicate-dependent-keys | Disallow repeating dependent keys | |
| :white_check_mark: | no-function-prototype-extensions | Prevents usage of Ember's function prototype extensions |
| no-global-jquery | Prevents usage of global jQuery object | |
| :white_check_mark: | no-observers | Prevents usage of observers |
| :wrench: | no-old-shims | Prevents usage of old shims for modules |
| :white_check_mark: | no-side-effects | Warns about unexpected side effects in computed properties |
| require-super-in-init | Enforces super calls in init hooks | |
| :white_check_mark: | use-brace-expansion | Enforces usage of brace expansion |
| :white_check_mark::wrench: | use-ember-get-and-set | Enforces usage of Ember.get and Ember.set |
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | no-capital-letters-in-routes | Raise an error when there is a route with uppercased letters in router.js |
| :white_check_mark: | routes-segments-snake-case | Enforces usage of snake_cased dynamic segments in routes |
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | no-empty-attrs | Prevents usage of empty attributes in ember data models |
| Rule ID | Description | |
|---|---|---|
| no-jquery | Disallow any usage of jQuery |
| Rule ID | Description | |
|---|---|---|
| :white_check_mark: | order-in-components | Enforces proper order of properties in components |
| :white_check_mark: | order-in-controllers | Enforces proper order of properties in controllers |
| :white_check_mark: | order-in-models | Enforces proper order of properties in models |
| :white_check_mark: | order-in-routes | Enforces proper order of properties in routes |
:warning: We're going to remove deprecated rules in the next major release. Please migrate to successor/new rules.
| Rule ID | Replaced by |
|---|---|
| avoid-leaking-state-in-components | avoid-leaking-state-in-ember-objects |
| local-modules | new-module-imports |
For the simplified list of rules, go here.
In order to add a new rule, you should:
yarn startdocs fileyarn run update in order to update readme and recommended configurationPlease be aware that we're using yarn in this repository, so if you plan to add some dependencies - make sure you commit yarn.lock file too.
If you have any suggestions, ideas or problems feel free to add new issue, but first please make sure your question does not repeat previous ones.
eslint-plugin-ember package nameSee the LICENSE file for license rights and limitations (MIT).
v4.6.2 (2017-11-15)
order-in-* rules by default. (@Turbo87)ignoreThisExpressions. (@JoelWAnna)avoid-leaking-state-in-components rule. (@Turbo87)FAQs
ESLint plugin for Ember.js apps
The npm package eslint-plugin-ember receives a total of 89,230 weekly downloads. As such, eslint-plugin-ember popularity was classified as popular.
We found that eslint-plugin-ember demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."