eslint-plugin-jsdoc 44.2.3 → 44.2.4

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 (110) hide show
  1. package/dist/alignTransform.js +86 -4
  2. package/dist/alignTransform.js.map +1 -1
  3. package/dist/exportParser.js +134 -4
  4. package/dist/exportParser.js.map +1 -1
  5. package/dist/iterateJsdoc.js +936 -345
  6. package/dist/iterateJsdoc.js.map +1 -1
  7. package/dist/jsdocUtils.js +173 -105
  8. package/dist/jsdocUtils.js.map +1 -1
  9. package/dist/rules/checkAlignment.js +6 -0
  10. package/dist/rules/checkAlignment.js.map +1 -1
  11. package/dist/rules/checkExamples.js +70 -6
  12. package/dist/rules/checkExamples.js.map +1 -1
  13. package/dist/rules/checkIndentation.js +11 -1
  14. package/dist/rules/checkIndentation.js.map +1 -1
  15. package/dist/rules/checkLineAlignment.js +68 -4
  16. package/dist/rules/checkLineAlignment.js.map +1 -1
  17. package/dist/rules/checkParamNames.js +12 -7
  18. package/dist/rules/checkParamNames.js.map +1 -1
  19. package/dist/rules/checkPropertyNames.js +13 -7
  20. package/dist/rules/checkPropertyNames.js.map +1 -1
  21. package/dist/rules/checkTagNames.js +45 -5
  22. package/dist/rules/checkTagNames.js.map +1 -1
  23. package/dist/rules/checkTypes.js +97 -36
  24. package/dist/rules/checkTypes.js.map +1 -1
  25. package/dist/rules/checkValues.js +6 -6
  26. package/dist/rules/checkValues.js.map +1 -1
  27. package/dist/rules/emptyTags.js +8 -1
  28. package/dist/rules/emptyTags.js.map +1 -1
  29. package/dist/rules/informativeDocs.js +26 -7
  30. package/dist/rules/informativeDocs.js.map +1 -1
  31. package/dist/rules/matchDescription.js +18 -1
  32. package/dist/rules/matchDescription.js.map +1 -1
  33. package/dist/rules/matchName.js +2 -2
  34. package/dist/rules/matchName.js.map +1 -1
  35. package/dist/rules/multilineBlocks.js +12 -1
  36. package/dist/rules/multilineBlocks.js.map +1 -1
  37. package/dist/rules/noBadBlocks.js +3 -5
  38. package/dist/rules/noBadBlocks.js.map +1 -1
  39. package/dist/rules/noBlankBlockDescriptions.js +2 -0
  40. package/dist/rules/noBlankBlockDescriptions.js.map +1 -1
  41. package/dist/rules/noMissingSyntax.js +58 -15
  42. package/dist/rules/noMissingSyntax.js.map +1 -1
  43. package/dist/rules/noMultiAsterisks.js +1 -6
  44. package/dist/rules/noMultiAsterisks.js.map +1 -1
  45. package/dist/rules/noRestrictedSyntax.js +17 -4
  46. package/dist/rules/noRestrictedSyntax.js.map +1 -1
  47. package/dist/rules/noTypes.js +3 -0
  48. package/dist/rules/noTypes.js.map +1 -1
  49. package/dist/rules/noUndefinedTypes.js +61 -20
  50. package/dist/rules/noUndefinedTypes.js.map +1 -1
  51. package/dist/rules/requireAsteriskPrefix.js +20 -0
  52. package/dist/rules/requireAsteriskPrefix.js.map +1 -1
  53. package/dist/rules/requireDescription.js +6 -2
  54. package/dist/rules/requireDescription.js.map +1 -1
  55. package/dist/rules/requireDescriptionCompleteSentence.js +72 -9
  56. package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -1
  57. package/dist/rules/requireFileOverview.js +9 -4
  58. package/dist/rules/requireFileOverview.js.map +1 -1
  59. package/dist/rules/requireHyphenBeforeParamDescription.js +23 -6
  60. package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -1
  61. package/dist/rules/requireJsdoc.js +144 -28
  62. package/dist/rules/requireJsdoc.js.map +1 -1
  63. package/dist/rules/requireParam.js +46 -2
  64. package/dist/rules/requireParam.js.map +1 -1
  65. package/dist/rules/requireProperty.js +1 -1
  66. package/dist/rules/requireProperty.js.map +1 -1
  67. package/dist/rules/requireReturns.js +2 -2
  68. package/dist/rules/requireReturns.js.map +1 -1
  69. package/dist/rules/requireReturnsCheck.js +9 -2
  70. package/dist/rules/requireReturnsCheck.js.map +1 -1
  71. package/dist/rules/requireThrows.js +2 -2
  72. package/dist/rules/requireThrows.js.map +1 -1
  73. package/dist/rules/requireYields.js +9 -2
  74. package/dist/rules/requireYields.js.map +1 -1
  75. package/dist/rules/requireYieldsCheck.js +19 -5
  76. package/dist/rules/requireYieldsCheck.js.map +1 -1
  77. package/dist/rules/sortTags.js +67 -9
  78. package/dist/rules/sortTags.js.map +1 -1
  79. package/dist/rules/tagLines.js +22 -3
  80. package/dist/rules/tagLines.js.map +1 -1
  81. package/dist/rules/textEscaping.js +16 -2
  82. package/dist/rules/textEscaping.js.map +1 -1
  83. package/dist/rules/validTypes.js +25 -8
  84. package/dist/rules/validTypes.js.map +1 -1
  85. package/dist/utils/hasReturnValue.js +77 -43
  86. package/dist/utils/hasReturnValue.js.map +1 -1
  87. package/docs/rules/check-tag-names.md +15 -0
  88. package/docs/rules/no-missing-syntax.md +6 -0
  89. package/docs/rules/require-description-complete-sentence.md +525 -289
  90. package/docs/rules/require-description.md +289 -525
  91. package/docs/rules/require-file-overview.md +7 -0
  92. package/docs/rules/require-jsdoc.md +1 -1
  93. package/docs/rules/require-param-description.md +116 -1694
  94. package/docs/rules/require-param-name.md +58 -133
  95. package/docs/rules/require-param-type.md +119 -55
  96. package/docs/rules/require-param.md +1700 -111
  97. package/docs/rules/require-property-description.md +39 -79
  98. package/docs/rules/require-property-name.md +21 -30
  99. package/docs/rules/require-property-type.md +21 -21
  100. package/docs/rules/require-property.md +82 -33
  101. package/docs/rules/require-returns-check.md +636 -747
  102. package/docs/rules/require-returns-description.md +61 -933
  103. package/docs/rules/require-returns-type.md +42 -79
  104. package/docs/rules/require-returns.md +1081 -61
  105. package/docs/rules/require-yields-check.md +238 -517
  106. package/docs/rules/require-yields.md +517 -238
  107. package/docs/rules/valid-types.md +1 -1
  108. package/docs/settings.md +1 -1
  109. package/package.json +5 -4
  110. package/tsconfig.json +2 -3
package/docs/rules/valid-types.md CHANGED
@@ -437,7 +437,7 @@ function quux () {}
437
437
  */
438
438
  function quux () {}
439
439
  // Settings: {"jsdoc":{"mode":"closure"}}
440
- // Message: Syntax error in supresss type: blah
440
+ // Message: Syntax error in suppress type: blah
441
441
 
442
442
  /**
443
443
  * @param {Object[]} employees
package/docs/settings.md CHANGED
@@ -347,7 +347,7 @@ values are objects with the following optional properties:
347
347
  is required (not just that if present, it is a valid type). You
348
348
  might use this with `@throws` or `@typedef` which might otherwise
349
349
  normally have their types optional. See the type groups 3-5 above.
350
- - `"typeOrName"` - Must have either type (e.g., `@throws {aType}`) or
350
+ - `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
351
351
  name (`@throws Some text`); does not require that both exist but
352
352
  disallows just an empty tag.
353
353
 
package/package.json CHANGED
@@ -5,13 +5,13 @@
5
5
  "url": "http://gajus.com"
6
6
  },
7
7
  "dependencies": {
8
- "@es-joy/jsdoccomment": "~0.39.1",
8
+ "@es-joy/jsdoccomment": "~0.39.3",
9
9
  "are-docs-informative": "^0.0.2",
10
10
  "comment-parser": "1.3.1",
11
11
  "debug": "^4.3.4",
12
12
  "escape-string-regexp": "^4.0.0",
13
13
  "esquery": "^1.5.0",
14
- "semver": "^7.5.0",
14
+ "semver": "^7.5.1",
15
15
  "spdx-expression-parse": "^3.0.1"
16
16
  },
17
17
  "description": "JSDoc linting rules for ESLint.",
@@ -32,10 +32,11 @@
32
32
  "@types/chai": "^4.3.5",
33
33
  "@types/debug": "^4.1.7",
34
34
  "@types/eslint": "^8.37.0",
35
+ "@types/esquery": "^1.0.2",
35
36
  "@types/estree": "^1.0.1",
36
37
  "@types/lodash.defaultsdeep": "^4.6.7",
37
38
  "@types/mocha": "^10.0.1",
38
- "@types/node": "^20.1.2",
39
+ "@types/node": "^20.1.4",
39
40
  "@types/semver": "^7.5.0",
40
41
  "@types/spdx-expression-parse": "^3.0.2",
41
42
  "@typescript-eslint/parser": "^5.59.5",
@@ -131,5 +132,5 @@
131
132
  "test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
132
133
  "test-index": "npm run test-no-cov -- test/rules/index.js"
133
134
  },
134
- "version": "44.2.3"
135
+ "version": "44.2.4"
135
136
  }
package/tsconfig.json CHANGED
@@ -13,10 +13,9 @@
13
13
  "target": "es6",
14
14
  "outDir": "dist"
15
15
  },
16
- // Uncomment below as ready
17
16
  "include": [
18
- // "src/**/*.js",
19
- // "test/**/*.js",
17
+ "src/**/*.js",
18
+ "test/**/*.js",
20
19
  "src/bin/gitdown.d.ts"
21
20
  ],
22
21
  "exclude": ["node_modules"]