Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eggjs/eslint-plugin-eggache
custom eslint rule for egg, especially for the RTFM issues
https://github.com/eggjs/eslint-plugin-eggache
egg eslint eslint-plugin
Last synced: about 2 months ago
JSON representation
custom eslint rule for egg, especially for the RTFM issues
- Host: GitHub
- URL: https://github.com/eggjs/eslint-plugin-eggache
- Owner: eggjs
- Created: 2018-02-07T06:39:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-29T14:47:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T00:55:36.379Z (5 months ago)
- Topics: egg, eslint, eslint-plugin
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 12
- Watchers: 11
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
# eslint-plugin-eggache
custom eslint rule for egg RTFM questions
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![NPM download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-eggache.svg?style=flat-square
[npm-url]: https://npmjs.org/package/eslint-plugin-eggache
[travis-image]: https://img.shields.io/travis/eggjs/eslint-plugin-eggache.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/eslint-plugin-eggache
[codecov-image]: https://codecov.io/gh/eggjs/eslint-plugin-eggache/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/eggjs/eslint-plugin-eggache
[david-image]: https://img.shields.io/david/eggjs/eslint-plugin-eggache.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/eslint-plugin-eggache
[snyk-image]: https://snyk.io/test/npm/eslint-plugin-eggache/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/eslint-plugin-eggache
[download-image]: https://img.shields.io/npm/dm/eslint-plugin-eggache.svg?style=flat-square
[download-url]: https://npmjs.org/package/eslint-plugin-eggache
## Usage
```bash
npm i eslint-plugin-eggache --save
```
Add `eggache` to the plugins section of your `.eslintrc` configuration file.
```js
// ${app_root}/.eslintrc
{
"extends": [
"plugin:eggache/recommended"
]
}
```
By default it enable all the recommended rules, if you want to custom, just configure the rules section.
```js
// ${app_root}/.eslintrc
{
"extends": [
"plugin:eggache/recommended"
],
"rules": {
'eggache/no-override-exports': [ 'error' ],
'eggache/no-unexpected-plugin-keys': 'error',
}
}
```
## Rules
### no-override-exports
A common mistake that newbie will make - override `module.exports` and `exports`.
```js
/* eslint eggache/no-override-exports: [ 'error' ] */
// config/config.default.js
exports.view = {};
module.exports = appInfo => {
const config = exports = {};
config.keys = '123456';
return config;
}
```
**Options**:
The first options is a boolean, default to false, means only check:
- `config/config.*.js`
- `config/plugin.*.js`
set it to `true` means to check all files.
```js
/* eslint eggache/no-override-exports: [ 'error', true ] */
// due to options `true`, this will pass the lint
// ${app_root}/app.js
module.exports = exports = {};
exports.keys = '123456';
```
### no-unexpected-plugin-keys
Sometimes, developer will confuse `plugin.js` and `config.default.js`.
`plugin.js` only allow `[ 'enable', 'package', 'path', 'env' ]` and it control whether to load a plugin.
The plugin's `config` should write to `config/config.{env}.js`.
```js
/* eslint eggache/no-unexpected-plugin-keys: [ 'error' ] */
// config/plugin.js
module.exports = {
test: {
enable: true,
package: 'egg-test',
someConfig: 'should not place here',
},
}
```
### no-only-tests
A common mistake that developer will make - forget to remove `.only` in tests before committing.
```js
/* eslint eggache/no-only-tests: [ 'error' ] */
describe.only('desc something', function() {
it.only('assert somnething', function() {
// do nothing
});
})
```