ESlint plugin that provides set of rules for Ember Applications based on Netguru's Ember Styleguide.
It's made to help you keep good practices mentioned in our Ember Styleguide.
You need to have ember-cli-eslint
installed in your app. More info here.
The easiest way to use this plugin is through our shareable config. More about shareable configs here.
(
export PKG=eslint-config-netguru-ember;
npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"
)
This command will basically produce and call something like this:
npm install --save-dev eslint-config-netguru-ember eslint-plugin-netguru-ember@1.x eslint-config-airbnb-base@^7.1.0 eslint-plugin-import@^1.15.0
extends: netguru-ember
npm install --save-dev eslint-plugin-netguru-ember
plugins:
- netguru-ember
rules:
- netguru-ember/local-modules: 1
All rules from our plugin have to be prefixed with netguru-ember/
-
General
- local-modules - Create local version of Ember.* and DS.* (more)
- no-observers - Don't use observers (more)
- no-side-effect - Don't introduce side-effects in computed properties (more)
- jquery-ember-run - Don’t use jQuery without Ember Run Loop (more)
- named-functions-in-promises - Use named functions defined on objects to handle promises (more)
- no-function-prototype-extensions - Don't use Ember's function prototype extensions (more)
- use-ember-get-and-set - Use Ember get/set (more)
- use-brace-expansion - Use brace expansion (more)
-
Organizing
-
Controllers
-
Ember Data
- no-empty-attrs - Be explicit with Ember data attribute types (more)
-
Components
-
closure-actions - Always use closure actions (more)
-
no-on-calls-in-components - Don't use .on() in components (more)
-
* avoid-leaking-state-in-components - Don't use objects and arrays as default properties (more)
Example config:
netguru-ember/avoid-leaking-state-in-components: [1, ['array', 'of', 'ignored', 'properties']]
-
-
Routing
- routes-segments-snake-case - Route's dynamic segments should use snake case (more)
* Rule with optional settings
TBD. For now feel free to add any suggestions in issues. Any involvement highly appreciated.