eslint-plugin-ember-best-practices

Ember Best Practices

This adds more guard rails for Ember. Just because something "works" does not mean it is correct or in line with the framework's programming model. These footguns include:

• Not adhering to Data Down Actions Up
• Side-effect programming
• Usage of observers
• Usage of attrs.*
• Computed properties without dependent keys

Why

As we've scaled out to over hundreds developers and thousands of lines of code it has become clear that more "development time" guidance is required. While the guides do a good job about getting started, it's good to have some friction to make sure the app code is aligned with how Ember works.

Using the plugin with Ember CLI

Installation

Install the plugin as a dev dependency in your Ember CLI project.

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

This will make the plugin available to ESLint.

Next, install the ember-cli-eslint addon so that your app can be linted during development and testing. This will also uninstall ember-cli-jshint since there is no need to have both linters running at the same time.

ember install ember-cli-eslint

Configuration

The ember-cli-eslint addon blueprint generates a .eslintrc.js configuration file at the root of the project.

Add the plugin's recommended configuration to the list of extensions:

// .eslintrc.js

module.exports = {
  // ...
  extends: [
    'eslint:recommended',
    'plugin:ember-best-practices/recommended'
  ],
  rules: {
  }
};

Changelog

v1.1.2 (2019-06-26)

:bug: Bug Fix

• #104 Ensure require-dependent-keys works with @computed. (@rwjblue)

:memo: Documentation

• #98 Update require-dependent-keys.md (@jrowlingson)
• #102 Add bad example to no-attrs-snapshot.md (@steventsao)
• #101 fix typo (@efx)

:house: Internal

• #96 Bump to latest Eslint (@nlfurniss)

Committers: 5

• Eli Flanagan (@efx)
• Jack Rowlingson (@jrowlingson)
• Nathaniel Furniss (@nlfurniss)
• Robert Jackson (@rwjblue)
• Steven Tsao (@steventsao)

1.1.1 / 2017-11-13

• Fix issues when running under eslint@4 (fixes Cannot read property 'getFilename' of undefined).

1.1.0 / 2017-10-03

• Fixes issues with imports (#91)
• Fixes require-ember-lifeline rule to scope it to only ember file types (#93)
• Merge pull request #89 from nlfurniss/dry-parserOptions

1.0.0 / 2017-09-13

• Fix no-anonymous-once not recognizing context function
• Fix no-global-jquery returning false positive for var assignment #85
• Fix logic to detect jQuery being assigned to a var
• Create no-jquery-selector rule

0.9.0 / 2017-08-31

• Fixing rule no-jquery-methods to remove reference to Ember
• Add tests for rule no-jquery-methods
• Update docs and rule no-jquery-methods to include checks for CallExpressions
• Adding new rule: no-anonymous-once

0.8.0 / 2017-08-15

• Add test for rule no-side-effect-cp
• Fix imports util
• Update guide for no-jquery-method
• Update default BLACKLIST from config no-jquery
• Fix RELEASE.md

0.7.1 / 2017-06-27

• Fixing issue #47 "const { $ } = Ember; still triggers no-global-jquery"

0.7.0 / 2017-06-27

• Adding new rule: require-ember-lifeline

0.6.1 / 2017-06-23

• Fixing no-global-jquery to include references to jQuery

0.6.0 / 2017-06-22

• Add rule against using specific deprecated jQuery Methods (Blacklisted) (#59)
• Fix typo

0.5.1 / 2017-05-22

• Fix repository URL
• Setup coveralls integration
• Add badges to README
• Add RELEASE.md to document release process

0.5.0 / 2017-05-01

• Implements rule to catch sendAction calls
• Clean up text, scope initOverride
• Add new rule: no-broken-super-chain
• Fix typo: mutliple -> multiple
• Fix typo: incuring -> incurring
• Fix typo: recieve -> receive
• Update README.md
• Add a message explaining how to fix computed properties with no dependent keys.
• infromation => information
• Update package.json; set repository field for npm
• Fix incorrect installation instruction