eslint-plugin-jsdoc 55.1.0 → 55.1.2

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 (82) hide show
  1. package/dist/WarnSettings.d.ts +17 -0
  2. package/dist/alignTransform.d.ts +34 -0
  3. package/dist/defaultTagOrder.d.ts +5 -0
  4. package/dist/exportParser.d.ts +41 -0
  5. package/dist/getDefaultTagStructureForMode.d.ts +11 -0
  6. package/dist/index-cjs.d.ts +17 -0
  7. package/dist/index-esm.cjs +1 -1
  8. package/dist/index-esm.cjs.map +1 -1
  9. package/dist/index-esm.d.ts +19 -0
  10. package/dist/index.cjs +1 -1
  11. package/dist/index.cjs.map +1 -1
  12. package/dist/index.d.ts +2 -2
  13. package/dist/jsdocUtils.d.ts +455 -0
  14. package/dist/rules/checkAccess.d.ts +3 -0
  15. package/dist/rules/checkAlignment.d.ts +3 -0
  16. package/dist/rules/checkExamples.d.ts +4 -0
  17. package/dist/rules/checkIndentation.d.ts +3 -0
  18. package/dist/rules/checkLineAlignment.d.ts +10 -0
  19. package/dist/rules/checkParamNames.d.ts +3 -0
  20. package/dist/rules/checkPropertyNames.d.ts +3 -0
  21. package/dist/rules/checkSyntax.d.ts +3 -0
  22. package/dist/rules/checkTagNames.d.ts +3 -0
  23. package/dist/rules/checkTemplateNames.d.ts +3 -0
  24. package/dist/rules/checkTypes.d.ts +3 -0
  25. package/dist/rules/checkValues.d.ts +3 -0
  26. package/dist/rules/convertToJsdocComments.d.ts +252 -0
  27. package/dist/rules/emptyTags.d.ts +3 -0
  28. package/dist/rules/implementsOnClasses.d.ts +3 -0
  29. package/dist/rules/importsAsDependencies.d.ts +3 -0
  30. package/dist/rules/informativeDocs.d.ts +3 -0
  31. package/dist/rules/linesBeforeBlock.d.ts +3 -0
  32. package/dist/rules/matchDescription.d.ts +3 -0
  33. package/dist/rules/matchName.d.ts +3 -0
  34. package/dist/rules/multilineBlocks.d.ts +3 -0
  35. package/dist/rules/noBadBlocks.d.ts +3 -0
  36. package/dist/rules/noBlankBlockDescriptions.d.ts +3 -0
  37. package/dist/rules/noBlankBlocks.d.ts +3 -0
  38. package/dist/rules/noDefaults.d.ts +3 -0
  39. package/dist/rules/noMissingSyntax.d.ts +10 -0
  40. package/dist/rules/noMultiAsterisks.d.ts +3 -0
  41. package/dist/rules/noRestrictedSyntax.d.ts +3 -0
  42. package/dist/rules/noTypes.d.ts +3 -0
  43. package/dist/rules/noUndefinedTypes.d.ts +3 -0
  44. package/dist/rules/requireAsteriskPrefix.d.ts +3 -0
  45. package/dist/rules/requireDescription.d.ts +3 -0
  46. package/dist/rules/requireDescriptionCompleteSentence.d.ts +3 -0
  47. package/dist/rules/requireExample.d.ts +3 -0
  48. package/dist/rules/requireFileOverview.d.ts +3 -0
  49. package/dist/rules/requireHyphenBeforeParamDescription.d.ts +3 -0
  50. package/dist/rules/requireJsdoc.d.ts +26 -0
  51. package/dist/rules/requireParam.d.ts +4 -0
  52. package/dist/rules/requireParamDescription.d.ts +3 -0
  53. package/dist/rules/requireParamName.d.ts +3 -0
  54. package/dist/rules/requireParamType.d.ts +3 -0
  55. package/dist/rules/requireProperty.d.ts +3 -0
  56. package/dist/rules/requirePropertyDescription.d.ts +3 -0
  57. package/dist/rules/requirePropertyName.d.ts +3 -0
  58. package/dist/rules/requirePropertyType.d.ts +3 -0
  59. package/dist/rules/requireReturns.d.ts +3 -0
  60. package/dist/rules/requireReturnsCheck.d.ts +3 -0
  61. package/dist/rules/requireReturnsDescription.d.ts +3 -0
  62. package/dist/rules/requireReturnsType.d.ts +3 -0
  63. package/dist/rules/requireTemplate.d.ts +3 -0
  64. package/dist/rules/requireThrows.d.ts +3 -0
  65. package/dist/rules/requireYields.d.ts +3 -0
  66. package/dist/rules/requireYieldsCheck.d.ts +3 -0
  67. package/dist/rules/sortTags.d.ts +3 -0
  68. package/dist/rules/tagLines.d.ts +3 -0
  69. package/dist/rules/textEscaping.d.ts +3 -0
  70. package/dist/rules/validTypes.d.ts +3 -0
  71. package/dist/rules.d.ts +766 -0
  72. package/dist/tagNames.d.ts +16 -0
  73. package/dist/utils/hasReturnValue.d.ts +20 -0
  74. package/package.json +1 -1
  75. package/src/index-esm.js +1 -1
  76. package/src/index.js +1 -1
  77. package/src/rules.d.ts +766 -0
  78. package/typings/babel__eslint-parser.d.ts +1 -0
  79. package/typings/gitdown.d.ts +12 -0
  80. package/dist/getJsdocProcessorPlugin.d.ts.map +0 -1
  81. package/dist/index.d.ts.map +0 -1
  82. package/dist/iterateJsdoc.d.ts.map +0 -1
