eslint-plugin-jsdoc 37.9.2 → 37.9.3
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/CONTRIBUTING.md +1 -1
- package/README.md +6 -0
- package/package.json +17 -8
package/CONTRIBUTING.md
CHANGED
|
@@ -55,7 +55,7 @@ can use `npm run test-index`.
|
|
|
55
55
|
To test specific rules, you can supply a comma-separated list with the `--rule`
|
|
56
56
|
flag passed to `test-index`, e.g., for `check-examples` and `require-example`:
|
|
57
57
|
|
|
58
|
-
`npm run --rule=check-examples,require-example
|
|
58
|
+
`npm run test-index --rule=check-examples,require-example`.
|
|
59
59
|
|
|
60
60
|
You can further limit this by providing `--invalid` and/or `--valid` flags
|
|
61
61
|
with a comma-separated list of 0-based indexes that you wish to include (also
|
package/README.md
CHANGED
|
@@ -9261,6 +9261,12 @@ const MY_ENUM = Object.freeze({
|
|
|
9261
9261
|
VAL_A: "myvala"
|
|
9262
9262
|
} as const);
|
|
9263
9263
|
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag ~ JsdocTag[tag=/private|protected/])","context":"any","message":"Access modifier tags must come first"},{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"enum\"])","context":":declaration:not(TSEnumDeclaration):not(:has(ObjectExpression)), :function","message":"@enum is only allowed on potential enum types"}]}]
|
|
9264
|
+
|
|
9265
|
+
/**
|
|
9266
|
+
* @param {(...args: any[]) => any} fn
|
|
9267
|
+
* @returns {(...args: any[]) => any}
|
|
9268
|
+
*/
|
|
9269
|
+
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"type\"]:has([value=/FunctionComponent/]))","context":"any","message":"The `FunctionComponent` type is not allowed. Please use `FC` instead."}]}]
|
|
9264
9270
|
````
|
|
9265
9271
|
|
|
9266
9272
|
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "~0.20.
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.20.1",
|
|
9
9
|
"comment-parser": "1.3.0",
|
|
10
10
|
"debug": "^4.3.3",
|
|
11
11
|
"escape-string-regexp": "^4.0.0",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"description": "JSDoc linting rules for ESLint.",
|
|
18
18
|
"devDependencies": {
|
|
19
19
|
"@babel/cli": "^7.17.3",
|
|
20
|
-
"@babel/core": "^7.17.
|
|
20
|
+
"@babel/core": "^7.17.5",
|
|
21
21
|
"@babel/eslint-parser": "^7.17.0",
|
|
22
22
|
"@babel/node": "^7.16.8",
|
|
23
23
|
"@babel/plugin-syntax-class-properties": "^7.12.13",
|
|
@@ -64,9 +64,17 @@
|
|
|
64
64
|
},
|
|
65
65
|
"main": "./dist/index.js",
|
|
66
66
|
"name": "eslint-plugin-jsdoc",
|
|
67
|
+
"mocha": {
|
|
68
|
+
"require": [
|
|
69
|
+
"@babel/register"
|
|
70
|
+
],
|
|
71
|
+
"reporter": "dot",
|
|
72
|
+
"recursive": true,
|
|
73
|
+
"timeout": 12000
|
|
74
|
+
},
|
|
67
75
|
"nyc": {
|
|
68
76
|
"branches": 100,
|
|
69
|
-
"check-coverage":
|
|
77
|
+
"check-coverage": true,
|
|
70
78
|
"exclude": [
|
|
71
79
|
"src/rules/checkExamples.js"
|
|
72
80
|
],
|
|
@@ -76,6 +84,7 @@
|
|
|
76
84
|
],
|
|
77
85
|
"instrument": false,
|
|
78
86
|
"lines": 100,
|
|
87
|
+
"reporter": "text-summary",
|
|
79
88
|
"require": [
|
|
80
89
|
"@babel/register"
|
|
81
90
|
],
|
|
@@ -102,10 +111,10 @@
|
|
|
102
111
|
"lint-arg": "eslint --report-unused-disable-directives",
|
|
103
112
|
"lint-fix": "npm run lint-arg -- --fix .",
|
|
104
113
|
"prepare": "husky install",
|
|
105
|
-
"test": "cross-env BABEL_ENV=test
|
|
106
|
-
"test
|
|
107
|
-
"test-
|
|
108
|
-
"test-
|
|
114
|
+
"test-no-cov": "cross-env BABEL_ENV=test mocha",
|
|
115
|
+
"test": "nyc npm run test-no-cov",
|
|
116
|
+
"test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
|
|
117
|
+
"test-index": "npm run test-no-cov -- test/rules/index.js"
|
|
109
118
|
},
|
|
110
|
-
"version": "37.9.
|
|
119
|
+
"version": "37.9.3"
|
|
111
120
|
}
|