eslint-config-egg
Node Style Guide for Egg.
Install
npm i eslint eslint-config-egg --save-dev
Usage
package.json
.eslintrc.js
moduleexports = extends: 'eslint-config-egg';
Use with TypeScript project
package.json
.eslintrc.js
moduleexports = extends: 'eslint-config-egg/typescript' parserOptions: // recommend to use another config file like tsconfig.eslint.json and extends tsconfig.json in it. // because you may be need to lint test/**/*.test.ts but no need to emit to js. // @see https://github.com/typescript-eslint/typescript-eslint/issues/890 project: './tsconfig.json' ;
scripts
settings.json
in vscode
Use with Experimental Features
If you want to use eslint-config-egg with experimental features such as async function
, you should use babel-eslint
parser:
package.json
.eslintrc.js
moduleexports = extends: 'eslint-config-egg' // for experimental features support parser: 'babel-eslint' rules: // see https://github.com/eslint/eslint/issues/6274 'generator-star-spacing': 'off' 'babel/generator-star-spacing': 'off' ;
Use with React in Front-End
If you want to use eslint-config-egg with react, jsx and es6 modules:
package.json
.eslintrc.js
moduleexports = extends: 'eslint-config-egg' // for experimental features support parser: 'babel-eslint' parserOptions: // for es6 module sourceType: 'module' plugins: 'react' rules: // for variables in jsx 'react/jsx-uses-vars': 'error' // see https://github.com/eslint/eslint/issues/6274 'generator-star-spacing': 'off' 'babel/generator-star-spacing': 'off' ;
License
Contributors
popomore |
fengmk2 |
atian25 |
benjycui |
geekdada |
dead-horse |
---|---|---|---|---|---|
bowei-jbw |
aladdin-add |
hotoo |
This project follows the git-contributor spec, auto updated at Mon Mar 11 2019 15:51:28 GMT+0800
.