@nfq/eslint-config 2.0.0 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/config/globals.js +1 -1
- package/config/plugins.js +2 -1
- package/config/settings.js +26 -1
- package/package.json +3 -2
- package/pnpm-lock.yaml +79 -5
- package/rules/errors.js +1 -7
- package/rules/index.js +2 -0
- package/rules/jsdoc.js +102 -0
- package/rules/style.js +1 -11
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [2.1.2](https://github.com/nfqde/eslint-config-nfq/compare/v2.1.1...v2.1.2) (2022-05-27)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* **require-jsdoc:** changes in the require-jsdoc rule ([#14](https://github.com/nfqde/eslint-config-nfq/issues/14)) ([6c1b035](https://github.com/nfqde/eslint-config-nfq/commit/6c1b035c6b8380e680112c0935175919caacd4ff))
|
|
11
|
+
|
|
12
|
+
### [2.1.1](https://github.com/nfqde/eslint-config-nfq/compare/v2.1.0...v2.1.1) (2022-05-24)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Bug Fixes
|
|
16
|
+
|
|
17
|
+
* **AddRules:** Add rules to config ([#13](https://github.com/nfqde/eslint-config-nfq/issues/13)) ([68b090d](https://github.com/nfqde/eslint-config-nfq/commit/68b090dc799b1b12433960dbcc8fe54f75b6306b))
|
|
18
|
+
|
|
19
|
+
## [2.1.0](https://github.com/nfqde/eslint-config-nfq/compare/v2.0.0...v2.1.0) (2022-05-24)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* **jsdoc:** New jsdoc parser plugin ([#12](https://github.com/nfqde/eslint-config-nfq/issues/12)) ([a495a28](https://github.com/nfqde/eslint-config-nfq/commit/a495a282838132377d18b6615e39485dedbce3f2))
|
|
25
|
+
|
|
5
26
|
## 2.0.0 (2022-02-24)
|
|
6
27
|
|
|
7
28
|
|
package/config/globals.js
CHANGED
package/config/plugins.js
CHANGED
package/config/settings.js
CHANGED
|
@@ -1,4 +1,29 @@
|
|
|
1
1
|
module.exports = {
|
|
2
|
-
'import/resolver': {
|
|
2
|
+
'import/resolver': {
|
|
3
|
+
alias: {
|
|
4
|
+
extensions: [
|
|
5
|
+
'.js',
|
|
6
|
+
'.jsx',
|
|
7
|
+
'.json',
|
|
8
|
+
'.css',
|
|
9
|
+
'.png',
|
|
10
|
+
'.jpeg',
|
|
11
|
+
'.jpg',
|
|
12
|
+
'.svg',
|
|
13
|
+
'.webp'
|
|
14
|
+
]
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
jsdoc: {
|
|
18
|
+
ignoreInternal: false,
|
|
19
|
+
ignorePrivate: false,
|
|
20
|
+
maxLines: 1,
|
|
21
|
+
minLines: 0,
|
|
22
|
+
mode: 'typescript',
|
|
23
|
+
tagNamePreference: {
|
|
24
|
+
augments: 'extends',
|
|
25
|
+
ignore: false
|
|
26
|
+
}
|
|
27
|
+
},
|
|
3
28
|
react: {version: 'detect'}
|
|
4
29
|
};
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nfq/eslint-config",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.2",
|
|
4
4
|
"engines": {
|
|
5
5
|
"node": ">= 12.0.0"
|
|
6
6
|
},
|
|
7
7
|
"description": "Eslint configuration for all nfq projects",
|
|
8
8
|
"main": "index.js",
|
|
9
9
|
"scripts": {
|
|
10
|
-
"deploy": "standard-version && git push --follow-tags origin master",
|
|
10
|
+
"deploy": "standard-version && git push --follow-tags origin master && npm publish",
|
|
11
11
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
12
12
|
},
|
|
13
13
|
"keywords": [
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
"eslint-plugin-array-func": "^3.1.7",
|
|
49
49
|
"eslint-plugin-better-styled-components": "^1.1.2",
|
|
50
50
|
"eslint-plugin-import": "^2.25.2",
|
|
51
|
+
"eslint-plugin-jsdoc": "^39.3.0",
|
|
51
52
|
"eslint-plugin-jsx-a11y": "^6.4.1",
|
|
52
53
|
"eslint-plugin-no-unsanitized": "^3.1.5",
|
|
53
54
|
"eslint-plugin-node": "^11.1.0",
|
package/pnpm-lock.yaml
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
lockfileVersion: 5.
|
|
1
|
+
lockfileVersion: 5.4
|
|
2
2
|
|
|
3
3
|
specifiers:
|
|
4
4
|
'@babel/core': ^7.15.8
|
|
@@ -10,6 +10,7 @@ specifiers:
|
|
|
10
10
|
eslint-plugin-array-func: ^3.1.7
|
|
11
11
|
eslint-plugin-better-styled-components: ^1.1.2
|
|
12
12
|
eslint-plugin-import: ^2.25.2
|
|
13
|
+
eslint-plugin-jsdoc: ^39.3.0
|
|
13
14
|
eslint-plugin-jsx-a11y: ^6.4.1
|
|
14
15
|
eslint-plugin-no-unsanitized: ^3.1.5
|
|
15
16
|
eslint-plugin-node: ^11.1.0
|
|
@@ -27,13 +28,14 @@ dependencies:
|
|
|
27
28
|
|
|
28
29
|
devDependencies:
|
|
29
30
|
'@babel/core': 7.15.8
|
|
30
|
-
'@babel/eslint-parser': 7.15.
|
|
31
|
+
'@babel/eslint-parser': 7.15.8_zlqquzezyrclzsndbv25dj3g74
|
|
31
32
|
'@nfq/eslint-plugin': 0.6.0
|
|
32
33
|
eslint: 8.0.0
|
|
33
|
-
eslint-import-resolver-alias: 1.1.
|
|
34
|
+
eslint-import-resolver-alias: 1.1.2_vh5gizyt4jfjl2cpwztvw7criy
|
|
34
35
|
eslint-plugin-array-func: 3.1.7_eslint@8.0.0
|
|
35
36
|
eslint-plugin-better-styled-components: 1.1.2
|
|
36
37
|
eslint-plugin-import: 2.25.2_eslint@8.0.0
|
|
38
|
+
eslint-plugin-jsdoc: 39.3.0_eslint@8.0.0
|
|
37
39
|
eslint-plugin-jsx-a11y: 6.4.1_eslint@8.0.0
|
|
38
40
|
eslint-plugin-no-unsanitized: 3.1.5_eslint@8.0.0
|
|
39
41
|
eslint-plugin-node: 11.1.0_eslint@8.0.0
|
|
@@ -83,7 +85,7 @@ packages:
|
|
|
83
85
|
- supports-color
|
|
84
86
|
dev: true
|
|
85
87
|
|
|
86
|
-
/@babel/eslint-parser/7.15.
|
|
88
|
+
/@babel/eslint-parser/7.15.8_zlqquzezyrclzsndbv25dj3g74:
|
|
87
89
|
resolution: {integrity: sha512-fYP7QFngCvgxjUuw8O057SVH5jCXsbFFOoE77CFDcvzwBVgTOkMD/L4mIC5Ud1xf8chK/no2fRbSSn1wvNmKuQ==}
|
|
88
90
|
engines: {node: ^10.13.0 || ^12.13.0 || >=14.0.0}
|
|
89
91
|
peerDependencies:
|
|
@@ -290,6 +292,15 @@ packages:
|
|
|
290
292
|
to-fast-properties: 2.0.0
|
|
291
293
|
dev: true
|
|
292
294
|
|
|
295
|
+
/@es-joy/jsdoccomment/0.30.0:
|
|
296
|
+
resolution: {integrity: sha512-U30cjaHCjdUqtbMgChJl80BP25GSRWg0/1R3UdB2ksitAo2oDYdRMrvzwuM21jcsFbEcLNAqwQGTCg+5CVbSIA==}
|
|
297
|
+
engines: {node: ^14 || ^16 || ^17 || ^18}
|
|
298
|
+
dependencies:
|
|
299
|
+
comment-parser: 1.3.1
|
|
300
|
+
esquery: 1.4.0
|
|
301
|
+
jsdoc-type-pratt-parser: 3.1.0
|
|
302
|
+
dev: true
|
|
303
|
+
|
|
293
304
|
/@eslint/eslintrc/1.0.2:
|
|
294
305
|
resolution: {integrity: sha512-x1ZXdEFsvTcnbTZgqcWUL9w2ybgZCw/qbKTPQnab+XnYA2bMQpJCh+/bBzCRfDJaJdlrrQlOk49jNtru9gL/6Q==}
|
|
295
306
|
engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0}
|
|
@@ -530,6 +541,11 @@ packages:
|
|
|
530
541
|
resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==}
|
|
531
542
|
dev: true
|
|
532
543
|
|
|
544
|
+
/comment-parser/1.3.1:
|
|
545
|
+
resolution: {integrity: sha512-B52sN2VNghyq5ofvUsqZjmk6YkihBX5vMSChmSK9v4ShjKf3Vk5Xcmgpw4o+iIgtrnM/u5FiMpz9VKb8lpBveA==}
|
|
546
|
+
engines: {node: '>= 12.0.0'}
|
|
547
|
+
dev: true
|
|
548
|
+
|
|
533
549
|
/concat-map/0.0.1:
|
|
534
550
|
resolution: {integrity: sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=}
|
|
535
551
|
dev: true
|
|
@@ -586,6 +602,18 @@ packages:
|
|
|
586
602
|
ms: 2.1.2
|
|
587
603
|
dev: true
|
|
588
604
|
|
|
605
|
+
/debug/4.3.4:
|
|
606
|
+
resolution: {integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==}
|
|
607
|
+
engines: {node: '>=6.0'}
|
|
608
|
+
peerDependencies:
|
|
609
|
+
supports-color: '*'
|
|
610
|
+
peerDependenciesMeta:
|
|
611
|
+
supports-color:
|
|
612
|
+
optional: true
|
|
613
|
+
dependencies:
|
|
614
|
+
ms: 2.1.2
|
|
615
|
+
dev: true
|
|
616
|
+
|
|
589
617
|
/deep-is/0.1.4:
|
|
590
618
|
resolution: {integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==}
|
|
591
619
|
dev: true
|
|
@@ -700,7 +728,7 @@ packages:
|
|
|
700
728
|
engines: {node: '>=10'}
|
|
701
729
|
dev: true
|
|
702
730
|
|
|
703
|
-
/eslint-import-resolver-alias/1.1.
|
|
731
|
+
/eslint-import-resolver-alias/1.1.2_vh5gizyt4jfjl2cpwztvw7criy:
|
|
704
732
|
resolution: {integrity: sha512-WdviM1Eu834zsfjHtcGHtGfcu+F30Od3V7I9Fi57uhBEwPkjDcii7/yW8jAT+gOhn4P/vOxxNAXbFAKsrrc15w==}
|
|
705
733
|
engines: {node: '>= 4'}
|
|
706
734
|
peerDependencies:
|
|
@@ -775,6 +803,24 @@ packages:
|
|
|
775
803
|
tsconfig-paths: 3.11.0
|
|
776
804
|
dev: true
|
|
777
805
|
|
|
806
|
+
/eslint-plugin-jsdoc/39.3.0_eslint@8.0.0:
|
|
807
|
+
resolution: {integrity: sha512-zEdkpezjIhG7gq4MbwLBKaD3cWsJkT7uTAJcIbLohQWR7OVwhPOBLPqpftBt8uzy0ZL+3jlbiaSXik4+VmN6JQ==}
|
|
808
|
+
engines: {node: ^14 || ^16 || ^17 || ^18}
|
|
809
|
+
peerDependencies:
|
|
810
|
+
eslint: ^7.0.0 || ^8.0.0
|
|
811
|
+
dependencies:
|
|
812
|
+
'@es-joy/jsdoccomment': 0.30.0
|
|
813
|
+
comment-parser: 1.3.1
|
|
814
|
+
debug: 4.3.4
|
|
815
|
+
escape-string-regexp: 4.0.0
|
|
816
|
+
eslint: 8.0.0
|
|
817
|
+
esquery: 1.4.0
|
|
818
|
+
semver: 7.3.7
|
|
819
|
+
spdx-expression-parse: 3.0.1
|
|
820
|
+
transitivePeerDependencies:
|
|
821
|
+
- supports-color
|
|
822
|
+
dev: true
|
|
823
|
+
|
|
778
824
|
/eslint-plugin-jsx-a11y/6.4.1_eslint@8.0.0:
|
|
779
825
|
resolution: {integrity: sha512-0rGPJBbwHoGNPU73/QCLP/vveMlM1b1Z9PponxO87jfr6tuH5ligXbDT6nHSSzBC8ovX2Z+BQu7Bk5D/Xgq9zg==}
|
|
780
826
|
engines: {node: '>=4.0'}
|
|
@@ -1323,6 +1369,11 @@ packages:
|
|
|
1323
1369
|
argparse: 2.0.1
|
|
1324
1370
|
dev: true
|
|
1325
1371
|
|
|
1372
|
+
/jsdoc-type-pratt-parser/3.1.0:
|
|
1373
|
+
resolution: {integrity: sha512-MgtD0ZiCDk9B+eI73BextfRrVQl0oyzRG8B2BjORts6jbunj4ScKPcyXGTbB6eXL4y9TzxCm6hyeLq/2ASzNdw==}
|
|
1374
|
+
engines: {node: '>=12.0.0'}
|
|
1375
|
+
dev: true
|
|
1376
|
+
|
|
1326
1377
|
/jsesc/2.5.2:
|
|
1327
1378
|
resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==}
|
|
1328
1379
|
engines: {node: '>=4'}
|
|
@@ -1731,6 +1782,14 @@ packages:
|
|
|
1731
1782
|
lru-cache: 6.0.0
|
|
1732
1783
|
dev: true
|
|
1733
1784
|
|
|
1785
|
+
/semver/7.3.7:
|
|
1786
|
+
resolution: {integrity: sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g==}
|
|
1787
|
+
engines: {node: '>=10'}
|
|
1788
|
+
hasBin: true
|
|
1789
|
+
dependencies:
|
|
1790
|
+
lru-cache: 6.0.0
|
|
1791
|
+
dev: true
|
|
1792
|
+
|
|
1734
1793
|
/shebang-command/2.0.0:
|
|
1735
1794
|
resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==}
|
|
1736
1795
|
engines: {node: '>=8'}
|
|
@@ -1761,6 +1820,21 @@ packages:
|
|
|
1761
1820
|
engines: {node: '>=0.10.0'}
|
|
1762
1821
|
dev: true
|
|
1763
1822
|
|
|
1823
|
+
/spdx-exceptions/2.3.0:
|
|
1824
|
+
resolution: {integrity: sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==}
|
|
1825
|
+
dev: true
|
|
1826
|
+
|
|
1827
|
+
/spdx-expression-parse/3.0.1:
|
|
1828
|
+
resolution: {integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==}
|
|
1829
|
+
dependencies:
|
|
1830
|
+
spdx-exceptions: 2.3.0
|
|
1831
|
+
spdx-license-ids: 3.0.11
|
|
1832
|
+
dev: true
|
|
1833
|
+
|
|
1834
|
+
/spdx-license-ids/3.0.11:
|
|
1835
|
+
resolution: {integrity: sha512-Ctl2BrFiM0X3MANYgj3CkygxhRmr9mi6xhejbdO960nF6EDJApTYpn0BQnDKlnNBULKiCN1n3w9EBkHK8ZWg+g==}
|
|
1836
|
+
dev: true
|
|
1837
|
+
|
|
1764
1838
|
/sprintf-js/1.0.3:
|
|
1765
1839
|
resolution: {integrity: sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=}
|
|
1766
1840
|
dev: true
|
package/rules/errors.js
CHANGED
|
@@ -49,13 +49,7 @@ module.exports = {
|
|
|
49
49
|
'no-unsafe-negation': 'error', // disallow negating the left operand of relational operators https://eslint.org/docs/rules/no-unsafe-negation
|
|
50
50
|
'require-atomic-updates': 'off', // Disallow assignments that can lead to race conditions due to usage of await or yield https://eslint.org/docs/rules/require-atomic-updates
|
|
51
51
|
'use-isnan': 'error', // disallow comparisons with the value NaN https://eslint.org/docs/rules/use-isnan
|
|
52
|
-
'valid-jsdoc':
|
|
53
|
-
'error',
|
|
54
|
-
{
|
|
55
|
-
matchDescription: '.+',
|
|
56
|
-
requireReturn: false
|
|
57
|
-
}
|
|
58
|
-
], // ensure JSDoc comments are valid https://eslint.org/docs/rules/valid-jsdoc
|
|
52
|
+
'valid-jsdoc': 'off', // ensure JSDoc comments are valid https://eslint.org/docs/rules/valid-jsdoc
|
|
59
53
|
'valid-typeof': ['error', {requireStringLiterals: true}] // ensure that the results of typeof are compared against a valid string https://eslint.org/docs/rules/valid-typeof
|
|
60
54
|
}
|
|
61
55
|
};
|
package/rules/index.js
CHANGED
|
@@ -3,6 +3,7 @@ const bestPractices = require.resolve('./best-practices');
|
|
|
3
3
|
const errors = require.resolve('./errors');
|
|
4
4
|
const es6 = require.resolve('./es6');
|
|
5
5
|
const imports = require.resolve('./imports');
|
|
6
|
+
const jsdoc = require.resolve('./jsdoc');
|
|
6
7
|
const node = require.resolve('./node');
|
|
7
8
|
const performance = require.resolve('./performance');
|
|
8
9
|
const promises = require.resolve('./promises');
|
|
@@ -22,6 +23,7 @@ module.exports = [
|
|
|
22
23
|
errors,
|
|
23
24
|
es6,
|
|
24
25
|
imports,
|
|
26
|
+
jsdoc,
|
|
25
27
|
node,
|
|
26
28
|
performance,
|
|
27
29
|
promises,
|
package/rules/jsdoc.js
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/* eslint-disable no-inline-comments */
|
|
2
|
+
module.exports = {
|
|
3
|
+
rules: {
|
|
4
|
+
'jsdoc/check-access': 'off', // checks access keyword for right values https://github.com/gajus/eslint-plugin-jsdoc#check-access
|
|
5
|
+
'jsdoc/check-alignment': 'error', // Reports invalid alignment of JSDoc block asterisks. https://github.com/gajus/eslint-plugin-jsdoc#check-alignment
|
|
6
|
+
'jsdoc/check-examples': 'off', // Reports invalid examples in JSDoc comments. (Waiting for eslint 8 support) https://github.com/gajus/eslint-plugin-jsdoc#check-examples
|
|
7
|
+
'jsdoc/check-indentation': 'error', // Reports invalid indentation of JSDoc block. https://github.com/gajus/eslint-plugin-jsdoc#check-indentation
|
|
8
|
+
'jsdoc/check-line-alignment': [
|
|
9
|
+
'error',
|
|
10
|
+
'always',
|
|
11
|
+
{tags: ['param', 'arg', 'argument', 'property', 'prop']}
|
|
12
|
+
], // Reports invalid alignment of JSDoc block lines. https://github.com/gajus/eslint-plugin-jsdoc#check-indentation
|
|
13
|
+
'jsdoc/check-param-names': [
|
|
14
|
+
'error',
|
|
15
|
+
{
|
|
16
|
+
checkDestructured: true,
|
|
17
|
+
enableFixer: true
|
|
18
|
+
}
|
|
19
|
+
], // Reports invalid parameter names in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#check-param-names
|
|
20
|
+
'jsdoc/check-property-names': [
|
|
21
|
+
'error',
|
|
22
|
+
{enableFixer: true}
|
|
23
|
+
], // Reports invalid property names in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#check-property-names
|
|
24
|
+
'jsdoc/check-syntax': 'error', // Reports invalid JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#check-syntax
|
|
25
|
+
'jsdoc/check-tag-names': 'error', // Reports invalid tag names in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
|
|
26
|
+
'jsdoc/check-types': 'error', // Reports invalid types in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#check-types
|
|
27
|
+
'jsdoc/check-values': 'error', // This rule checks the values for a handful of tags. https://github.com/gajus/eslint-plugin-jsdoc#check-values
|
|
28
|
+
'jsdoc/empty-tags': 'error', // Reports non empty JSDoc tags that should be empty. https://github.com/gajus/eslint-plugin-jsdoc#empty-tags
|
|
29
|
+
'jsdoc/implements-on-classes': 'error', // Reports missing @implements tag on classes. https://github.com/gajus/eslint-plugin-jsdoc#implements-on-classes
|
|
30
|
+
'jsdoc/match-description': 'error', // Reports invalid descriptions in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#match-description
|
|
31
|
+
'jsdoc/match-name': 'off', // Reports invalid names in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#match-name
|
|
32
|
+
'jsdoc/multiline-blocks': [
|
|
33
|
+
'error',
|
|
34
|
+
{
|
|
35
|
+
noFinalLineText: true,
|
|
36
|
+
noMultilineBlocks: false,
|
|
37
|
+
noSingleLineBlocks: false,
|
|
38
|
+
noZeroLineText: true
|
|
39
|
+
|
|
40
|
+
}
|
|
41
|
+
], // Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks. https://github.com/gajus/eslint-plugin-jsdoc#multiline-blocks
|
|
42
|
+
'jsdoc/newline-after-description': ['error', 'always'], // Reports missing newline after description in JSDoc comments.
|
|
43
|
+
'jsdoc/no-bad-blocks': 'error', // Reports invalid JSDoc block tags. https://github.com/gajus/eslint-plugin-jsdoc#no-bad-blocks
|
|
44
|
+
'jsdoc/no-defaults': 'off', // Reports default params if used. https://github.com/gajus/eslint-plugin-jsdoc#no-defaults
|
|
45
|
+
'jsdoc/no-missing-syntax': 'off', // Reports missing JSDoc syntax. https://github.com/gajus/eslint-plugin-jsdoc#no-missing-syntax
|
|
46
|
+
'jsdoc/no-multi-asterisks': 'error', // Prevents use of multiple asterisks at the beginning of lines. https://github.com/gajus/eslint-plugin-jsdoc#no-multi-asterisks
|
|
47
|
+
'jsdoc/no-restricted-syntax': 'off', // Reports invalid JSDoc syntax. https://github.com/gajus/eslint-plugin-jsdoc#no-restricted-syntax
|
|
48
|
+
'jsdoc/no-types': 'off', // Reports redundant types in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#no-types
|
|
49
|
+
'jsdoc/no-undefined-types': [
|
|
50
|
+
'error',
|
|
51
|
+
{definedTypes: ['JSX']}
|
|
52
|
+
], // Reports undefined types in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#no-undefined-types
|
|
53
|
+
'jsdoc/require-asterisk-prefix': ['error', 'always'], // Requires that each JSDoc line starts with an *. https://github.com/gajus/eslint-plugin-jsdoc#require-asterisk-prefix
|
|
54
|
+
'jsdoc/require-description': ['error', {exemptedBy: ['type', 'inheritdoc']}], // Reports missing description in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-description
|
|
55
|
+
'jsdoc/require-description-complete-sentence': 'error', // Reports missing complete sentence in JSDoc description. https://github.com/gajus/eslint-plugin-jsdoc#require-description-complete-sentence
|
|
56
|
+
'jsdoc/require-example': 'off', // Reports missing example in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-example
|
|
57
|
+
'jsdoc/require-file-overview': 'off', // Reports missing file overview in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-file-overview
|
|
58
|
+
'jsdoc/require-hyphen-before-param-description': ['error', 'never'], // Reports missing hyphen before param description in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-hyphen-before-param-description
|
|
59
|
+
'jsdoc/require-jsdoc': [
|
|
60
|
+
'error',
|
|
61
|
+
{
|
|
62
|
+
publicOnly: false,
|
|
63
|
+
require: {
|
|
64
|
+
ArrowFunctionExpression: true,
|
|
65
|
+
ClassDeclaration: true,
|
|
66
|
+
ClassExpression: true,
|
|
67
|
+
FunctionDeclaration: true,
|
|
68
|
+
FunctionExpression: true,
|
|
69
|
+
MethodDefinition: true
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
], // Reports missing JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-jsdoc
|
|
73
|
+
'jsdoc/require-param': [
|
|
74
|
+
'error',
|
|
75
|
+
{
|
|
76
|
+
checkDestructured: true,
|
|
77
|
+
checkDestructuredRoots: true,
|
|
78
|
+
checkRestProperty: true,
|
|
79
|
+
enableFixer: true,
|
|
80
|
+
enableRestElementFixer: true,
|
|
81
|
+
enableRootFixer: true,
|
|
82
|
+
useDefaultObjectProperties: true
|
|
83
|
+
}
|
|
84
|
+
], // Reports missing params in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-param
|
|
85
|
+
'jsdoc/require-param-description': 'error', // Reports missing param description in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-param-description
|
|
86
|
+
'jsdoc/require-param-name': 'error', // Reports missing param name in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-param-name
|
|
87
|
+
'jsdoc/require-param-type': 'error', // Reports missing param type in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-param-type
|
|
88
|
+
'jsdoc/require-property': 'error', // Reports missing properties in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-property
|
|
89
|
+
'jsdoc/require-property-description': 'error', // Reports missing property description in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-property-description
|
|
90
|
+
'jsdoc/require-property-name': 'error', // Reports missing property name in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-property-name
|
|
91
|
+
'jsdoc/require-property-type': 'error', // Reports missing property type in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-property-type
|
|
92
|
+
'jsdoc/require-returns': 'error', // Reports missing returns in JSDoc comments.
|
|
93
|
+
'jsdoc/require-returns-check': 'error', // Reports missing returns in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-returns-check
|
|
94
|
+
'jsdoc/require-returns-description': 'error', // Reports missing returns description in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-returns-description
|
|
95
|
+
'jsdoc/require-returns-type': 'error', // Reports missing returns type in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-returns-type
|
|
96
|
+
'jsdoc/require-throws': 'error', // Reports missing throws in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-throws
|
|
97
|
+
'jsdoc/require-yields': 'error', // Reports missing yields in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-yields
|
|
98
|
+
'jsdoc/require-yields-check': 'error', // Reports missing yields in JSDoc comments. https://github.com/gajus/eslint-plugin-jsdoc#require-yields-check
|
|
99
|
+
'jsdoc/sort-tags': 'error', // Reports unsorted JSDoc tags. https://github.com/gajus/eslint-plugin-jsdoc#sort-tags
|
|
100
|
+
'jsdoc/tag-lines': 'off' // Reports unsorted JSDoc tags. https://github.com/gajus/eslint-plugin-jsdoc#tag-lines
|
|
101
|
+
}
|
|
102
|
+
};
|
package/rules/style.js
CHANGED
|
@@ -334,17 +334,7 @@ module.exports = {
|
|
|
334
334
|
'single',
|
|
335
335
|
{avoidEscape: true}
|
|
336
336
|
], // specify whether double or single quotes should be used
|
|
337
|
-
'require-jsdoc':
|
|
338
|
-
'error',
|
|
339
|
-
{
|
|
340
|
-
require: {
|
|
341
|
-
ArrowFunctionExpression: true,
|
|
342
|
-
ClassDeclaration: true,
|
|
343
|
-
FunctionDeclaration: true,
|
|
344
|
-
MethodDefinition: true
|
|
345
|
-
}
|
|
346
|
-
}
|
|
347
|
-
], // do not require jsdoc https://eslint.org/docs/rules/require-jsdoc
|
|
337
|
+
'require-jsdoc': 'off', // do not require jsdoc https://eslint.org/docs/rules/require-jsdoc
|
|
348
338
|
semi: ['error', 'always'], // require or disallow use of semicolons instead of ASI https://eslint.org/docs/rules/semi
|
|
349
339
|
'semi-spacing': [
|
|
350
340
|
'error',
|