eslint-plugin-jsdoc 63.0.11 → 63.0.12

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 (171) hide show
  1. package/dist/WarnSettings.cjs +8 -1
  2. package/dist/WarnSettings.cjs.map +1 -1
  3. package/dist/alignTransform.cjs +10 -6
  4. package/dist/alignTransform.cjs.map +1 -1
  5. package/dist/buildForbidRuleDefinition.cjs +10 -3
  6. package/dist/buildForbidRuleDefinition.cjs.map +1 -1
  7. package/dist/buildRejectOrPreferRuleDefinition.cjs +14 -7
  8. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -1
  9. package/dist/defaultTagOrder.cjs +8 -1
  10. package/dist/defaultTagOrder.cjs.map +1 -1
  11. package/dist/exportParser.cjs +14 -6
  12. package/dist/exportParser.cjs.map +1 -1
  13. package/dist/generateDocs.cjs +44 -36
  14. package/dist/generateDocs.cjs.map +1 -1
  15. package/dist/generateOptions.cjs +18 -15
  16. package/dist/generateOptions.cjs.map +1 -1
  17. package/dist/generateRule.cjs +24 -24
  18. package/dist/generateRule.cjs.map +1 -1
  19. package/dist/generateRuleTypes.cjs +9 -6
  20. package/dist/generateRuleTypes.cjs.map +1 -1
  21. package/dist/getDefaultTagStructureForMode.cjs +8 -1
  22. package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
  23. package/dist/getJsdocProcessorPlugin.cjs +28 -20
  24. package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
  25. package/dist/index-cjs.cjs +159 -152
  26. package/dist/index-cjs.cjs.map +1 -1
  27. package/dist/index-esm.cjs +27 -16
  28. package/dist/index-esm.cjs.map +1 -1
  29. package/dist/index.cjs +172 -159
  30. package/dist/index.cjs.map +1 -1
  31. package/dist/iterateJsdoc.cjs +32 -22
  32. package/dist/iterateJsdoc.cjs.map +1 -1
  33. package/dist/jsdocUtils.cjs +86 -18
  34. package/dist/jsdocUtils.cjs.map +1 -1
  35. package/dist/rules/checkAccess.cjs +10 -2
  36. package/dist/rules/checkAccess.cjs.map +1 -1
  37. package/dist/rules/checkAlignment.cjs +10 -2
  38. package/dist/rules/checkAlignment.cjs.map +1 -1
  39. package/dist/rules/checkExamples.cjs +15 -6
  40. package/dist/rules/checkExamples.cjs.map +1 -1
  41. package/dist/rules/checkIndentation.cjs +9 -2
  42. package/dist/rules/checkIndentation.cjs.map +1 -1
  43. package/dist/rules/checkLineAlignment.cjs +14 -6
  44. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  45. package/dist/rules/checkParamNames.cjs +9 -2
  46. package/dist/rules/checkParamNames.cjs.map +1 -1
  47. package/dist/rules/checkPropertyNames.cjs +9 -2
  48. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  49. package/dist/rules/checkSyntax.cjs +10 -2
  50. package/dist/rules/checkSyntax.cjs.map +1 -1
  51. package/dist/rules/checkTagNames.cjs +11 -4
  52. package/dist/rules/checkTagNames.cjs.map +1 -1
  53. package/dist/rules/checkTemplateNames.cjs +20 -12
  54. package/dist/rules/checkTemplateNames.cjs.map +1 -1
  55. package/dist/rules/checkTypes.cjs +10 -4
  56. package/dist/rules/checkTypes.cjs.map +1 -1
  57. package/dist/rules/checkValues.cjs +17 -9
  58. package/dist/rules/checkValues.cjs.map +1 -1
  59. package/dist/rules/convertToJsdocComments.cjs +19 -13
  60. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  61. package/dist/rules/emptyTags.cjs +10 -2
  62. package/dist/rules/emptyTags.cjs.map +1 -1
  63. package/dist/rules/escapeInlineTags.cjs +10 -2
  64. package/dist/rules/escapeInlineTags.cjs.map +1 -1
  65. package/dist/rules/implementsOnClasses.cjs +10 -2
  66. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  67. package/dist/rules/importsAsDependencies.cjs +20 -12
  68. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  69. package/dist/rules/informativeDocs.cjs +12 -4
  70. package/dist/rules/informativeDocs.cjs.map +1 -1
  71. package/dist/rules/linesBeforeBlock.cjs +9 -2
  72. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  73. package/dist/rules/matchDescription.cjs +9 -2
  74. package/dist/rules/matchDescription.cjs.map +1 -1
  75. package/dist/rules/matchName.cjs +10 -2
  76. package/dist/rules/matchName.cjs.map +1 -1
  77. package/dist/rules/multilineBlocks.cjs +9 -2
  78. package/dist/rules/multilineBlocks.cjs.map +1 -1
  79. package/dist/rules/noBadBlocks.cjs +11 -4
  80. package/dist/rules/noBadBlocks.cjs.map +1 -1
  81. package/dist/rules/noBlankBlockDescriptions.cjs +10 -2
  82. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  83. package/dist/rules/noBlankBlocks.cjs +10 -2
  84. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  85. package/dist/rules/noDefaults.cjs +10 -2
  86. package/dist/rules/noDefaults.cjs.map +1 -1
  87. package/dist/rules/noMissingSyntax.cjs +9 -2
  88. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  89. package/dist/rules/noMultiAsterisks.cjs +10 -2
  90. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  91. package/dist/rules/noRestrictedSyntax.cjs +9 -2
  92. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  93. package/dist/rules/noTypes.cjs +9 -2
  94. package/dist/rules/noTypes.cjs.map +1 -1
  95. package/dist/rules/noUndefinedTypes.cjs +21 -13
  96. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  97. package/dist/rules/preferImportTag.cjs +28 -21
  98. package/dist/rules/preferImportTag.cjs.map +1 -1
  99. package/dist/rules/requireAsteriskPrefix.cjs +10 -2
  100. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  101. package/dist/rules/requireDescription.cjs +9 -2
  102. package/dist/rules/requireDescription.cjs.map +1 -1
  103. package/dist/rules/requireDescriptionCompleteSentence.cjs +15 -7
  104. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  105. package/dist/rules/requireExample.cjs +10 -2
  106. package/dist/rules/requireExample.cjs.map +1 -1
  107. package/dist/rules/requireFileOverview.cjs +10 -2
  108. package/dist/rules/requireFileOverview.cjs.map +1 -1
  109. package/dist/rules/requireHyphenBeforeParamDescription.cjs +10 -2
  110. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  111. package/dist/rules/requireJsdoc.cjs +24 -17
  112. package/dist/rules/requireJsdoc.cjs.map +1 -1
  113. package/dist/rules/requireParam.cjs +9 -2
  114. package/dist/rules/requireParam.cjs.map +1 -1
  115. package/dist/rules/requireParamDescription.cjs +10 -2
  116. package/dist/rules/requireParamDescription.cjs.map +1 -1
  117. package/dist/rules/requireParamName.cjs +10 -2
  118. package/dist/rules/requireParamName.cjs.map +1 -1
  119. package/dist/rules/requireParamType.cjs +10 -2
  120. package/dist/rules/requireParamType.cjs.map +1 -1
  121. package/dist/rules/requireProperty.cjs +10 -2
  122. package/dist/rules/requireProperty.cjs.map +1 -1
  123. package/dist/rules/requirePropertyDescription.cjs +10 -2
  124. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  125. package/dist/rules/requirePropertyName.cjs +10 -2
  126. package/dist/rules/requirePropertyName.cjs.map +1 -1
  127. package/dist/rules/requirePropertyType.cjs +10 -2
  128. package/dist/rules/requirePropertyType.cjs.map +1 -1
  129. package/dist/rules/requireRejects.cjs +9 -2
  130. package/dist/rules/requireRejects.cjs.map +1 -1
  131. package/dist/rules/requireReturns.cjs +11 -4
  132. package/dist/rules/requireReturns.cjs.map +1 -1
  133. package/dist/rules/requireReturnsCheck.cjs +15 -8
  134. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  135. package/dist/rules/requireReturnsDescription.cjs +10 -2
  136. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  137. package/dist/rules/requireReturnsType.cjs +10 -2
  138. package/dist/rules/requireReturnsType.cjs.map +1 -1
  139. package/dist/rules/requireTags.cjs +9 -2
  140. package/dist/rules/requireTags.cjs.map +1 -1
  141. package/dist/rules/requireTemplate.cjs +13 -5
  142. package/dist/rules/requireTemplate.cjs.map +1 -1
  143. package/dist/rules/requireThrows.cjs +9 -2
  144. package/dist/rules/requireThrows.cjs.map +1 -1
  145. package/dist/rules/requireYields.cjs +9 -2
  146. package/dist/rules/requireYields.cjs.map +1 -1
  147. package/dist/rules/requireYieldsCheck.cjs +9 -2
  148. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  149. package/dist/rules/sortTags.cjs +12 -4
  150. package/dist/rules/sortTags.cjs.map +1 -1
  151. package/dist/rules/tagLines.cjs +9 -2
  152. package/dist/rules/tagLines.cjs.map +1 -1
  153. package/dist/rules/textEscaping.cjs +9 -2
  154. package/dist/rules/textEscaping.cjs.map +1 -1
  155. package/dist/rules/tsMethodSignatureStyle.cjs +18 -10
  156. package/dist/rules/tsMethodSignatureStyle.cjs.map +1 -1
  157. package/dist/rules/tsNoEmptyObjectType.cjs +13 -5
  158. package/dist/rules/tsNoEmptyObjectType.cjs.map +1 -1
  159. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +16 -8
  160. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +1 -1
  161. package/dist/rules/tsPreferFunctionType.cjs +16 -8
  162. package/dist/rules/tsPreferFunctionType.cjs.map +1 -1
  163. package/dist/rules/typeFormatting.cjs +17 -9
  164. package/dist/rules/typeFormatting.cjs.map +1 -1
  165. package/dist/rules/validTypes.cjs +18 -10
  166. package/dist/rules/validTypes.cjs.map +1 -1
  167. package/dist/tagNames.cjs +9 -4
  168. package/dist/tagNames.cjs.map +1 -1
  169. package/dist/utils/hasReturnValue.cjs +8 -1
  170. package/dist/utils/hasReturnValue.cjs.map +1 -1
  171. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -1,77 +1,91 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ Object.defineProperty(exports, "getJsdocProcessorPlugin", {
8
+ enumerable: true,
9
+ get: function () {
10
+ return _getJsdocProcessorPlugin.getJsdocProcessorPlugin;
11
+ }
12
+ });
13
+ exports.jsdoc = void 0;
14
+ var _objectDeepMerge = require("object-deep-merge");
15
+ var _buildForbidRuleDefinition = require("./buildForbidRuleDefinition.cjs");
16
+ var _buildRejectOrPreferRuleDefinition = require("./buildRejectOrPreferRuleDefinition.cjs");
17
+ var _getJsdocProcessorPlugin = require("./getJsdocProcessorPlugin.cjs");
18
+ var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.cjs"));
19
+ var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.cjs"));
20
+ var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.cjs"));
21
+ var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.cjs"));
22
+ var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.cjs"));
23
+ var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.cjs"));
24
+ var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.cjs"));
25
+ var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.cjs"));
26
+ var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.cjs"));
27
+ var _checkTemplateNames = _interopRequireDefault(require("./rules/checkTemplateNames.cjs"));
28
+ var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.cjs"));
29
+ var _checkValues = _interopRequireDefault(require("./rules/checkValues.cjs"));
30
+ var _convertToJsdocComments = _interopRequireDefault(require("./rules/convertToJsdocComments.cjs"));
31
+ var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.cjs"));
32
+ var _escapeInlineTags = _interopRequireDefault(require("./rules/escapeInlineTags.cjs"));
33
+ var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.cjs"));
34
+ var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.cjs"));
35
+ var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.cjs"));
36
+ var _linesBeforeBlock = _interopRequireDefault(require("./rules/linesBeforeBlock.cjs"));
37
+ var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.cjs"));
38
+ var _matchName = _interopRequireDefault(require("./rules/matchName.cjs"));
39
+ var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.cjs"));
40
+ var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.cjs"));
41
+ var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.cjs"));
42
+ var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.cjs"));
43
+ var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.cjs"));
44
+ var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.cjs"));
45
+ var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.cjs"));
46
+ var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.cjs"));
47
+ var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
48
+ var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
49
+ var _preferImportTag = _interopRequireDefault(require("./rules/preferImportTag.cjs"));
50
+ var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
51
+ var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
52
+ var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
53
+ var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
54
+ var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
55
+ var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
56
+ var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
57
+ var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
58
+ var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
59
+ var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
60
+ var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
61
+ var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
62
+ var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
63
+ var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
64
+ var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
65
+ var _requireRejects = _interopRequireDefault(require("./rules/requireRejects.cjs"));
66
+ var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
67
+ var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
68
+ var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
69
+ var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
70
+ var _requireTags = _interopRequireDefault(require("./rules/requireTags.cjs"));
71
+ var _requireTemplate = _interopRequireDefault(require("./rules/requireTemplate.cjs"));
72
+ var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
73
+ var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
74
+ var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
75
+ var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
76
+ var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
77
+ var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
78
+ var _tsMethodSignatureStyle = _interopRequireDefault(require("./rules/tsMethodSignatureStyle.cjs"));
79
+ var _tsNoEmptyObjectType = _interopRequireDefault(require("./rules/tsNoEmptyObjectType.cjs"));
80
+ var _tsNoUnnecessaryTemplateExpression = _interopRequireDefault(require("./rules/tsNoUnnecessaryTemplateExpression.cjs"));
81
+ var _tsPreferFunctionType = _interopRequireDefault(require("./rules/tsPreferFunctionType.cjs"));
82
+ var _typeFormatting = _interopRequireDefault(require("./rules/typeFormatting.cjs"));
83
+ var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
84
+ var _eslint = require("eslint");
85
+ var _semver = _interopRequireDefault(require("semver"));
86
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
1
87
  /* AUTO-GENERATED BY build SCRIPT */
