Installing
Local / Per Project Install
-
If you don't already have a
package.json
file, create one withnpm init
. -
Then we need to install everything needed by the config:
npx install-peerdeps --dev eslint-config-cyf
-
You can see in your package.json there are now a big list of devDependencies.
-
Create a
.eslintrc
file in the root of your project's directory (it should live where package.json does). Your.eslintrc
file should look like this:
Tip: You can alternatively put this object in your package.json
under the property "eslintConfig":
. This makes one less file in your project.
- You can add two scripts to your package.json to lint and/or fix:
"scripts": ,
- Now you can manually lint your code by running
npm run lint
and fix all fixable issues withnpm run lint:fix
. You probably want your editor to do this though.
Global Install
- First install everything needed:
npx install-peerdeps --global eslint-config-cyf
(note: npx is not a spelling mistake of npm. npx
comes with when node
and npm
are installed and makes script running easier)
- Then you need to make a global
.eslintrc
file:
ESLint will look for one in your home directory
~/.eslintrc
for macC:\Users\username\.eslintrc
for windows
In your .eslintrc
file, it should look like this:
- To use from the CLI, you can now run
eslint .
or configure your editor as we show next.
Settings
If you'd like to overwrite eslint or prettier settings, you can add the rules in your .eslintrc
file. The ESLint rules go directly under "rules"
while prettier options go under "prettier/prettier"
. Note that prettier rules overwrite anything in my config (trailing comma, and single quote), so you'll need to include those as well.
"extends": "cyf" "rules": "no-console": 2 "prettier/prettier": "error" "trailingComma": "es5" "singleQuote": true "printWidth": 120 "tabWidth": 8