Skip to content

Commit e26a11a

Browse files
authored
fix(require-param): update jsdoccomment to support exported TSFunctionType type; fixes #1386 (#1389)
1 parent 2bd7242 commit e26a11a

File tree

4 files changed

+342
-278
lines changed

4 files changed

+342
-278
lines changed

docs/rules/require-param.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1178,6 +1178,13 @@ class A {
11781178
function quux (a, b) {}
11791179
// "jsdoc/require-param": ["error"|"warn", {"ignoreWhenAllParamsMissing":true}]
11801180
// Message: Missing JSDoc @param "b" declaration.
1181+
1182+
/**
1183+
* Some test function type.
1184+
*/
1185+
export type Test = (foo: number) => string;
1186+
// "jsdoc/require-param": ["error"|"warn", {"contexts":["TSFunctionType"]}]
1187+
// Message: Missing JSDoc @param "foo" declaration.
11811188
````
11821189

11831190

package.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"url": "http://gajus.com"
66
},
77
"dependencies": {
8-
"@es-joy/jsdoccomment": "~0.49.0",
8+
"@es-joy/jsdoccomment": "~0.50.1",
99
"are-docs-informative": "^0.0.2",
1010
"comment-parser": "1.4.1",
1111
"debug": "^4.3.6",
@@ -31,19 +31,19 @@
3131
"@semantic-release/commit-analyzer": "^13.0.0",
3232
"@semantic-release/github": "^11.0.0",
3333
"@semantic-release/npm": "^12.0.1",
34-
"@types/chai": "^4.3.17",
34+
"@types/chai": "^5.2.2",
3535
"@types/debug": "^4.1.12",
36-
"@types/eslint": "^9.6.0",
36+
"@types/eslint": "^9.6.1",
3737
"@types/espree": "^10.1.0",
3838
"@types/esquery": "^1.5.4",
39-
"@types/estree": "^1.0.5",
39+
"@types/estree": "^1.0.7",
4040
"@types/json-schema": "^7.0.15",
4141
"@types/lodash.defaultsdeep": "^4.6.9",
42-
"@types/mocha": "^10.0.7",
43-
"@types/node": "^22.2.0",
44-
"@types/semver": "^7.5.8",
42+
"@types/mocha": "^10.0.10",
43+
"@types/node": "^22.15.18",
44+
"@types/semver": "^7.7.0",
4545
"@types/spdx-expression-parse": "^3.0.5",
46-
"@typescript-eslint/types": "^8.1.0",
46+
"@typescript-eslint/types": "^8.32.1",
4747
"babel-plugin-add-module-exports": "^1.0.4",
4848
"babel-plugin-istanbul": "^7.0.0",
4949
"babel-plugin-transform-import-meta": "^2.2.1",
@@ -67,8 +67,8 @@
6767
"replace": "^1.2.2",
6868
"rimraf": "^5.0.7",
6969
"semantic-release": "^24.1.1",
70-
"typescript": "5.5.x",
71-
"typescript-eslint": "^8.1.0"
70+
"typescript": "5.8.x",
71+
"typescript-eslint": "^8.32.1"
7272
},
7373
"engines": {
7474
"node": ">=18"

0 commit comments

Comments
 (0)