@wistia/eslint-config 0.17.2 → 0.17.4
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wistia/eslint-config",
|
|
3
|
-
"version": "0.17.
|
|
3
|
+
"version": "0.17.4",
|
|
4
4
|
"description": "Wistia's ESLint configurations",
|
|
5
5
|
"main": "react.js",
|
|
6
6
|
"exports": {
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
".": "./configs/eslint/default.js",
|
|
9
9
|
"./cypress": "./configs/eslint/cypress.js",
|
|
10
10
|
"./jest": "./configs/eslint/jest.js",
|
|
11
|
+
"./jsdoc": "./configs/eslint/jsdoc.js",
|
|
11
12
|
"./node": "./configs/eslint/node.js",
|
|
12
13
|
"./prettier": "./configs/eslint/prettier.js",
|
|
13
14
|
"./react": "./configs/eslint/react.js",
|
|
@@ -45,6 +46,7 @@
|
|
|
45
46
|
"eslint-plugin-jest": "^27.1.3",
|
|
46
47
|
"eslint-plugin-jest-dom": "^4.0.2",
|
|
47
48
|
"eslint-plugin-jest-formatting": "^3.1.0",
|
|
49
|
+
"eslint-plugin-jsdoc": "^39.3.6",
|
|
48
50
|
"eslint-plugin-jsx-a11y": "^6.6.1",
|
|
49
51
|
"eslint-plugin-no-only-tests": "^3.1.0",
|
|
50
52
|
"eslint-plugin-no-snapshot-testing": "^1.0.61",
|
|
@@ -53,7 +55,7 @@
|
|
|
53
55
|
"eslint-plugin-promise": "^6.1.1",
|
|
54
56
|
"eslint-plugin-react": "^7.31.10",
|
|
55
57
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
56
|
-
"eslint-plugin-sonarjs": "
|
|
58
|
+
"eslint-plugin-sonarjs": "0.18.0",
|
|
57
59
|
"eslint-plugin-storybook": "^0.6.7",
|
|
58
60
|
"eslint-plugin-styled-components-a11y": "^1.0.0",
|
|
59
61
|
"eslint-plugin-testing-library": "^5.9.1",
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
// only add jsdocs rules
|
|
2
|
+
// see: https://github.com/gajus/eslint-plugin-jsdoc#rules
|
|
3
|
+
|
|
4
|
+
module.exports = {
|
|
5
|
+
plugins: ['eslint-plugin-jsdoc'],
|
|
6
|
+
|
|
7
|
+
rules: {
|
|
8
|
+
'jsdoc/check-access': 'error',
|
|
9
|
+
'jsdoc/check-alignment': 'error',
|
|
10
|
+
'jsdoc/check-examples': 'error',
|
|
11
|
+
'jsdoc/check-indentation': 'error',
|
|
12
|
+
'jsdoc/check-line-alignment': 'error',
|
|
13
|
+
'jsdoc/check-param-names': 'error',
|
|
14
|
+
'jsdoc/check-property-names': 'error',
|
|
15
|
+
'jsdoc/check-syntax': 'error',
|
|
16
|
+
'jsdoc/check-tag-names': 'error',
|
|
17
|
+
'jsdoc/check-types': 'error',
|
|
18
|
+
'jsdoc/check-values': 'error',
|
|
19
|
+
'jsdoc/empty-tags': 'error',
|
|
20
|
+
'jsdoc/implements-on-classes': 'error',
|
|
21
|
+
'jsdoc/match-description': 'error',
|
|
22
|
+
'jsdoc/multiline-blocks': 'error',
|
|
23
|
+
'jsdoc/newline-after-description': 'error',
|
|
24
|
+
'jsdoc/no-bad-blocks': 'error',
|
|
25
|
+
'jsdoc/no-defaults': 'error',
|
|
26
|
+
'jsdoc/no-missing-syntax': 'error',
|
|
27
|
+
'jsdoc/no-multi-asterisks': 'error',
|
|
28
|
+
'jsdoc/no-restricted-syntax': 'error',
|
|
29
|
+
'jsdoc/no-types': 'error',
|
|
30
|
+
'jsdoc/no-undefined-types': 'error',
|
|
31
|
+
'jsdoc/require-asterisk-prefix': 'error',
|
|
32
|
+
'jsdoc/require-description': 'error',
|
|
33
|
+
'jsdoc/require-description-complete-sentence': 'error',
|
|
34
|
+
'jsdoc/require-example': 'error',
|
|
35
|
+
'jsdoc/require-file-overview': 'error',
|
|
36
|
+
'jsdoc/require-hyphen-before-param-description': 'error',
|
|
37
|
+
'jsdoc/require-jsdoc': 'error',
|
|
38
|
+
'jsdoc/require-param': 'error',
|
|
39
|
+
'jsdoc/require-param-description': 'error',
|
|
40
|
+
'jsdoc/require-param-name': 'error',
|
|
41
|
+
'jsdoc/require-param-type': 'error',
|
|
42
|
+
'jsdoc/require-property': 'error',
|
|
43
|
+
'jsdoc/require-property-description': 'error',
|
|
44
|
+
'jsdoc/require-property-name': 'error',
|
|
45
|
+
'jsdoc/require-property-type': 'error',
|
|
46
|
+
'jsdoc/require-returns': 'error',
|
|
47
|
+
'jsdoc/require-returns-check': 'error',
|
|
48
|
+
'jsdoc/require-returns-description': 'error',
|
|
49
|
+
'jsdoc/require-returns-type': 'error',
|
|
50
|
+
'jsdoc/require-throws': 'error',
|
|
51
|
+
'jsdoc/require-yields': 'error',
|
|
52
|
+
'jsdoc/require-yields-check': 'error',
|
|
53
|
+
'jsdoc/tag-lines': 'error',
|
|
54
|
+
'jsdoc/valid-types': 'error',
|
|
55
|
+
},
|
|
56
|
+
};
|
|
@@ -531,13 +531,10 @@ module.exports = {
|
|
|
531
531
|
'error',
|
|
532
532
|
{
|
|
533
533
|
ignore: [0, 1, 2, 3, 4, 5, 1000],
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
ignoreNumericLiteralTypes: true,
|
|
539
|
-
ignoreReadonlyClassProperties: true,
|
|
540
|
-
ignoreTypeIndexes: true,
|
|
534
|
+
ignoreEnums: false,
|
|
535
|
+
ignoreNumericLiteralTypes: false,
|
|
536
|
+
ignoreReadonlyClassProperties: false,
|
|
537
|
+
ignoreTypeIndexes: false,
|
|
541
538
|
},
|
|
542
539
|
],
|
|
543
540
|
|