@wildpastry/eslint-config
v1.6.5
Published
ESLint configuration file
Downloads
66
Maintainers
Readme
ESLintConfig
Shareable ESLint configuration settings linked with Prettier. ESLint formatting rules are disabled, then re-enabled through the eslint-prettier plugin. This way the formatting rules still get applied and Prettier formatting won't conflict with ESLint linting.
No errors, only warnings.
Prerequisites
- NodeJS and NPM installed
- Project set up with NodeJS and a package.json
- Navigate to the root directory of your project
Installation and usage
Install eslint and prettier core packages
npm i eslint@latest prettier@latest
Install eslint plugins
npm i @typescript-eslint/eslint-plugin@latest eslint-plugin-react@latest eslint-plugin-prettier@latest
Install @wildpastry custom eslint config
npm i @wildpastry/eslint-config@latest
Create new .eslintrc file in the project source
.eslintrc
Add config to .eslintrc and save
{ "extends": "@wildpastry/eslint-config" }
Add these optional scripts to package.json inside "scripts": { ... }
These scripts will check/fix linting and formatting. Not everything can be automatically fixed.
"lint": "eslint \"**/*.{js,jsx,ts,tsx}\"",
"lint:fix": "eslint --fix \"**/*.{js,jsx,ts,tsx}\"",
"format": "npx prettier --check \"**/*.{js,jsx,ts,tsx}\"",
"format:fix": "npx prettier --write \"**/*.{js,jsx,ts,tsx}\"",
"clean": "npx prettier --write \"**/*.{js,jsx,ts,tsx}\" && npm run lint:fix"