eslint-config-nugit
This package provides Nugit's JS .eslintrc as an extensible shared config.
Installation
-
Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-nugit@latest" peerDependencies
If using npm 5+, use this shortcut
npx install-peerdeps --dev eslint-config-nugit
If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. Otherwise, run
npm info "eslint-config-nugit@latest" peerDependencies
to list the peer dependencies and versions, then runyarn add --dev <dependency>@<version>
for each listed peer dependency.
Usage
We export two ESLint configurations for your usage.
eslint-config-nugit
Our default export contains all of our ESLint rules, including ECMAScript 6+, FlowJS and React.
It requires eslint
, eslint-plugin-eslint-comments
, eslint-plugin-fb-flow
, eslint-plugin-flowtype
, eslint-plugin-import
, eslint-plugin-jsx-a11y
,eslint-plugin-react
& eslint-plugin-react-hooks
.
If you don't need React, see eslint-config-nugit/base
.
- Add
"extends": "nugit"
to your .eslintrc.
eslint-config-nugit/base
Our default export contains all of our ESLint rules, including ECMAScript 6+ and FlowJS.
It requires eslint
, eslint-plugin-eslint-comments
, eslint-plugin-fb-flow
, eslint-plugin-flowtype
& eslint-plugin-import
.
- Add
"extends": "nugit/base"
to your .eslintrc
eslint-config-nugit/script
Same as eslint-config-nugit/base
but allow to use devDependencies
& console.log
.
It requires eslint
, eslint-plugin-eslint-comments
, eslint-plugin-fb-flow
, eslint-plugin-flowtype
& eslint-plugin-import
.
- Add
"extends": "nugit/script"
to your .eslintrc