ESLint and Prettier configs by iJS
A set of awesome ESLint + Prettier configs.
Makes it easier to work with React, NextJS, GraphQL, Node apps.
This package is intended for use with VS Code, however, can be easily used with any text editor just as well.
Installation
Local / Per Project
- Install eslint-config-ijs:
npx install-peerdeps --dev eslint-config-ijs
- Create an
.eslintrc
file in the root of your project's directory. Paste in the following:
{
"extends": ["ijs"]
}
-
You're done!
-
Now you can manually lint your code by running npm run lint
and fix all fixable issues with npm run lint:fix
. You probably want your editor to do this though.
Global Install
You can avoid the need to do the previous step for each project and install this globally.
- Install eslint-config-ijs:
npx install-peerdeps --dev eslint-config-ijs
- Create a global
.eslintrc
file on your computer:
- MacOS location:
~/.eslintrc
- Windows location:
C:\Users\you\.eslintrc
Paste in the follow to newly created .eslintrc
:
{
"extends": ["ijs"]
}
VS Code setup
- Install ESLint extension
- In VS Code go to settings (
⌘Cmd + ,
or Ctrl + ,
) → type in settings.json
file → click on Edit in settings.json
and paste in the following on the root of the object:
"editor.formatOnSave": true,
"[javascript]": {
"editor.formatOnSave": false
},
"[javascriptreact]": {
"editor.formatOnSave": false
},
"eslint.autoFixOnSave": true,
"prettier.disableLanguages": ["javascript", "javascriptreact"],
For other editors, you can add the following to your package.json
and run it manually:
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
},
That's all!
Enjoy the package and feel free to contribute! Pull request or suggestions are most welcome!
iJS.to
Credits/Inspirations
https://github.com/Shopify/eslint-plugin-shopify
https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb
https://github.com/dustinspecker/awesome-eslint
https://github.com/wesbos/eslint-config-wesbos