eslint-plugin-jsdoc 48.2.6 → 48.2.8

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.
Files changed (117) hide show
  1. package/dist/exportParser.cjs +2 -3
  2. package/dist/exportParser.cjs.map +1 -1
  3. package/dist/generateRule.cjs +1 -1
  4. package/dist/generateRule.cjs.map +1 -1
  5. package/dist/index.cjs +1 -1
  6. package/dist/index.cjs.map +1 -1
  7. package/dist/iterateJsdoc.cjs +1 -1
  8. package/dist/iterateJsdoc.cjs.map +1 -1
  9. package/dist/jsdocUtils.cjs +1 -1
  10. package/dist/jsdocUtils.cjs.map +1 -1
  11. package/dist/rules/checkAccess.cjs +1 -1
  12. package/dist/rules/checkAccess.cjs.map +1 -1
  13. package/dist/rules/checkAlignment.cjs +1 -1
  14. package/dist/rules/checkAlignment.cjs.map +1 -1
  15. package/dist/rules/checkExamples.cjs +1 -1
  16. package/dist/rules/checkExamples.cjs.map +1 -1
  17. package/dist/rules/checkIndentation.cjs +1 -1
  18. package/dist/rules/checkIndentation.cjs.map +1 -1
  19. package/dist/rules/checkLineAlignment.cjs +1 -1
  20. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  21. package/dist/rules/checkParamNames.cjs +1 -1
  22. package/dist/rules/checkParamNames.cjs.map +1 -1
  23. package/dist/rules/checkPropertyNames.cjs +1 -1
  24. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  25. package/dist/rules/checkSyntax.cjs +1 -1
  26. package/dist/rules/checkSyntax.cjs.map +1 -1
  27. package/dist/rules/checkTagNames.cjs +1 -1
  28. package/dist/rules/checkTagNames.cjs.map +1 -1
  29. package/dist/rules/checkTypes.cjs +1 -1
  30. package/dist/rules/checkTypes.cjs.map +1 -1
  31. package/dist/rules/checkValues.cjs +1 -1
  32. package/dist/rules/checkValues.cjs.map +1 -1
  33. package/dist/rules/emptyTags.cjs +1 -1
  34. package/dist/rules/emptyTags.cjs.map +1 -1
  35. package/dist/rules/implementsOnClasses.cjs +1 -1
  36. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  37. package/dist/rules/importsAsDependencies.cjs +1 -1
  38. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  39. package/dist/rules/informativeDocs.cjs +1 -1
  40. package/dist/rules/informativeDocs.cjs.map +1 -1
  41. package/dist/rules/matchDescription.cjs +1 -1
  42. package/dist/rules/matchDescription.cjs.map +1 -1
  43. package/dist/rules/matchName.cjs +1 -1
  44. package/dist/rules/matchName.cjs.map +1 -1
  45. package/dist/rules/multilineBlocks.cjs +1 -1
  46. package/dist/rules/multilineBlocks.cjs.map +1 -1
  47. package/dist/rules/noBadBlocks.cjs +1 -1
  48. package/dist/rules/noBadBlocks.cjs.map +1 -1
  49. package/dist/rules/noBlankBlockDescriptions.cjs +1 -1
  50. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  51. package/dist/rules/noBlankBlocks.cjs +1 -1
  52. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  53. package/dist/rules/noDefaults.cjs +1 -1
  54. package/dist/rules/noDefaults.cjs.map +1 -1
  55. package/dist/rules/noMissingSyntax.cjs +1 -1
  56. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  57. package/dist/rules/noMultiAsterisks.cjs +1 -1
  58. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  59. package/dist/rules/noRestrictedSyntax.cjs +1 -1
  60. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  61. package/dist/rules/noTypes.cjs +1 -1
  62. package/dist/rules/noTypes.cjs.map +1 -1
  63. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  64. package/dist/rules/requireAsteriskPrefix.cjs +1 -1
  65. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  66. package/dist/rules/requireDescription.cjs +1 -1
  67. package/dist/rules/requireDescription.cjs.map +1 -1
  68. package/dist/rules/requireDescriptionCompleteSentence.cjs +2 -2
  69. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  70. package/dist/rules/requireExample.cjs +1 -1
  71. package/dist/rules/requireExample.cjs.map +1 -1
  72. package/dist/rules/requireFileOverview.cjs +1 -1
  73. package/dist/rules/requireFileOverview.cjs.map +1 -1
  74. package/dist/rules/requireHyphenBeforeParamDescription.cjs +1 -1
  75. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  76. package/dist/rules/requireJsdoc.cjs +1 -1
  77. package/dist/rules/requireJsdoc.cjs.map +1 -1
  78. package/dist/rules/requireParam.cjs +1 -1
  79. package/dist/rules/requireParam.cjs.map +1 -1
  80. package/dist/rules/requireParamDescription.cjs +1 -1
  81. package/dist/rules/requireParamDescription.cjs.map +1 -1
  82. package/dist/rules/requireParamName.cjs +1 -1
  83. package/dist/rules/requireParamName.cjs.map +1 -1
  84. package/dist/rules/requireParamType.cjs +1 -1
  85. package/dist/rules/requireParamType.cjs.map +1 -1
  86. package/dist/rules/requireProperty.cjs +1 -1
  87. package/dist/rules/requireProperty.cjs.map +1 -1
  88. package/dist/rules/requirePropertyDescription.cjs +1 -1
  89. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  90. package/dist/rules/requirePropertyName.cjs +1 -1
  91. package/dist/rules/requirePropertyName.cjs.map +1 -1
  92. package/dist/rules/requirePropertyType.cjs +1 -1
  93. package/dist/rules/requirePropertyType.cjs.map +1 -1
  94. package/dist/rules/requireReturns.cjs +1 -1
  95. package/dist/rules/requireReturns.cjs.map +1 -1
  96. package/dist/rules/requireReturnsCheck.cjs +1 -1
  97. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  98. package/dist/rules/requireReturnsDescription.cjs +1 -1
  99. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  100. package/dist/rules/requireReturnsType.cjs +1 -1
  101. package/dist/rules/requireReturnsType.cjs.map +1 -1
  102. package/dist/rules/requireThrows.cjs +1 -1
  103. package/dist/rules/requireThrows.cjs.map +1 -1
  104. package/dist/rules/requireYields.cjs +1 -1
  105. package/dist/rules/requireYields.cjs.map +1 -1
  106. package/dist/rules/requireYieldsCheck.cjs +1 -1
  107. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  108. package/dist/rules/sortTags.cjs +1 -1
  109. package/dist/rules/sortTags.cjs.map +1 -1
  110. package/dist/rules/tagLines.cjs +1 -1
  111. package/dist/rules/tagLines.cjs.map +1 -1
  112. package/dist/rules/textEscaping.cjs +1 -1
  113. package/dist/rules/textEscaping.cjs.map +1 -1
  114. package/dist/rules/validTypes.cjs +1 -1
  115. package/dist/rules/validTypes.cjs.map +1 -1
  116. package/package.json +21 -21
  117. package/src/rules/requireDescriptionCompleteSentence.js +4 -1
