Skip to content

emberjs/eslint-plugin-ember-internal

Repository files navigation

eslint-plugin-ember-internal

NPM version

Rules used internally by Ember.js

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-ember-internal:

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

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-ember-internal globally.

Usage

Add ember-internal to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "ember-internal"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "ember-internal/rule-name": 2
    }
}

Rules

🔧 Automatically fixable by the --fix CLI option.

Name                           Description 🔧
no-const-outside-module-scope disallow const from being used outside of the module scope (e.g. in functions) 🔧
no-empty-yuidoc-code-blocks disallow empty code blocks in YUIDoc comments
require-yuidoc-access require that every YUIDoc comment has @public, @protected or @private declared
require-yuidoc-code-block-type require that every code blocks in YUIDoc comments has a type associated

Related

License

eslint-plugin-ember-internal is licensed under the MIT License.