eslint-config-joyn
v4.4.1
Published
Shareable ESLint config presets for Joyn.
Downloads
4,563
Readme
eslint-config-joyn
Shareable ESLint config presets for Joyn.
This config aims for ES2015+ or TypeScript code. It supports various environments (e.g. node
or browser
).
Install and Setup
- Make sure to install all required peer dependencies along with this config:
npm i -D eslint-config-joyn eslint-plugin-prettier prettier eslint-plugin-unicorn eslint-plugin-promise eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-optimize-regex eslint-plugin-no-secrets eslint-plugin-array-func eslint-plugin-sonarjs
- Add
extends: "joyn"
to your ESLint config.
Specify Environments
Example:
The following .eslintrc.json
config file configures a node project with mixed commonjs script and typescript files.
{
"extends": [ "joyn", "joyn/presets/node" ],
"overrides": [
{
"files": [ "**/*.js" ],
"extends": [ "joyn/presets/commonjs" ]
},
{
"files": [ "**/*.ts" ],
"extends": [ "joyn/presets/typescript" ]
},
{
"files": [ "test/unit/**/*.spec.js", "test/unit/**/*.spec.ts" ],
"extends": [ "joyn/presets/mocha-chai" ]
}
]
}
Environments:
joyn/presets/browser
joyn/presets/node
: requires additional dependenciesnpm i -D eslint-plugin-node
joyn/presets/commonjs
joyn/presets/esm
joyn/presets/typescript
: requires additional dependenciesnpm i -D @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-functional
and the use of--ext
ESLint CLI option in order to lint.ts
filesjoyn/presets/ava
: requires additional dependenciesnpm i -D eslint-plugin-ava
joyn/presets/mocha-chai
: requires additional dependenciesnpm i -D eslint-plugin-mocha
joyn/presets/jest
: requires additional dependenciesnpm i -D eslint-plugin-jest
joyn/presets/react
: requires additional dependenciesnpm i -D eslint-plugin-react eslint-plugin-react-hooks