eslint-config-deepcrawl
v13.9.0
Published
ESLint rules recommended by DeepCrawl.
Downloads
5,626
Readme
eslint-config
ESLint rules used by DeepCrawl.
Installation
Add eslint-config-deepcrawl
and its peer dependencies to your package.json
:
yarn add --dev \
eslint-config-deepcrawl \
eslint@^8.57.0
Usage
Update your .eslintrc
configuration:
{
"extends": ["deepcrawl"]
}
If you are using tsconfig paths, you also need to let eslint-plugin-import
know, which imports should it consider internal, for example:
{
"settings": {
"import/internal-regex": "^@(src|test)/"
}
}
Recommendations
TypeScript
Have these options enabled in your tsconfig.json
file:
{
"compilerOptions": {
"noImplicitAny": true,
"strictPropertyInitialization": true
}
}
or enable @typescript-eslint/typedef
rule.
Prettier
Apart from ESLint, it is recommended to use the following Prettier configuration:
{
"arrowParens": "avoid",
"bracketSpacing": true,
"endOfLine": "lf",
"printWidth": 120,
"quoteProps": "as-needed",
"semi": true,
"singleQuote": false,
"tabWidth": 2,
"trailingComma": "all",
"useTabs": false
}
with lint-staged
pre-commit hook done via husky
.