eslint-plugin-jsdoc 51.4.0 → 52.0.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/dist/alignTransform.cjs +1 -1
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/generateRule.cjs +5 -5
- package/dist/generateRule.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.cjs +8 -8
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/iterateJsdoc.cjs +3 -3
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/jsdocUtils.cjs +9 -9
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/rules/checkAlignment.cjs +1 -1
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkExamples.cjs +5 -5
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkIndentation.cjs +6 -6
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.cjs +3 -3
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkTagNames.cjs +1 -1
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.cjs +1 -1
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTypes.cjs +2 -2
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkValues.cjs +1 -1
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/emptyTags.cjs +1 -1
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.cjs +2 -2
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.cjs +1 -1
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/matchDescription.cjs +4 -4
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchName.cjs +5 -2
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/noBadBlocks.cjs +2 -2
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +2 -2
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noDefaults.cjs +2 -2
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.cjs +6 -6
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.cjs +4 -4
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/requireAsteriskPrefix.cjs +1 -0
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +21 -21
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +3 -3
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireJsdoc.cjs +1 -1
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.cjs +1 -1
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireTemplate.cjs +2 -2
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/sortTags.cjs +1 -0
- package/dist/rules/sortTags.cjs.map +1 -1
- package/dist/rules/tagLines.cjs +2 -2
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/textEscaping.cjs +4 -4
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/validTypes.cjs +1 -1
- package/dist/rules/validTypes.cjs.map +1 -1
- package/eslint.config.js +6 -0
- package/package.json +1 -1
- package/src/alignTransform.js +1 -1
- package/src/getJsdocProcessorPlugin.js +8 -8
- package/src/iterateJsdoc.js +3 -3
- package/src/jsdocUtils.js +9 -9
- package/src/rules/checkAlignment.js +1 -1
- package/src/rules/checkExamples.js +5 -5
- package/src/rules/checkIndentation.js +6 -6
- package/src/rules/checkLineAlignment.js +3 -3
- package/src/rules/checkTagNames.js +1 -1
- package/src/rules/checkTemplateNames.js +1 -1
- package/src/rules/checkTypes.js +2 -2
- package/src/rules/checkValues.js +1 -1
- package/src/rules/emptyTags.js +1 -1
- package/src/rules/importsAsDependencies.js +2 -2
- package/src/rules/linesBeforeBlock.js +1 -1
- package/src/rules/matchDescription.js +4 -4
- package/src/rules/matchName.js +5 -2
- package/src/rules/noBadBlocks.js +2 -2
- package/src/rules/noBlankBlockDescriptions.js +2 -2
- package/src/rules/noDefaults.js +2 -2
- package/src/rules/noMultiAsterisks.js +6 -6
- package/src/rules/noUndefinedTypes.js +4 -4
- package/src/rules/requireAsteriskPrefix.js +1 -0
- package/src/rules/requireDescriptionCompleteSentence.js +21 -21
- package/src/rules/requireHyphenBeforeParamDescription.js +3 -3
- package/src/rules/requireJsdoc.js +1 -1
- package/src/rules/requireReturnsCheck.js +1 -1
- package/src/rules/requireTemplate.js +2 -2
- package/src/rules/sortTags.js +1 -0
- package/src/rules/tagLines.js +2 -2
- package/src/rules/textEscaping.js +4 -4
- package/src/rules/validTypes.js +1 -1
package/src/rules/sortTags.js
CHANGED
package/src/rules/tagLines.js
CHANGED
|
@@ -228,11 +228,11 @@ export default iterateJsdoc(({
|
|
|
228
228
|
description,
|
|
229
229
|
lastDescriptionLine,
|
|
230
230
|
} = utils.getDescription();
|
|
231
|
-
if (!(/\S/
|
|
231
|
+
if (!(/\S/v).test(description)) {
|
|
232
232
|
return;
|
|
233
233
|
}
|
|
234
234
|
|
|
235
|
-
const trailingLines = description.match(/\n+$/
|
|
235
|
+
const trailingLines = description.match(/\n+$/v)?.[0]?.length;
|
|
236
236
|
const trailingDiff = (trailingLines ?? 0) - startLines;
|
|
237
237
|
if (trailingDiff > 0) {
|
|
238
238
|
utils.reportJSDoc(
|
|
@@ -2,15 +2,15 @@ import iterateJsdoc from '../iterateJsdoc.js';
|
|
|
2
2
|
|
|
3
3
|
// We could disallow raw gt, quot, and apos, but allow for parity; but we do
|
|
4
4
|
// not allow hex or decimal character references
|
|
5
|
-
const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/
|
|
6
|
-
const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/
|
|
5
|
+
const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/v;
|
|
6
|
+
const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/v;
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
9
|
* @param {string} desc
|
|
10
10
|
* @returns {string}
|
|
11
11
|
*/
|
|
12
12
|
const htmlReplacer = (desc) => {
|
|
13
|
-
return desc.replaceAll(new RegExp(htmlRegex, '
|
|
13
|
+
return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {
|
|
14
14
|
if (_ === '<') {
|
|
15
15
|
return '<';
|
|
16
16
|
}
|
|
@@ -24,7 +24,7 @@ const htmlReplacer = (desc) => {
|
|
|
24
24
|
* @returns {string}
|
|
25
25
|
*/
|
|
26
26
|
const markdownReplacer = (desc) => {
|
|
27
|
-
return desc.replaceAll(new RegExp(markdownRegex, '
|
|
27
|
+
return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {
|
|
28
28
|
const bookend = '`'.repeat(backticks.length);
|
|
29
29
|
return `\\${bookend}${encapsed}${bookend}`;
|
|
30
30
|
});
|
package/src/rules/validTypes.js
CHANGED