This is a comprehensive ESLint configuration used by .NFQ. It includes a wide range of rules for JavaScript, TypeScript, React, and more.
To setup the project locally follow the next steps:
To install the package run
npm install <Project name>if you are on yarn
yarn add <Project name>or on pnpm
pnpm install <Project name>The following PeerDependencies are needed so the component does work:
- eslint-import-resolver-alias >= 1
- eslint-plugin-array-func >= 3
- eslint-plugin-better-styled-components >= 1
- eslint-plugin-import >= 2
- eslint-plugin-jsdoc >= 43
- eslint-plugin-jsx-a11y >= 6
- eslint-plugin-no-unsanitized >= 4
- eslint-plugin-node >= 11
- eslint-plugin-perf-standard >= 1
- eslint-plugin-promise >= 6
- eslint-plugin-react >= 7
- eslint-plugin-react-hooks >= 4
- eslint-plugin-react-hooks-ssr >= 0.1.5
- eslint-plugin-redos >= 4
- eslint-plugin-security >= 1
- eslint-plugin-sort-destructure-keys >= 1
After installing the package and its peer dependencies, you can use it in your ESLint configuration file:
{
"extends": [
"@nfq"
]
}This configuration includes a wide range of rules for JavaScript, TypeScript, React, and more. You can find the specific rules in the rules directory.
Christoph Kruppe - [https://github.com/ckruppe] - c.kruppe@nfq.de