@@ -0,0 +1,16 @@
1
+ export type AliasedTags = {
2
+ [key: string]: string[];
3
+ };
4
+ /**
5
+ * @type {AliasedTags}
6
+ */
7
+ export const closureTags: AliasedTags;
8
+ /**
9
+ * @type {AliasedTags}
10
+ */
11
+ export const jsdocTags: AliasedTags;
12
+ /**
13
+ * @type {AliasedTags}
14
+ */
15
+ export const typeScriptTags: AliasedTags;
16
+ //# sourceMappingURL=tagNames.d.ts.map
@@ -0,0 +1,20 @@
1
+ export type ESTreeOrTypeScriptNode = import("estree").Node | import("@typescript-eslint/types").TSESTree.Node;
2
+ export type PromiseFilter = (node: ESTreeOrTypeScriptNode | undefined) => boolean;
3
+ /**
4
+ * Checks if a node has a return statement. Void return does not count.
5
+ * @param {ESTreeOrTypeScriptNode|undefined|null} node
6
+ * @param {boolean} [throwOnNullReturn]
7
+ * @param {PromiseFilter} [promFilter]
8
+ * @returns {boolean|undefined}
9
+ */
10
+ export function hasReturnValue(node: ESTreeOrTypeScriptNode | undefined | null, throwOnNullReturn?: boolean, promFilter?: PromiseFilter): boolean | undefined;
11
+ /**
12
+ * Checks if a Promise executor has no resolve value or an empty value.
13
+ * An `undefined` resolve does not count.
14
+ * @param {ESTreeOrTypeScriptNode} node
15
+ * @param {boolean} anyPromiseAsReturn
16
+ * @param {boolean} [allBranches]
17
+ * @returns {boolean}
18
+ */
19
+ export function hasValueOrExecutorHasNonEmptyResolveValue(node: ESTreeOrTypeScriptNode, anyPromiseAsReturn: boolean, allBranches?: boolean): boolean;
20
+ //# sourceMappingURL=hasReturnValue.d.ts.map
package/package.json CHANGED
@@ -160,5 +160,5 @@
160
160
  "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
161
161
  "test-index": "pnpm run test-no-cov test/rules/index.js"
162
162
  },
163
- "version": "55.1.0"
163
+ "version": "55.1.2"
164
164
  }
package/src/index-esm.js CHANGED
@@ -17,7 +17,7 @@ export default index;
17
17
  * mergeSettings?: boolean,
18
18
  * config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
19
19
  * settings?: Partial<import('./iterateJsdoc.js').Settings>,
20
- * rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
20
+ * rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
21
21
  * }
22
22
  * ) => import('eslint').Linter.Config)}
23
23
  */
package/src/index.js CHANGED
@@ -540,7 +540,7 @@ export default index;
540
540
  * mergeSettings?: boolean,
541
541
  * config?: `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
542
542
  * settings?: Partial<import('./iterateJsdoc.js').Settings>,
543
- * rules?: {[key in keyof import('./rules.d.ts').Rules]?: ["error"|"warn"|"off", ...import('./rules.d.ts').Rules[key]]}
543
+ * rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}
544
544
  * }
545
545
  * ) => import('eslint').Linter.Config)}
546
546
  */