package/package.json CHANGED
@@ -5,42 +5,42 @@
5
5
  "url": "http://gajus.com"
6
6
  },
7
7
  "dependencies": {
8
- "@es-joy/jsdoccomment": "~0.43.0",
8
+ "@es-joy/jsdoccomment": "~0.43.1",
9
9
  "are-docs-informative": "^0.0.2",
10
10
  "comment-parser": "1.4.1",
11
11
  "debug": "^4.3.4",
12
12
  "escape-string-regexp": "^4.0.0",
13
13
  "esquery": "^1.5.0",
14
- "semver": "^7.6.1",
14
+ "semver": "^7.6.2",
15
15
  "spdx-expression-parse": "^4.0.0"
16
16
  },
17
17
  "description": "JSDoc linting rules for ESLint.",
18
18
  "devDependencies": {
19
- "@babel/cli": "^7.24.5",
20
- "@babel/core": "^7.24.5",
21
- "@babel/eslint-parser": "^7.24.5",
22
- "@babel/node": "^7.23.9",
19
+ "@babel/cli": "^7.24.6",
20
+ "@babel/core": "^7.24.6",
21
+ "@babel/eslint-parser": "^7.24.6",
22
+ "@babel/node": "^7.24.6",
23
23
  "@babel/plugin-syntax-class-properties": "^7.12.13",
24
- "@babel/plugin-transform-flow-strip-types": "^7.24.1",
25
- "@babel/preset-env": "^7.24.5",
24
+ "@babel/plugin-transform-flow-strip-types": "^7.24.6",
25
+ "@babel/preset-env": "^7.24.6",
26
26
  "@es-joy/escodegen": "^3.5.1",
27
27
  "@es-joy/jsdoc-eslint-parser": "^0.21.1",
28
28
  "@hkdobrev/run-if-changed": "^0.3.1",
29
29
  "@semantic-release/commit-analyzer": "^12.0.0",
30
- "@semantic-release/github": "^10.0.3",
31
- "@semantic-release/npm": "^12.0.0",
30
+ "@semantic-release/github": "^10.0.5",
31
+ "@semantic-release/npm": "^12.0.1",
32
32
  "@types/chai": "^4.3.16",
33
33
  "@types/debug": "^4.1.12",
34
34
  "@types/eslint": "^8.56.10",
35
- "@types/esquery": "^1.5.3",
35
+ "@types/esquery": "^1.5.4",
36
36
  "@types/estree": "^1.0.5",
37
37
  "@types/json-schema": "^7.0.15",
38
38
  "@types/lodash.defaultsdeep": "^4.6.9",
39
39
  "@types/mocha": "^10.0.6",
40
- "@types/node": "^20.12.11",
40
+ "@types/node": "^20.12.12",
41
41
  "@types/semver": "^7.5.8",
42
42
  "@types/spdx-expression-parse": "^3.0.5",
43
- "@typescript-eslint/parser": "^7.8.0",
43
+ "@typescript-eslint/parser": "^7.11.0",
44
44
  "babel-plugin-add-module-exports": "^1.0.4",
45
45
  "babel-plugin-istanbul": "^6.1.1",
46
46
  "c8": "^9.1.0",
@@ -48,22 +48,22 @@
48
48
  "chai": "^4.3.10",
49
49
  "cross-env": "^7.0.3",
50
50
  "decamelize": "^5.0.1",
51
- "eslint": "9.2.0",
52
- "eslint-config-canonical": "~42.8.2",
51
+ "eslint": "9.3.0",
52
+ "eslint-config-canonical": "~43.0.12",
53
53
  "espree": "^10.0.1",
54
54
  "gitdown": "^3.1.5",
55
- "glob": "^10.3.13",
56
- "globals": "^15.2.0",
55
+ "glob": "^10.4.1",
56
+ "globals": "^15.3.0",
57
57
  "husky": "^9.0.11",
58
58
  "jsdoc-type-pratt-parser": "^4.0.0",
59
59
  "json-schema": "^0.4.0",
60
- "lint-staged": "^15.2.2",
60
+ "lint-staged": "^15.2.5",
61
61
  "lodash.defaultsdeep": "^4.6.1",
62
62
  "mocha": "^10.4.0",
63
63
  "open-editor": "^3.0.0",
64
64
  "replace": "^1.2.2",
65
- "rimraf": "^5.0.5",
66
- "semantic-release": "^23.0.8",
65
+ "rimraf": "^5.0.7",
66
+ "semantic-release": "^23.1.1",
67
67
  "typescript": "5.3.x"
68
68
  },
69
69
  "engines": {
@@ -140,5 +140,5 @@
140
140
  "test-cov": "cross-env TIMING=1 c8 --reporter text npm run test-no-cov",
141
141
  "test-index": "npm run test-no-cov -- test/rules/index.js"
142
142
  },
143
- "version": "48.2.6"
143
+ "version": "48.2.8"
144
144
  }
@@ -192,7 +192,10 @@ const validateDescription = (
192
192
 
193
193
  const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, '');
194
194
 
195
- if (!/(?:[.?!|]|```)\s*$/u.test(paragraphNoAbbreviations)) {
195
+ if (
196
+ !/(?:[.?!|]|```)\s*$/u.test(paragraphNoAbbreviations) &&
197
+ !paragraphNoAbbreviations.startsWith('#')
198
+ ) {
196
199
  report('Sentences must end with a period.', fix, tag);
197
200
  return true;
198
201
  }