Skip to content

Commit fd1eab0

Browse files
committedNov 10, 2023
feat: bump jsdoccomment, devDeps.; fixes #1167
1 parent 7a70c83 commit fd1eab0

File tree

4 files changed

+783
-724
lines changed

4 files changed

+783
-724
lines changed
 

‎docs/rules/require-description.md

+23
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,29 @@ class quux {
345345
// Settings: {"jsdoc":{"implementsReplacesDocs":false}}
346346
// "jsdoc/require-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"implements\"])","context":"any"}],"descriptionStyle":"tag"}]
347347
// Message: Missing JSDoc @description declaration.
348+
349+
app.use(
350+
/** @type {express.ErrorRequestHandler} */
351+
(err, req, res, next) => {
352+
// foo
353+
}
354+
);
355+
// Message: Missing JSDoc block description.
356+
357+
app.use(
358+
/** @type {express.ErrorRequestHandler} */
359+
(
360+
(err, req, res, next) => {
361+
// foo
362+
}
363+
)
364+
);
365+
// Message: Missing JSDoc block description.
366+
367+
/** @type {TreeViewItemData[]} */
368+
this.treeViewSelection = [];
369+
// "jsdoc/require-description": ["error"|"warn", {"contexts":["AssignmentExpression"]}]
370+
// Message: Missing JSDoc block description.
348371
````
349372

350373

‎package.json

+18-18
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.40.1",
8+
"@es-joy/jsdoccomment": "~0.41.0",
99
"are-docs-informative": "^0.0.2",
1010
"comment-parser": "1.4.1",
1111
"debug": "^4.3.4",
@@ -18,31 +18,31 @@
1818
"description": "JSDoc linting rules for ESLint.",
1919
"devDependencies": {
2020
"@babel/cli": "^7.23.0",
21-
"@babel/core": "^7.23.2",
22-
"@babel/eslint-parser": "^7.22.15",
21+
"@babel/core": "^7.23.3",
22+
"@babel/eslint-parser": "^7.23.3",
2323
"@babel/node": "^7.22.19",
2424
"@babel/plugin-syntax-class-properties": "^7.12.13",
25-
"@babel/plugin-transform-flow-strip-types": "^7.22.5",
26-
"@babel/preset-env": "^7.23.2",
25+
"@babel/plugin-transform-flow-strip-types": "^7.23.3",
26+
"@babel/preset-env": "^7.23.3",
2727
"@babel/register": "^7.22.15",
2828
"@es-joy/escodegen": "^3.5.1",
2929
"@es-joy/jsdoc-eslint-parser": "^0.19.0",
3030
"@hkdobrev/run-if-changed": "^0.3.1",
3131
"@semantic-release/commit-analyzer": "^11.1.0",
32-
"@semantic-release/github": "^9.2.1",
32+
"@semantic-release/github": "^9.2.3",
3333
"@semantic-release/npm": "^11.0.1",
34-
"@types/chai": "^4.3.9",
35-
"@types/debug": "^4.1.10",
36-
"@types/eslint": "^8.44.6",
37-
"@types/esquery": "^1.5.2",
38-
"@types/estree": "^1.0.4",
39-
"@types/json-schema": "^7.0.14",
40-
"@types/lodash.defaultsdeep": "^4.6.8",
41-
"@types/mocha": "^10.0.3",
42-
"@types/node": "^20.8.10",
43-
"@types/semver": "^7.5.4",
44-
"@types/spdx-expression-parse": "^3.0.4",
45-
"@typescript-eslint/parser": "^6.9.1",
34+
"@types/chai": "^4.3.10",
35+
"@types/debug": "^4.1.12",
36+
"@types/eslint": "^8.44.7",
37+
"@types/esquery": "^1.5.3",
38+
"@types/estree": "^1.0.5",
39+
"@types/json-schema": "^7.0.15",
40+
"@types/lodash.defaultsdeep": "^4.6.9",
41+
"@types/mocha": "^10.0.4",
42+
"@types/node": "^20.9.0",
43+
"@types/semver": "^7.5.5",
44+
"@types/spdx-expression-parse": "^3.0.5",
45+
"@typescript-eslint/parser": "^6.10.0",
4646
"babel-plugin-add-module-exports": "^1.0.4",
4747
"babel-plugin-istanbul": "^6.1.1",
4848
"camelcase": "^6.3.0",

‎pnpm-lock.yaml

+689-706
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎test/rules/assertions/requireDescription.js

+53
Original file line numberDiff line numberDiff line change
@@ -735,6 +735,59 @@ export default {
735735
},
736736
},
737737
},
738+
{
739+
code: `
740+
app.use(
741+
/** @type {express.ErrorRequestHandler} */
742+
(err, req, res, next) => {
743+
// foo
744+
}
745+
);
746+
`,
747+
errors: [
748+
{
749+
line: 3,
750+
message: 'Missing JSDoc block description.',
751+
},
752+
],
753+
},
754+
{
755+
code: `
756+
app.use(
757+
/** @type {express.ErrorRequestHandler} */
758+
(
759+
(err, req, res, next) => {
760+
// foo
761+
}
762+
)
763+
);
764+
`,
765+
errors: [
766+
{
767+
line: 3,
768+
message: 'Missing JSDoc block description.',
769+
},
770+
],
771+
},
772+
{
773+
code: `
774+
/** @type {TreeViewItemData[]} */
775+
this.treeViewSelection = [];
776+
`,
777+
errors: [
778+
{
779+
line: 2,
780+
message: 'Missing JSDoc block description.',
781+
},
782+
],
783+
options: [
784+
{
785+
contexts: [
786+
'AssignmentExpression',
787+
],
788+
},
789+
],
790+
},
738791
],
739792
valid: [
740793
{

0 commit comments

Comments
 (0)
Please sign in to comment.