2
88
  /* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
3
- import { merge } from 'object-deep-merge';
4
- import { buildForbidRuleDefinition } from './buildForbidRuleDefinition.js';
5
- import { buildRejectOrPreferRuleDefinition } from './buildRejectOrPreferRuleDefinition.js';
6
- import { getJsdocProcessorPlugin } from './getJsdocProcessorPlugin.js';
7
- import checkAccess from './rules/checkAccess.js';
8
- import checkAlignment from './rules/checkAlignment.js';
9
- import checkExamples from './rules/checkExamples.js';
10
- import checkIndentation from './rules/checkIndentation.js';
11
- import checkLineAlignment from './rules/checkLineAlignment.js';
12
- import checkParamNames from './rules/checkParamNames.js';
13
- import checkPropertyNames from './rules/checkPropertyNames.js';
14
- import checkSyntax from './rules/checkSyntax.js';
15
- import checkTagNames from './rules/checkTagNames.js';
16
- import checkTemplateNames from './rules/checkTemplateNames.js';
17
- import checkTypes from './rules/checkTypes.js';
18
- import checkValues from './rules/checkValues.js';
19
- import convertToJsdocComments from './rules/convertToJsdocComments.js';
20
- import emptyTags from './rules/emptyTags.js';
21
- import escapeInlineTags from './rules/escapeInlineTags.js';
22
- import implementsOnClasses from './rules/implementsOnClasses.js';
23
- import importsAsDependencies from './rules/importsAsDependencies.js';
24
- import informativeDocs from './rules/informativeDocs.js';
25
- import linesBeforeBlock from './rules/linesBeforeBlock.js';
26
- import matchDescription from './rules/matchDescription.js';
27
- import matchName from './rules/matchName.js';
28
- import multilineBlocks from './rules/multilineBlocks.js';
29
- import noBadBlocks from './rules/noBadBlocks.js';
30
- import noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';
31
- import noBlankBlocks from './rules/noBlankBlocks.js';
32
- import noDefaults from './rules/noDefaults.js';
33
- import noMissingSyntax from './rules/noMissingSyntax.js';
34
- import noMultiAsterisks from './rules/noMultiAsterisks.js';
35
- import noRestrictedSyntax from './rules/noRestrictedSyntax.js';
36
- import noTypes from './rules/noTypes.js';
37
- import noUndefinedTypes from './rules/noUndefinedTypes.js';
38
- import preferImportTag from './rules/preferImportTag.js';
39
- import requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';
40
- import requireDescription from './rules/requireDescription.js';
41
- import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';
42
- import requireExample from './rules/requireExample.js';
43
- import requireFileOverview from './rules/requireFileOverview.js';
44
- import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';
45
- import requireJsdoc from './rules/requireJsdoc.js';
46
- import requireParam from './rules/requireParam.js';
47
- import requireParamDescription from './rules/requireParamDescription.js';
48
- import requireParamName from './rules/requireParamName.js';
49
- import requireParamType from './rules/requireParamType.js';
50
- import requireProperty from './rules/requireProperty.js';
51
- import requirePropertyDescription from './rules/requirePropertyDescription.js';
52
- import requirePropertyName from './rules/requirePropertyName.js';
53
- import requirePropertyType from './rules/requirePropertyType.js';
54
- import requireRejects from './rules/requireRejects.js';
55
- import requireReturns from './rules/requireReturns.js';
56
- import requireReturnsCheck from './rules/requireReturnsCheck.js';
57
- import requireReturnsDescription from './rules/requireReturnsDescription.js';
58
- import requireReturnsType from './rules/requireReturnsType.js';
59
- import requireTags from './rules/requireTags.js';
60
- import requireTemplate from './rules/requireTemplate.js';
61
- import requireThrows from './rules/requireThrows.js';
62
- import requireYields from './rules/requireYields.js';
63
- import requireYieldsCheck from './rules/requireYieldsCheck.js';
64
- import sortTags from './rules/sortTags.js';
65
- import tagLines from './rules/tagLines.js';
66
- import textEscaping from './rules/textEscaping.js';
67
- import tsMethodSignatureStyle from './rules/tsMethodSignatureStyle.js';
68
- import tsNoEmptyObjectType from './rules/tsNoEmptyObjectType.js';
69
- import tsNoUnnecessaryTemplateExpression from './rules/tsNoUnnecessaryTemplateExpression.js';
70
- import tsPreferFunctionType from './rules/tsPreferFunctionType.js';
71
- import typeFormatting from './rules/typeFormatting.js';
72
- import validTypes from './rules/validTypes.js';
73
- import { ESLint } from 'eslint';
74
- import semver from 'semver';
75
89
 
76
90
  /**
77
91
  * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
@@ -92,39 +106,39 @@ import semver from 'semver';
92
106
  const index = {};
93
107
  index.configs = {};
94
108
  index.rules = {
95
- 'check-access': checkAccess,
96
- 'check-alignment': checkAlignment,
97
- 'check-examples': checkExamples,
98
- 'check-indentation': checkIndentation,
99
- 'check-line-alignment': checkLineAlignment,
100
- 'check-param-names': checkParamNames,
101
- 'check-property-names': checkPropertyNames,
102
- 'check-syntax': checkSyntax,
103
- 'check-tag-names': checkTagNames,
104
- 'check-template-names': checkTemplateNames,
105
- 'check-types': checkTypes,
106
- 'check-values': checkValues,
107
- 'convert-to-jsdoc-comments': convertToJsdocComments,
108
- 'empty-tags': emptyTags,
109
- 'escape-inline-tags': escapeInlineTags,
110
- 'implements-on-classes': implementsOnClasses,
111
- 'imports-as-dependencies': importsAsDependencies,
112
- 'informative-docs': informativeDocs,
113
- 'lines-before-block': linesBeforeBlock,
114
- 'match-description': matchDescription,
115
- 'match-name': matchName,
116
- 'multiline-blocks': multilineBlocks,
117
- 'no-bad-blocks': noBadBlocks,
118
- 'no-blank-block-descriptions': noBlankBlockDescriptions,
119
- 'no-blank-blocks': noBlankBlocks,
120
- 'no-defaults': noDefaults,
121
- 'no-missing-syntax': noMissingSyntax,
122
- 'no-multi-asterisks': noMultiAsterisks,
123
- 'no-restricted-syntax': noRestrictedSyntax,
124
- 'no-types': noTypes,
125
- 'no-undefined-types': noUndefinedTypes,
126
- 'prefer-import-tag': preferImportTag,
127
- 'reject-any-type': buildRejectOrPreferRuleDefinition({
109
+ 'check-access': _checkAccess.default,
110
+ 'check-alignment': _checkAlignment.default,
111
+ 'check-examples': _checkExamples.default,
112
+ 'check-indentation': _checkIndentation.default,
113
+ 'check-line-alignment': _checkLineAlignment.default,
114
+ 'check-param-names': _checkParamNames.default,
115
+ 'check-property-names': _checkPropertyNames.default,
116
+ 'check-syntax': _checkSyntax.default,
117
+ 'check-tag-names': _checkTagNames.default,
118
+ 'check-template-names': _checkTemplateNames.default,
119
+ 'check-types': _checkTypes.default,
120
+ 'check-values': _checkValues.default,
121
+ 'convert-to-jsdoc-comments': _convertToJsdocComments.default,
122
+ 'empty-tags': _emptyTags.default,
123
+ 'escape-inline-tags': _escapeInlineTags.default,
124
+ 'implements-on-classes': _implementsOnClasses.default,
125
+ 'imports-as-dependencies': _importsAsDependencies.default,
126
+ 'informative-docs': _informativeDocs.default,
127
+ 'lines-before-block': _linesBeforeBlock.default,
128
+ 'match-description': _matchDescription.default,
129
+ 'match-name': _matchName.default,
130
+ 'multiline-blocks': _multilineBlocks.default,
131
+ 'no-bad-blocks': _noBadBlocks.default,
132
+ 'no-blank-block-descriptions': _noBlankBlockDescriptions.default,
133
+ 'no-blank-blocks': _noBlankBlocks.default,
134
+ 'no-defaults': _noDefaults.default,
135
+ 'no-missing-syntax': _noMissingSyntax.default,
136
+ 'no-multi-asterisks': _noMultiAsterisks.default,
137
+ 'no-restricted-syntax': _noRestrictedSyntax.default,
138
+ 'no-types': _noTypes.default,
139
+ 'no-undefined-types': _noUndefinedTypes.default,
140
+ 'prefer-import-tag': _preferImportTag.default,
141
+ 'reject-any-type': (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
128
142
  description: 'Reports use of `any` or `*` type',
129
143
  overrideSettings: {
130
144
  '*': {
@@ -140,7 +154,7 @@ index.rules = {
140
154
  },
141
155
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-any-type.md#repos-sticky-header'
142
156
  }),
143
- 'reject-function-type': buildRejectOrPreferRuleDefinition({
157
+ 'reject-function-type': (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
144
158
  description: 'Reports use of `Function` type',
145
159
  overrideSettings: {
146
160
  Function: {
@@ -151,14 +165,14 @@ index.rules = {
151
165
  },
152
166
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-function-type.md#repos-sticky-header'
153
167
  }),
154
- 'require-asterisk-prefix': requireAsteriskPrefix,
155
- 'require-description': requireDescription,
156
- 'require-description-complete-sentence': requireDescriptionCompleteSentence,
157
- 'require-example': requireExample,
158
- 'require-file-overview': requireFileOverview,
159
- 'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,
160
- 'require-jsdoc': requireJsdoc,
161
- 'require-next-description': buildForbidRuleDefinition({
168
+ 'require-asterisk-prefix': _requireAsteriskPrefix.default,
169
+ 'require-description': _requireDescription.default,
170
+ 'require-description-complete-sentence': _requireDescriptionCompleteSentence.default,
171
+ 'require-example': _requireExample.default,
172
+ 'require-file-overview': _requireFileOverview.default,
173
+ 'require-hyphen-before-param-description': _requireHyphenBeforeParamDescription.default,
174
+ 'require-jsdoc': _requireJsdoc.default,
175
+ 'require-next-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
162
176
  contexts: [{
163
177
  comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]):not([description!=""]))',
164
178
  context: 'any',
@@ -167,7 +181,7 @@ index.rules = {
167
181
  description: 'Requires a description for `@next` tags',
168
182
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-description.md#repos-sticky-header'
169
183
  }),
170
- 'require-next-type': buildForbidRuleDefinition({
184
+ 'require-next-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
171
185
  contexts: [{
172
186
  comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([parsedType.type]))',
173
187
  context: 'any',
@@ -176,22 +190,22 @@ index.rules = {
176
190
  description: 'Requires a type for `@next` tags',
177
191
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header'
178
192
  }),
179
- 'require-param': requireParam,
180
- 'require-param-description': requireParamDescription,
181
- 'require-param-name': requireParamName,
182
- 'require-param-type': requireParamType,
183
- 'require-property': requireProperty,
184
- 'require-property-description': requirePropertyDescription,
185
- 'require-property-name': requirePropertyName,
186
- 'require-property-type': requirePropertyType,
187
- 'require-rejects': requireRejects,
188
- 'require-returns': requireReturns,
189
- 'require-returns-check': requireReturnsCheck,
190
- 'require-returns-description': requireReturnsDescription,
191
- 'require-returns-type': requireReturnsType,
192
- 'require-tags': requireTags,
193
- 'require-template': requireTemplate,
194
- 'require-template-description': buildForbidRuleDefinition({
193
+ 'require-param': _requireParam.default,
194
+ 'require-param-description': _requireParamDescription.default,
195
+ 'require-param-name': _requireParamName.default,
196
+ 'require-param-type': _requireParamType.default,
197
+ 'require-property': _requireProperty.default,
198
+ 'require-property-description': _requirePropertyDescription.default,
199
+ 'require-property-name': _requirePropertyName.default,
200
+ 'require-property-type': _requirePropertyType.default,
201
+ 'require-rejects': _requireRejects.default,
202
+ 'require-returns': _requireReturns.default,
203
+ 'require-returns-check': _requireReturnsCheck.default,
204
+ 'require-returns-description': _requireReturnsDescription.default,
205
+ 'require-returns-type': _requireReturnsType.default,
206
+ 'require-tags': _requireTags.default,
207
+ 'require-template': _requireTemplate.default,
208
+ 'require-template-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
195
209
  contexts: [{
196
210
  comment: 'JsdocBlock:has(JsdocTag[tag=template]:not([description!=""]))',
197
211
  context: 'any',
@@ -200,8 +214,8 @@ index.rules = {
200
214
  description: 'Requires a description for `@template` tags',
201
215
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template-description.md#repos-sticky-header'
202
216
  }),
203
- 'require-throws': requireThrows,
204
- 'require-throws-description': buildForbidRuleDefinition({
217
+ 'require-throws': _requireThrows.default,
218
+ 'require-throws-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
205
219
  contexts: [{
206
220
  comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([description!=""]))',
207
221
  context: 'any',
@@ -210,7 +224,7 @@ index.rules = {
210
224
  description: 'Requires a description for `@throws` tags',
211
225
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-description.md#repos-sticky-header'
212
226
  }),
213
- 'require-throws-type': buildForbidRuleDefinition({
227
+ 'require-throws-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
214
228
  contexts: [{
215
229
  comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([parsedType.type]))',
216
230
  context: 'any',
@@ -219,9 +233,9 @@ index.rules = {
219
233
  description: 'Requires a type for `@throws` tags',
220
234
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header'
221
235
  }),
222
- 'require-yields': requireYields,
223
- 'require-yields-check': requireYieldsCheck,
224
- 'require-yields-description': buildForbidRuleDefinition({
236
+ 'require-yields': _requireYields.default,
237
+ 'require-yields-check': _requireYieldsCheck.default,
238
+ 'require-yields-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
225
239
  contexts: [{
226
240
  comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([name!=""]):not([description!=""]))',
227
241
  context: 'any',
@@ -230,7 +244,7 @@ index.rules = {
230
244
  description: 'Requires a description for `@yields` tags',
231
245
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-description.md#repos-sticky-header'
232
246
  }),
233
- 'require-yields-type': buildForbidRuleDefinition({
247
+ 'require-yields-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
234
248
  contexts: [{
235
249
  comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([parsedType.type]))',
236
250
  context: 'any',
@@ -239,15 +253,15 @@ index.rules = {
239
253
  description: 'Requires a type for `@yields` tags',
240
254
  url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header'
241
255
  }),
242
- 'sort-tags': sortTags,
243
- 'tag-lines': tagLines,
244
- 'text-escaping': textEscaping,
245
- 'ts-method-signature-style': tsMethodSignatureStyle,
246
- 'ts-no-empty-object-type': tsNoEmptyObjectType,
247
- 'ts-no-unnecessary-template-expression': tsNoUnnecessaryTemplateExpression,
248
- 'ts-prefer-function-type': tsPreferFunctionType,
249
- 'type-formatting': typeFormatting,
250
- 'valid-types': validTypes
256
+ 'sort-tags': _sortTags.default,
257
+ 'tag-lines': _tagLines.default,
258
+ 'text-escaping': _textEscaping.default,
259
+ 'ts-method-signature-style': _tsMethodSignatureStyle.default,
260
+ 'ts-no-empty-object-type': _tsNoEmptyObjectType.default,
261
+ 'ts-no-unnecessary-template-expression': _tsNoUnnecessaryTemplateExpression.default,
262
+ 'ts-prefer-function-type': _tsPreferFunctionType.default,
263
+ 'type-formatting': _typeFormatting.default,
264
+ 'valid-types': _validTypes.default
251
265
  };
252
266
 
253
267
  /**
@@ -483,7 +497,7 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */[{
483
497
  files: ['**/*.js'],
484
498
  name: 'jsdoc/examples/processor',
485
499
  plugins: {
486
- examples: getJsdocProcessorPlugin()
500
+ examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)()
487
501
  },
488
502
  processor: 'examples/examples'
489
503
  }, {
@@ -511,7 +525,7 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */[{
511
525
  // Unlikely to have inadvertent debugging within examples
512
526
  'no-console': 0,
513
527
  /* c8 ignore next 11 -- Coercion should work */
514
- ...(semver.gte(semver.coerce(ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
528
+ ...(_semver.default.gte(_semver.default.coerce(_eslint.ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
515
529
  // "always" newline rule at end unlikely in sample code
516
530
  'eol-last': 0,
517
531
  // Often wish to start `@example` code after newline; also may use
@@ -533,7 +547,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
533
547
  files: ['**/*.js'],
534
548
  name: 'jsdoc/default-expressions/processor',
535
549
  plugins: {
536
- examples: getJsdocProcessorPlugin({
550
+ examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
537
551
  checkDefaults: true,
538
552
  checkParams: true,
539
553
  checkProperties: true
@@ -553,7 +567,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
553
567
  'no-new': 0,
554
568
  'no-unused-expressions': 0,
555
569
  /* c8 ignore next 8 -- Coercion should work */
556
- ...(semver.gte(semver.coerce(ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
570
+ ...(_semver.default.gte(_semver.default.coerce(_eslint.ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
557
571
  quotes: ['error', 'double'],
558
572
  semi: ['error', 'never']
559
573
  }),
@@ -563,7 +577,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
563
577
  index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.Config[]} */[{
564
578
  name: 'jsdoc/examples-and-default-expressions',
565
579
  plugins: {
566
- examples: getJsdocProcessorPlugin({
580
+ examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
567
581
  checkDefaults: true,
568
582
  checkParams: true,
569
583
  checkProperties: true
@@ -587,8 +601,7 @@ index.configs['flat/recommended-mixed'] = [{
587
601
  ...index.configs['flat/recommended-typescript'],
588
602
  files: ['**/*.{ts,tsx,cts,mts}']
589
603
  }];
590
- export default index;
591
-
604
+ var _default = exports.default = index;
592
605
  /**
593
606
  * @type {((
594
607
  * cfg?: import('eslint').Linter.Config & {
@@ -625,7 +638,7 @@ export default index;
625
638
  * }
626
639
  * ) => import('eslint').Linter.Config)}
627
640
  */
628
- export const jsdoc = function (cfg) {
641
+ const jsdoc = function (cfg) {
629
642
  /** @type {import('eslint').Linter.Config} */
630
643
  let outputConfig = {
631
644
  plugins: {
@@ -686,7 +699,7 @@ export const jsdoc = function (cfg) {
686
699
  description,
687
700
  url
688
701
  }] of Object.entries(cfg.extraRuleDefinitions.forbid)) {
689
- outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] = buildForbidRuleDefinition({
702
+ outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] = (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
690
703
  contextName,
691
704
  contexts,
692
705
  description,
@@ -700,7 +713,7 @@ export const jsdoc = function (cfg) {
700
713
  overrideSettings,
701
714
  url
702
715
  }] of Object.entries(cfg.extraRuleDefinitions.preferTypes)) {
703
- outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] = buildRejectOrPreferRuleDefinition({
716
+ outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] = (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
704
717
  description,
705
718
  overrideSettings,
706
719
  typeName,
@@ -711,7 +724,7 @@ export const jsdoc = function (cfg) {
711
724
  }
712
725
  }
713
726
  outputConfig.settings = {
714
- jsdoc: cfg?.mergeSettings === false ? cfg.settings : merge({}, cfg?.settings ?? {}, cfg?.config?.includes('recommended') ? {
727
+ jsdoc: cfg?.mergeSettings === false ? cfg.settings : (0, _objectDeepMerge.merge)({}, cfg?.settings ?? {}, cfg?.config?.includes('recommended') ? {
715
728
  // We may need to drop these for "typescript" (non-"flavor") configs,
716
729
  // if support is later added: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
717
730
  structuredTags: {
@@ -726,5 +739,5 @@ export const jsdoc = function (cfg) {
726
739
  };
727
740
  return outputConfig;
728
741
  };
729
- export { getJsdocProcessorPlugin } from './getJsdocProcessorPlugin.js';
742
+ exports.jsdoc = jsdoc;
730
743
  //# sourceMappingURL=index.cjs.map