@hopara/eslint-config
v2.0.4
Published
Hopara's ESLint config
Downloads
1,802
Maintainers
Readme
@hopara/eslint-config
This package provides Hopara's .eslintrc as an extensible shared config.
Usage
Our default export contains all of our ESLint rules. It requires:
eslint
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
eslint-config-google"
eslint-plugin-import
eslint-plugin-jsx-a11y
eslint-plugin-react
eslint-plugin-react-hooks
- Install the correct versions of each package, which are listed by the command:
npx install-peerdeps --dev git+ssh://[email protected]:kyrix/eslint-config
- Extends your .eslintrc with:
- If your project does not use React:
"extends": "@hopara/eslint-config"
- If your project uses React:
"extends": "@hopara/eslint-config/react"
Improving this config
Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?
You can run tests with npm test
.
You can make sure this module lints with itself using npm run lint
.