-
Notifications
You must be signed in to change notification settings - Fork 229
/
.eslintrc.js
132 lines (124 loc) · 3.14 KB
/
.eslintrc.js
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
module.exports = {
extends: ['standard', 'prettier'],
ignorePatterns: [
'**/fixtures/build/**',
// Enable dotfile linting
'!.*',
'node_modules',
'node_modules/.*'
],
overrides: [
{
extends: [
'eslint:recommended',
'plugin:import/recommended',
'plugin:jsdoc/recommended-typescript-flavor',
'plugin:n/recommended',
'plugin:promise/recommended',
'prettier'
],
files: [
'**/*.{cjs,js,mjs}',
// Check markdown `*.md` contains valid code blocks
// https://github.com/eslint/eslint-plugin-markdown#advanced-configuration
'**/*.md/*.{cjs,js,mjs}'
],
parserOptions: {
ecmaVersion: 'latest'
},
plugins: ['import', 'jsdoc', 'n', 'promise'],
rules: {
// Check import or require statements are A-Z ordered
'import/order': [
'error',
{
alphabetize: { order: 'asc' },
'newlines-between': 'always'
}
],
// JSDoc blocks are optional by default
'jsdoc/require-jsdoc': 'off',
// Check for valid formatting
'jsdoc/check-line-alignment': [
'warn',
'never',
{
wrapIndent: ' '
}
],
// Add unknown @jest-environment tag name
'jsdoc/check-tag-names': [
'warn',
{
definedTags: ['jest-environment']
}
],
// Require hyphens before param description
// Aligns with TSDoc style: https://tsdoc.org/pages/tags/param/
'jsdoc/require-hyphen-before-param-description': 'warn',
// Maintain new line after description
'jsdoc/tag-lines': [
'warn',
'never',
{
startLines: 1
}
],
// Automatically use template strings
'no-useless-concat': 'error',
'prefer-template': 'error'
},
settings: {
jsdoc: {
// Allows us to use type declarations that exist in our dependencies
mode: 'typescript'
}
}
},
{
// Extensions required for ESM import
files: ['**/*.mjs'],
rules: {
'import/extensions': [
'error',
'always',
{
ignorePackages: true,
pattern: {
cjs: 'always',
js: 'always',
mjs: 'always'
}
}
]
}
},
{
files: ['**/*.test.{cjs,js,mjs}'],
env: {
jest: true
},
globals: {
page: 'readonly',
browser: 'readonly',
jestPuppeteer: 'readonly'
}
},
{
// Add plugin for markdown `*.md` code blocks. Its config is in the new
// "flat" format, so we need to use the legacy config
extends: ['plugin:markdown/recommended-legacy'],
files: ['**/*.md'],
plugins: ['markdown'],
processor: 'markdown/markdown'
},
{
// Assume markdown `*.md` JavaScript code blocks use browser globals
files: ['**/*.md/*.{cjs,js,mjs}'],
env: {
browser: true
}
}
],
root: true
}