@former03/eslint-config v0.0.3
FORMER03 eslint-config
Configs
There are currently 3 configs available:
- default: for use with all newer projects using ES6+ Javascript features
"extends": ["@former03"]
bzw"extends": ["@former03/eslint-config"]
- legacy: for use with older projects wwhich are in "maintenance mode" and are not actively worked on
"extends": ["@former03/eslint-config/legacy"]
- react: for use with all react projects
"extends": ["@former03/eslint-config/react"]
Installation
This is meant to be installed as an npm module
Make sure the peer dependencies are met. This may mean installing eslint itself as an npm module and any appropriate plugings.
In particular, when using the react config, make sure the react plugin is installed: npm install --save-dev eslint-plugin-react
.
From NPM
npm install --save-dev @former03/eslint-config
Development version
Clone this project, npm link
it and then in appropriate directory npm link @former03/eslint-config
Usage
After installed, a .eslintrc.json
file must be created in the appropriate directory. See the examples in this project or the official documentation.
Command line
./node-modules/.bin/eslint $path/to/code
will find any errors./node-modules/.bin/eslint --fix $path/to/code
will fix all errors it can (these are often stylistic errors like indentation, etc). This is recommened the first time eslint is introduced into an existing project.
IDEs
PHPStorm: File > Settings > Languages & Frameworks > Javascript > Code Quality Tools > ESLint: ✔ Enable