Skip to content

Commit

Permalink
jsdoc: Update eslint-plugin-jsdoc to 46.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
edg2s authored and jdforrester committed Nov 22, 2023
1 parent 592a14b commit 95a792b
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 32 deletions.
3 changes: 2 additions & 1 deletion jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
],
"jsdoc/check-values": "off",
"jsdoc/empty-tags": "off",
"jsdoc/no-blank-blocks": "warn",
"jsdoc/no-blank-block-descriptions": "warn",
"jsdoc/no-defaults": "off",
"jsdoc/no-multi-asterisks": [ "error", { "allowWhitespace": true } ],
Expand All @@ -62,6 +63,6 @@
"jsdoc/require-property-description": "off",
"jsdoc/require-property-name": "off",
"jsdoc/require-returns-description": "off",
"jsdoc/tag-lines": "off"
"jsdoc/tag-lines": [ "warn", "any", { "startLines": 1 } ]
}
}
60 changes: 31 additions & 29 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
"eslint-plugin-compat": "^4.2.0",
"eslint-plugin-es-x": "^7.3.0",
"eslint-plugin-jest": "^27.6.0",
"eslint-plugin-jsdoc": "^42.0.0",
"eslint-plugin-jsdoc": "46.9.0",
"eslint-plugin-json-es": "^1.5.7",
"eslint-plugin-mediawiki": "^0.5.0",
"eslint-plugin-mocha": "^10.2.0",
Expand Down
18 changes: 18 additions & 0 deletions test/fixtures/jsdoc/invalid.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
let APP;
/* eslint-enable jsdoc/check-property-names, jsdoc/no-blank-block-descriptions */

/* eslint-disable jsdoc/no-blank-blocks */
/**
*
*/
/* eslint-enable jsdoc/no-blank-blocks */

/* eslint-disable jsdoc/require-property-type */
/**
* @property Bar
Expand Down Expand Up @@ -91,6 +97,18 @@
};
/* eslint-enable jsdoc/require-returns-type */

/* eslint-disable jsdoc/tag-lines */
/**
* Description
* @param {Object} bar
* @param {string} bar.module `module` property threw an error in eslint-plugin-jsdoc<37.5.0
* @return {number}
*/
APP.method = function ( bar ) {
return bar;
};
/* eslint-enable jsdoc/tag-lines */

// eslint-disable-next-line jsdoc/check-access
/**
* @public
Expand Down
2 changes: 1 addition & 1 deletion test/fixtures/jsdoc/valid.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// Off: jsdoc/require-file-overview
// Off: jsdoc/require-hyphen-before-param-description
// Off: jsdoc/require-property
/* global Foo, APP */
( function () {
// Off: jsdoc/require-property-description
// Off: jsdoc/require-property-name
Expand All @@ -22,7 +23,6 @@
let APP;

// Valid: settings.jsdoc.tagNamePreference
// Off: jsdoc/tag-lines
// Off: jsdoc/sort-tags
/**
* Non-default aliases:
Expand Down

0 comments on commit 95a792b

Please sign in to comment.