Repository navigation
Expand file tree
/
Copy path.eslintrc.cjs
More file actions
174 lines (150 loc) · 5.12 KB
/
Copy path.eslintrc.cjs
File metadata and controls
174 lines (150 loc) · 5.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
"use strict";
const airbnbBase = require("eslint-config-airbnb-base");
// eslint-disable-next-line import/no-dynamic-require
const bestPractices = require(airbnbBase.extends[0]);
const ignoredProps = bestPractices.rules[
"no-param-reassign"
][1].ignorePropertyModificationsFor.concat(
"err",
"x",
"_",
"opts",
"options",
"settings",
"config",
"cfg"
);
// Additional rules that are specific and overriding previous
const additionalChanges = {
strict: "off",
// Enforce using named functions when regular function is used,
// otherwise use arrow functions
"func-names": ["error", "always"],
// Always use parens (for consistency).
// https://eslint.org/docs/rules/arrow-parens
"arrow-parens": ["error", "always", { requireForBlockBody: true }],
"prefer-arrow-callback": [
"error",
{ allowNamedFunctions: true, allowUnboundThis: true },
],
// http://eslint.org/docs/rules/max-params
"max-params": ["error", { max: 3 }],
// http://eslint.org/docs/rules/max-statements
"max-statements": ["error", { max: 20 }],
// http://eslint.org/docs/rules/max-statements-per-line
"max-statements-per-line": ["error", { max: 1 }],
// http://eslint.org/docs/rules/max-nested-callbacks
"max-nested-callbacks": ["error", { max: 4 }],
// http://eslint.org/docs/rules/max-depth
"max-depth": ["error", { max: 4 }],
// enforces no braces where they can be omitted
// https://eslint.org/docs/rules/arrow-body-style
// Never enable for object literal.
"arrow-body-style": [
"error",
"as-needed",
{ requireReturnForObjectLiteral: false },
],
// Allow functions to be use before define because:
// 1) they are hoisted,
// 2) because ensure read flow is from top to bottom
// 3) logically order of the code.
// 4) the only addition is 'typedefs' option, see overrides for TS files
"no-use-before-define": [
"error",
{
functions: false,
classes: true,
variables: true,
},
],
// Same as AirBnB, but adds `opts`, `options`, `x` and `err` to exclusions!
// disallow reassignment of function parameters
// disallow parameter object manipulation except for specific exclusions
// rule: https://eslint.org/docs/rules/no-param-reassign.html
"no-param-reassign": [
"error",
{
props: true,
ignorePropertyModificationsFor: ignoredProps,
},
],
// disallow declaration of variables that are not used in the code
"no-unused-vars": [
"error",
{
ignoreRestSiblings: true, // airbnb's default
vars: "all", // airbnb's default
varsIgnorePattern: "^(?:$$|xx|_|__|[iI]gnor(?:e|ing|ed))",
args: "after-used", // airbnb's default
argsIgnorePattern: "^(?:$$|xx|_|__|[iI]gnor(?:e|ing|ed))",
// catch blocks are handled by Unicorns
caughtErrors: "none",
// caughtErrorsIgnorePattern: '^(?:$$|xx|_|__|[iI]gnor(?:e|ing|ed))',
},
],
};
const importRules = {
"import/namespace": ["error", { allowComputed: true }],
"import/no-absolute-path": "error",
"import/no-webpack-loader-syntax": "error",
"import/no-self-import": "error",
// Enable this sometime in the future when Node.js has ES2015 module support
// 'import/no-cycle': 'error',
// Disabled as it doesn't work with TypeScript
// 'import/newline-after-import': 'error',
"import/no-amd": "error",
"import/no-duplicates": "error",
// Enable this sometime in the future when Node.js has ES2015 module support
// 'import/unambiguous': 'error',
// Enable this sometime in the future when Node.js has ES2015 module support
// 'import/no-commonjs': 'error',
// Looks useful, but too unstable at the moment
// 'import/no-deprecated': 'error',
"import/no-extraneous-dependencies": "off",
"import/no-mutable-exports": "error",
"import/no-named-as-default-member": "error",
"import/no-named-as-default": "error",
// Disabled because it's buggy and it also doesn't work with TypeScript
// 'import/no-unresolved': [
// 'error',
// {
// commonjs: true
// }
// ],
"import/order": "error",
"import/no-unassigned-import": [
"error",
{ allow: ["@babel/polyfill", "@babel/register"] },
],
"import/prefer-default-export": "off",
// Ensure more web-compat
// ! note that it doesn't work in CommonJS
// https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
"import/extensions": "off",
// ? Always use named exports. Enable?
// 'import/no-default-export': 'error',
// ? enable?
"import/exports-last": "off",
// todo: Enable in future.
// Ensures everything is tested (all exports should be used).
// For cases when you don't want or can't test, add eslint-ignore comment!
// see: https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unused-modules.md
"import/no-unused-modules": "off",
"import/no-useless-path-segments": ["error", { noUselessIndex: false }],
};
module.exports = {
env: {
es6: true,
es2020: true,
jest: true,
node: true,
commonjs: true,
},
extends: ["eslint:recommended", "airbnb-base", "plugin:prettier/recommended"],
plugins: ["prettier"],
rules: {
...additionalChanges,
...importRules,
},
};