emberjs/eslint-plugin-ember-internal

Name: eslint-plugin-ember-internal

Owner: Ember.js

Description: ESLint rules used internally by Ember.js

Created: 2016-05-25 14:22:04.0

Updated: 2017-12-17 07:46:39.0

Pushed: 2018-02-23 20:45:41.0

Homepage:

Size: 13

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

eslint-plugin-ember-internal

Rules used internally by Ember.js

Installation

You'll first need to install ESLint:

m i eslint --save-dev

Next, install eslint-plugin-ember-internal:

m 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
}

Supported Rules

• require-yuidoc-access - Ensures that every YUIDoc comment has @public, @protected or @private declared

• no-const-outside-module-scope - Prevent const from being used outside of the module scope (e.g. in functions)

• no-empty-yuidoc-code-blocks - Prevents empty code blocks in YUIDoc comments, e.g.

  
  ee code below:
  
  ``js
  ``
  
  

• require-yuidoc-code-block-type - Ensures that every code blocks in YUIDoc comments has a type associated, e.g.

  
  ee code below:
  
  ``js
  ood
  ``
  
  ``
  ad
  ``
  
  

License

eslint-plugin-chai-expect is licensed under the MIT License.