eslint-plugin-ember-suave

2.0.1 verified Sat Apr 25 auth: no javascript maintenance

DockYard's ESLint plugin for Ember apps, providing custom linting rules and a recommended configuration based on their styleguide. Version 2.0.1 is the latest stable release; the plugin is in maintenance mode with no recent updates. It is intended for use with Ember CLI projects via ember-cli-eslint or standalone ESLint. Key differentiators: tailored specifically for Ember.js conventions and DockYard's engineering practices. Supports Node >=8.0.0 and is published as an npm package.

Common errors

error ESLint couldn't find the plugin "eslint-plugin-ember-suave" ↓

cause Plugin not installed or not in node_modules.

fix

Run npm install --save-dev eslint-plugin-ember-suave in your project.

error Definition for rule 'ember-suave/no-const-outside-module-scope' was not found ↓

cause Rule name missing 'ember-suave/' prefix or plugin not added to plugins array.

fix

Ensure 'ember-suave' is listed in plugins array and rule is prefixed with 'ember-suave/'.

Warnings

deprecated Plugin contains deprecated rules that may not be updated for latest Ember/ESLint versions. ↓

fix Review rules and consider migrating to eslint-plugin-ember for better maintenance.

gotcha Common mistake: omitting 'ember-suave/' prefix on rule names leads to 'Definition for rule was not found' error. ↓

fix Always prefix custom rules with 'ember-suave/', e.g., 'ember-suave/no-const-outside-module-scope'.

gotcha Plugin requires Node >=8.0.0; using older Node versions causes install/runtime errors. ↓

fix Update Node.js to version 8 or higher.

deprecated Plugin is in maintenance mode; no new updates expected. ↓

fix Consider using eslint-plugin-ember as a more actively maintained alternative.

Install

npm install eslint-plugin-ember-suave

yarn add eslint-plugin-ember-suave

pnpm add eslint-plugin-ember-suave

Imports

plugin:ember-suave/recommended
wrong
```
require('eslint-plugin-ember-suave').configs.recommended
```
correct
```
extends: ['plugin:ember-suave/recommended']
```
Used in .eslintrc.js as an ESLint config extension, not a direct import.
ember-suave/no-const-outside-module-scope
wrong
```
rules: { 'no-const-outside-module-scope': 'error' }
```
correct
```
rules: { 'ember-suave/no-const-outside-module-scope': 'error' }
```
Rules must be prefixed with 'ember-suave/' to avoid collision with core ESLint rules.
eslint-plugin-ember-suave (package)
wrong
```
npm install --save eslint-plugin-ember-suave
```
correct
```
npm install --save-dev eslint-plugin-ember-suave
```
Install as a devDependency since it's a build-time tool.

Quickstart

Configures ESLint to use the ember-suave plugin with its recommended rules, demonstrating plugin and rules setup.

// .eslintrc.js
module.exports = {
  plugins: ['ember', 'ember-suave'],
  extends: ['eslint:recommended', 'plugin:ember-suave/recommended'],
  rules: {
    'quotes': ['error', 'single'],
    'ember-suave/no-const-outside-module-scope': 'off'
  }
};