An ESLint plugin that provides a set of rules for Ember applications based on commonly known good practices.

• ESLint >= 6
• Node.js 10.* || 12.* || >= 14

yarn add --dev eslint-plugin-ember

Or

npm install --save-dev eslint-plugin-ember

// .eslintrc.js
module.exports = {
  plugins: ['ember'],
  extends: [
    'eslint:recommended',
    'plugin:ember/recommended' // or other configuration
  ],
  rules: {
    // override rule settings here
    'ember/no-jquery': 'error'
  }
};

Rules are grouped by category to help you understand their purpose. Each rule has emojis denoting:

• What configuration it belongs to
• 🔧 if some problems reported by the rule are automatically fixable by the --fix command line option
• 💡 if some problems reported by the rule are manually fixable by editor suggestions

For the simplified list of rules, go here.

If you have any suggestions, ideas, or problems, feel free to create an issue, but first please make sure your question does not repeat previous ones.

• Create an issue with a description of the proposed rule
• Create files for the new rule:
  • lib/rules/new-rule.js (implementation, see no-proxies for an example)
  • docs/rules/new-rule.md (documentation, start from the template -- raw, rendered)
  • tests/lib/rules/new-rule.js (tests, see no-proxies for an example)
• Run yarn update to automatically update the README and other files (and re-run this if you change the rule name or description)
• Make sure your changes will pass CI by running:
  • yarn test
  • yarn lint (yarn lint:js --fix can fix many errors)
• Create a PR and link the created issue in the description

Note that new rules should not immediately be added to the recommended configuration, as we only consider such breaking changes during major version updates.

See the LICENSE file for license rights and limitations (MIT).