eslint-config-beslogic v1.6.5
Eslint Config Beslogic
Installation and usage
Run npm i --save-dev eslint-config-beslogic eslint-plugin-total-functions
Depending on your needs, you will need to also install other peer dependencies for linting.
In your .eslintrc
file, add "extends": "beslogic/<preset>"
(see all available presets below)
For stylistic rules, it is highly recommended to use a dedicated formatter over ESLint. Read more here: https://typescript-eslint.io/docs/linting/troubleshooting/formatting/\ A dprint preset is offered below.
Parallel configurations
These are configuration files you'll have to update manually to best work with these presets.
package.json
Add the following scripts
and engines
:
"scripts": {
"eslint": "eslint ./ --ignore-path .gitignore",
"lint": "dprint check && npm run eslint",
"lint:fix": "dprint fmt && npm run eslint -- --fix"
},
"// node 16": "14 won't install peer deps properly + prefer EventTarget (only available node 16)",
"engines": {
"node": ">=16",
"npm": ">=8"
}
Base tsconfig.json
Extend the following in your base tsconfig.json
(follow link for more details):
"extends": ["eslint-config-beslogic/tsconfig.5.0.json"],
"extends": "eslint-config-beslogic/tsconfig.4.3.json",
"No Unchecked Indexed Access" makes index accesses even stricter. You may not want it in your project. You can disable it with "compilerOptions": { "noUncheckedIndexedAccess": false }
.
If deploying / bundling with an Angular npm package, also set angularCompilerOptions": { "strictMetadataEmit": true }
.vscode/settings.json
and .vscode/extensions.json
Read and copy from VSCode Settings and Extensions
dprint.json
If using the beslogic/dprint
preset, use the following:
{
// https://dprint.dev/config/#extending-a-different-configuration-file
"extends": "https://raw.githubusercontent.com/BesLogic/beslogic-dprint-configuration/main/dprint.json"
}
If also using beslogic/json-like
preset extend from https://raw.githubusercontent.com/BesLogic/beslogic-dprint-configuration/main/dprint-json-like.json
instead.
Patched packages
The following packages cause problems or have other type-safety issues that are automatically patched out by eslint-config-beslogic
on install. To see the complete logs, add foreground-scripts=true
to a root .npmrc
file, or run npm install
with --foreground-scripts
.
NX/NRWL
NX has a reusable add-linting
generator that adds configuration that hides our own and/or conflicts with our best practices. We automatically patch-out that NX generator.
If you have a project that used NX before also using eslint-config-beslogic@>=1.5.2
, make sure to remove all @nrwl/*
and @angular-eslint/template/process-inline-templates
entries from "extends"
in all eslint configuration files. You can keep entries generated under "rules"
.
NX also doesn't support trailing commas in jsonc files. You'll have to make sure that your configurations contains none (and go upvote the referenced issue!).
Angular Material
Angular Material's MatDialogRef defaults it dialog result generic to any
. This breaks type safety and is automatically patched out since eslint-config-beslogic@1.5.2
.
Presets
Below are all the different configurations you can extend from. You can mix and match as you want if a predefined configuration does not exist for your specific stack. You should import TypeScript configs after regular javascript ones. ie "extends": ["beslogic/node", "beslogic/typescript"]
at the root of the configuration.
beslogic
Default preset, extends from beslogic/javascript
and beslogic/typescript
.
beslogic/jest
Jest and Testing Library configs. Is already extended by beslogic/javascript
and beslogic/typescript
for all *spec.[jt]s
and *.test.[jt]sx
files. You should not need to extend from this configuration unless you want to add it to a test file that is not automatically picked up by the naming convention.
beslogic/javascript
Basic javascript configs, is extended by all other configs except beslogic/typescript
, beslogic/jest
, beslogic/storybook
and beslogic/json-like
.
beslogic/typescript
Basic TypeScript-specific configs and TSX
support, is extended by all other TypeScript exclusive configs. To avoid rules conflicts, it does not already extend from beslogic/javascript
. So you should extend from both in a pure TypeScript project. You may also need to specify parserOptions.project
. ie: "parserOptions": { "project": ["tsconfig.json"] },
and "parser": "@typescript-eslint/parser"
.
For the linting to be fully effective, please make sure that your base tsconfig.json
extends eslint-config-beslogic/tsconfig.X.X.json
(see Parallel configurations).
beslogic/node-js
Configurations for NodeJS backends.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-n
beslogic/rxjs
Configurations for projects using RxJs. Already extends and beslogic/typescript
for TypeScript-specific rules and is already extended by beslogic/angular
.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-rxjs eslint-plugin-total-functions
beslogic/react
Configurations for React projects. Comes with JSX
support.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-redux eslint-plugin-react-prefer-function-component
beslogic/react-native
Configurations for React Native projects, including Expo. Already extends beslogic/react
.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-react-native eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-redux eslint-plugin-react-prefer-function-component
beslogic/react-redux
Configurations for React projects using the Redux bindings. Already extends beslogic/react
.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-react-redux eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-redux eslint-plugin-react-prefer-function-component
beslogic/mui
MUI/material framework configurations. Already extends beslogic/react
and beslogic/typescript
.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-mui eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-redux eslint-plugin-react-prefer-function-component eslint-plugin-total-functions
beslogic/angular
Configurations for NGX projects. Comes with html
template and inline template support. Already extends beslogic/rxjs
and beslogic/typescript
. Also extends beslogic/node-js
for Javascript files.
For the linting to be fully effective, please make sure that your base tsconfig.json
extends eslint-config-beslogic/tsconfig.X.X.json
(see Parallel configurations).\
If bundling with an npm package set "strictMetadataEmit": true
under angularCompilerOptions
.
Add the following devDependencies
to your package.json
:
npm install --save-dev @angular-eslint/eslint-plugin @angular-eslint/eslint-plugin-template @angular-eslint/template-parser github:BesLogic/eslint-plugin-rxjs-angular#dist eslint-plugin-angular-file-naming eslint-plugin-total-functions
beslogic/storybook
Includes strict Storybook ESLint plugin and a custom rule for Angular components. This preset should be added last.
Add the following devDependencies
to your package.json
:
npm install --save-dev eslint-plugin-storybook
Stylistic Presets
If used, these presets should always come last, in this specific order.
beslogic/dprint
Disables all stylistic rules that are taken care of by dprint.
You must also extend the base configuration in a dprint.json
file (see Parallel configurations).
beslogic/json-like
Enforces stylistic rules for JS objects to look like valid JSON objects.
6 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
3 months ago
3 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago