eslint-plugin-jsdoc 44.2.4 → 44.2.5

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 (67) hide show
  1. package/dist/WarnSettings.js +0 -1
  2. package/dist/WarnSettings.js.map +1 -1
  3. package/dist/alignTransform.js +1 -1
  4. package/dist/alignTransform.js.map +1 -1
  5. package/dist/bin/generateRule.js +4 -3
  6. package/dist/bin/generateRule.js.map +1 -1
  7. package/dist/exportParser.js +206 -135
  8. package/dist/exportParser.js.map +1 -1
  9. package/dist/generateRule.js +4 -3
  10. package/dist/generateRule.js.map +1 -1
  11. package/dist/iterateJsdoc.js +21 -48
  12. package/dist/iterateJsdoc.js.map +1 -1
  13. package/dist/jsdocUtils.js +126 -92
  14. package/dist/jsdocUtils.js.map +1 -1
  15. package/dist/rules/checkExamples.js +3 -3
  16. package/dist/rules/checkExamples.js.map +1 -1
  17. package/dist/rules/checkIndentation.js +1 -1
  18. package/dist/rules/checkIndentation.js.map +1 -1
  19. package/dist/rules/checkLineAlignment.js +3 -3
  20. package/dist/rules/checkLineAlignment.js.map +1 -1
  21. package/dist/rules/checkParamNames.js +17 -4
  22. package/dist/rules/checkParamNames.js.map +1 -1
  23. package/dist/rules/checkTagNames.js +2 -6
  24. package/dist/rules/checkTagNames.js.map +1 -1
  25. package/dist/rules/checkTypes.js +1 -5
  26. package/dist/rules/checkTypes.js.map +1 -1
  27. package/dist/rules/checkValues.js +1 -1
  28. package/dist/rules/checkValues.js.map +1 -1
  29. package/dist/rules/informativeDocs.js +1 -1
  30. package/dist/rules/informativeDocs.js.map +1 -1
  31. package/dist/rules/noBadBlocks.js +1 -1
  32. package/dist/rules/noBadBlocks.js.map +1 -1
  33. package/dist/rules/noMissingSyntax.js +3 -9
  34. package/dist/rules/noMissingSyntax.js.map +1 -1
  35. package/dist/rules/noRestrictedSyntax.js +3 -9
  36. package/dist/rules/noRestrictedSyntax.js.map +1 -1
  37. package/dist/rules/noUndefinedTypes.js +5 -8
  38. package/dist/rules/noUndefinedTypes.js.map +1 -1
  39. package/dist/rules/requireDescriptionCompleteSentence.js +3 -3
  40. package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -1
  41. package/dist/rules/requireHyphenBeforeParamDescription.js +3 -6
  42. package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -1
  43. package/dist/rules/requireJsdoc.js +12 -7
  44. package/dist/rules/requireJsdoc.js.map +1 -1
  45. package/dist/rules/requireParam.js +83 -21
  46. package/dist/rules/requireParam.js.map +1 -1
  47. package/dist/rules/requireReturns.js +0 -1
  48. package/dist/rules/requireReturns.js.map +1 -1
  49. package/dist/rules/requireThrows.js +0 -1
  50. package/dist/rules/requireThrows.js.map +1 -1
  51. package/dist/rules/requireYields.js +0 -1
  52. package/dist/rules/requireYields.js.map +1 -1
  53. package/dist/rules/sortTags.js +1 -1
  54. package/dist/rules/sortTags.js.map +1 -1
  55. package/dist/rules/textEscaping.js +2 -2
  56. package/dist/rules/textEscaping.js.map +1 -1
  57. package/dist/rules/validTypes.js +1 -1
  58. package/dist/rules/validTypes.js.map +1 -1
  59. package/dist/tagNames.js +0 -2
  60. package/dist/tagNames.js.map +1 -1
  61. package/dist/utils/hasReturnValue.js +0 -5
  62. package/dist/utils/hasReturnValue.js.map +1 -1
  63. package/docs/rules/check-line-alignment.md +7 -0
  64. package/docs/rules/no-undefined-types.md +6 -0
  65. package/docs/rules/require-param.md +4 -0
  66. package/docs/settings.md +2 -0
  67. package/package.json +9 -9
package/docs/rules/require-param.md CHANGED
@@ -1812,5 +1812,9 @@ function foo(this: T, bar: number): number {
1812
1812
  console.log(this.name);
1813
1813
  return bar;
1814
1814
  }
1815
+
1816
+ /** {@link someOtherval} */
1817
+ function a (b) {}
1818
+ // "jsdoc/require-param": ["error"|"warn", {"contexts":[{"comment":"*:not(JsdocBlock:has(JsdocInlineTag[tag=link]))","context":"FunctionDeclaration"}]}]
1815
1819
  ````
1816
1820
 
package/docs/settings.md CHANGED
@@ -327,6 +327,8 @@ values are objects with the following optional properties:
327
327
  checked to ensure it is a valid namepath. You might use this to ensure
328
328
  that tags which normally allow free text, e.g., `@see` will instead
329
329
  require a namepath.
330
+ - `"namepath-or-url-referencing"` - For inline tags which may point to
331
+ a namepath or URL.
330
332
  - `false` - This will disallow any text in the name position.
331
333
  - `type`:
332
334
  - `true` - Allows valid types within brackets. This is the default.
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "url": "http://gajus.com"
6
6
  },
7
7
  "dependencies": {
8
- "@es-joy/jsdoccomment": "~0.39.3",
8
+ "@es-joy/jsdoccomment": "~0.39.4",
9
9
  "are-docs-informative": "^0.0.2",
10
10
  "comment-parser": "1.3.1",
11
11
  "debug": "^4.3.4",
@@ -32,24 +32,24 @@
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
+ "@types/esquery": "^1.5.0",
36
36
  "@types/estree": "^1.0.1",
37
37
  "@types/lodash.defaultsdeep": "^4.6.7",
38
38
  "@types/mocha": "^10.0.1",
39
- "@types/node": "^20.1.4",
39
+ "@types/node": "^20.2.3",
40
40
  "@types/semver": "^7.5.0",
41
41
  "@types/spdx-expression-parse": "^3.0.2",
42
- "@typescript-eslint/parser": "^5.59.5",
42
+ "@typescript-eslint/parser": "^5.59.6",
43
43
  "babel-plugin-add-module-exports": "^1.0.4",
44
44
  "babel-plugin-istanbul": "^6.1.1",
45
45
  "camelcase": "^6.3.0",
46
46
  "chai": "^4.3.7",
47
47
  "cross-env": "^7.0.3",
48
48
  "decamelize": "^5.0.1",
49
- "eslint": "8.39.0",
50
- "eslint-config-canonical": "~33.0.1",
49
+ "eslint": "8.41.0",
50
+ "eslint-config-canonical": "~41.0.4",
51
51
  "gitdown": "^3.1.5",
52
- "glob": "^10.2.3",
52
+ "glob": "^10.2.6",
53
53
  "husky": "^8.0.3",
54
54
  "jsdoc-type-pratt-parser": "^4.0.0",
55
55
  "lint-staged": "^13.2.2",
@@ -57,7 +57,7 @@
57
57
  "mocha": "^10.2.0",
58
58
  "nyc": "^15.1.0",
59
59
  "open-editor": "^3.0.0",
60
- "rimraf": "^5.0.0",
60
+ "rimraf": "^5.0.1",
61
61
  "semantic-release": "^21.0.2",
62
62
  "typescript": "^5.0.4"
63
63
  },
@@ -132,5 +132,5 @@
132
132
  "test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
133
133
  "test-index": "npm run test-no-cov -- test/rules/index.js"
134
134
  },
135
- "version": "44.2.4"
135
+ "version": "44.2.5"
136
136
  }