eslint-plugin-jsdoc 37.6.3 → 37.7.0
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/README.md +24 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -5447,6 +5447,15 @@ function quux (foo) {
|
|
|
5447
5447
|
}
|
|
5448
5448
|
// Settings: {"jsdoc":{"mode":"typescript","preferredTypes":{"Object":"object"}}}
|
|
5449
5449
|
// Message: Invalid JSDoc @param "foo" type "Object"; prefer: "object".
|
|
5450
|
+
|
|
5451
|
+
/**
|
|
5452
|
+
* @param {object.<string>} foo
|
|
5453
|
+
*/
|
|
5454
|
+
function quux (foo) {
|
|
5455
|
+
|
|
5456
|
+
}
|
|
5457
|
+
// Settings: {"jsdoc":{"mode":"typescript","preferredTypes":{"object.<>":"Object"}}}
|
|
5458
|
+
// Message: Invalid JSDoc @param "foo" type "object"; prefer: "Object".
|
|
5450
5459
|
````
|
|
5451
5460
|
|
|
5452
5461
|
The following patterns are not considered problems:
|
|
@@ -5734,6 +5743,14 @@ function b () {}
|
|
|
5734
5743
|
function quux (foo) {
|
|
5735
5744
|
|
|
5736
5745
|
}
|
|
5746
|
+
|
|
5747
|
+
/**
|
|
5748
|
+
* @param {Object.<string>} foo
|
|
5749
|
+
*/
|
|
5750
|
+
function quux (foo) {
|
|
5751
|
+
|
|
5752
|
+
}
|
|
5753
|
+
// Settings: {"jsdoc":{"mode":"typescript"}}
|
|
5737
5754
|
````
|
|
5738
5755
|
|
|
5739
5756
|
|
|
@@ -9109,6 +9126,13 @@ const MY_ENUM = Object.freeze({
|
|
|
9109
9126
|
} as const);
|
|
9110
9127
|
// "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","message":"@enum not allowed on declarations"}]}]
|
|
9111
9128
|
// Message: @enum not allowed on declarations
|
|
9129
|
+
|
|
9130
|
+
/** @type {React.FunctionComponent<{ children: React.ReactNode }>}*/
|
|
9131
|
+
const MyComponent = ({ children }) => {
|
|
9132
|
+
return children;
|
|
9133
|
+
}
|
|
9134
|
+
// "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."}]}]
|
|
9135
|
+
// Message: The `FunctionComponent` type is not allowed. Please use `FC` instead.
|
|
9112
9136
|
````
|
|
9113
9137
|
|
|
9114
9138
|
The following patterns are not considered problems:
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "~0.
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.18.0",
|
|
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.16.8",
|
|
20
|
-
"@babel/core": "^7.16.
|
|
20
|
+
"@babel/core": "^7.16.12",
|
|
21
21
|
"@babel/eslint-parser": "^7.16.5",
|
|
22
22
|
"@babel/node": "^7.16.8",
|
|
23
23
|
"@babel/plugin-syntax-class-properties": "^7.12.13",
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
"@babel/preset-env": "^7.16.11",
|
|
26
26
|
"@babel/register": "^7.16.9",
|
|
27
27
|
"@hkdobrev/run-if-changed": "^0.3.1",
|
|
28
|
-
"@typescript-eslint/parser": "^5.10.
|
|
28
|
+
"@typescript-eslint/parser": "^5.10.1",
|
|
29
29
|
"babel-plugin-add-module-exports": "^1.0.4",
|
|
30
30
|
"babel-plugin-istanbul": "^6.1.1",
|
|
31
31
|
"camelcase": "^6.3.0",
|
|
32
|
-
"chai": "^4.3.
|
|
32
|
+
"chai": "^4.3.5",
|
|
33
33
|
"cross-env": "^7.0.3",
|
|
34
34
|
"decamelize": "^5.0.1",
|
|
35
35
|
"eslint": "^8.7.0",
|
|
@@ -37,9 +37,9 @@
|
|
|
37
37
|
"gitdown": "^3.1.4",
|
|
38
38
|
"glob": "^7.2.0",
|
|
39
39
|
"husky": "^7.0.4",
|
|
40
|
-
"lint-staged": "^12.
|
|
40
|
+
"lint-staged": "^12.3.1",
|
|
41
41
|
"lodash.defaultsdeep": "^4.6.1",
|
|
42
|
-
"mocha": "^9.
|
|
42
|
+
"mocha": "^9.2.0",
|
|
43
43
|
"nyc": "^15.1.0",
|
|
44
44
|
"open-editor": "^3.0.0",
|
|
45
45
|
"rimraf": "^3.0.2",
|
|
@@ -107,5 +107,5 @@
|
|
|
107
107
|
"test-index": "cross-env BABEL_ENV=test mocha --recursive --require @babel/register --reporter progress --timeout 12000 test/rules/index.js",
|
|
108
108
|
"test-no-cov": "cross-env BABEL_ENV=test mocha --reporter dot --recursive --require @babel/register --timeout 12000"
|
|
109
109
|
},
|
|
110
|
-
"version": "37.
|
|
110
|
+
"version": "37.7.0"
|
|
111
111
|
}
|