https://github.com/emberjs/eslint-plugin-ember-internal
ESLint rules used internally by Ember.js
https://github.com/emberjs/eslint-plugin-ember-internal
Last synced: 9 months ago
JSON representation
ESLint rules used internally by Ember.js
- Host: GitHub
- URL: https://github.com/emberjs/eslint-plugin-ember-internal
- Owner: emberjs
- License: mit
- Created: 2016-05-25T14:22:04.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T09:15:36.000Z (over 3 years ago)
- Last Synced: 2024-10-29T14:54:26.953Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 874 KB
- Stars: 2
- Watchers: 12
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-ember-internal
[](https://npmjs.org/package/eslint-plugin-ember-internal)
Rules used internally by Ember.js
## Installation
You'll first need to install [ESLint](http://eslint.org):
```sh
npm i eslint --save-dev
```
Next, install `eslint-plugin-ember-internal`:
```sh
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:
```json
{
"plugins": [
"ember-internal"
]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"ember-internal/rule-name": 2
}
}
```
## Rules
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
| Name                          | Description | 🔧 |
| :----------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :- |
| [no-const-outside-module-scope](docs/rules/no-const-outside-module-scope.md) | disallow `const` from being used outside of the module scope (e.g. in functions) | 🔧 |
| [no-empty-yuidoc-code-blocks](docs/rules/no-empty-yuidoc-code-blocks.md) | disallow empty code blocks in YUIDoc comments | |
| [require-yuidoc-access](docs/rules/require-yuidoc-access.md) | require that every YUIDoc comment has `@public`, `@protected` or `@private` declared | |
| [require-yuidoc-code-block-type](docs/rules/require-yuidoc-code-block-type.md) | require that every code blocks in YUIDoc comments has a type associated | |
## Related
- [eslint-plugin-ember](https://github.com/ember-cli/eslint-plugin-ember) - public ESLint rules for Ember.js
## License
eslint-plugin-ember-internal is licensed under the [MIT License](LICENSE).