@depup/eslint-plugin-jsdoc 63.3.2-depup.1 → 64.0.0-depup.0

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 (272) hide show
  1. package/README.md +3 -11
  2. package/changes.json +3 -16
  3. package/dist/index.d.ts +7 -4
  4. package/package.json +29 -67
  5. package/src/index.js +7 -8
  6. package/dist/WarnSettings.cjs +0 -38
  7. package/dist/WarnSettings.cjs.map +0 -1
  8. package/dist/alignTransform.cjs +0 -402
  9. package/dist/alignTransform.cjs.map +0 -1
  10. package/dist/buildForbidRuleDefinition.cjs +0 -101
  11. package/dist/buildForbidRuleDefinition.cjs.map +0 -1
  12. package/dist/buildRejectOrPreferRuleDefinition.cjs +0 -352
  13. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +0 -1
  14. package/dist/cjs/WarnSettings.d.ts +0 -16
  15. package/dist/cjs/alignTransform.d.ts +0 -33
  16. package/dist/cjs/buildForbidRuleDefinition.d.ts +0 -14
  17. package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +0 -8
  18. package/dist/cjs/defaultTagOrder.d.ts +0 -4
  19. package/dist/cjs/exportParser.d.ts +0 -40
  20. package/dist/cjs/getDefaultTagStructureForMode.d.ts +0 -10
  21. package/dist/cjs/getJsdocProcessorPlugin.d.cts +0 -5
  22. package/dist/cjs/getJsdocProcessorPlugin.d.ts +0 -66
  23. package/dist/cjs/index-cjs.d.ts +0 -23
  24. package/dist/cjs/index.cjs.d.cts +0 -2
  25. package/dist/cjs/iterateJsdoc.d.cts +0 -7
  26. package/dist/cjs/iterateJsdoc.d.ts +0 -495
  27. package/dist/cjs/jsdocUtils.d.ts +0 -500
  28. package/dist/cjs/rules/checkAccess.d.ts +0 -2
  29. package/dist/cjs/rules/checkAlignment.d.ts +0 -2
  30. package/dist/cjs/rules/checkExamples.d.ts +0 -3
  31. package/dist/cjs/rules/checkIndentation.d.ts +0 -2
  32. package/dist/cjs/rules/checkLineAlignment.d.ts +0 -9
  33. package/dist/cjs/rules/checkParamNames.d.ts +0 -2
  34. package/dist/cjs/rules/checkPropertyNames.d.ts +0 -2
  35. package/dist/cjs/rules/checkSyntax.d.ts +0 -2
  36. package/dist/cjs/rules/checkTagNames.d.ts +0 -2
  37. package/dist/cjs/rules/checkTemplateNames.d.ts +0 -2
  38. package/dist/cjs/rules/checkTypes.d.ts +0 -7
  39. package/dist/cjs/rules/checkValues.d.ts +0 -2
  40. package/dist/cjs/rules/convertToJsdocComments.d.ts +0 -266
  41. package/dist/cjs/rules/emptyTags.d.ts +0 -2
  42. package/dist/cjs/rules/escapeInlineTags.d.ts +0 -2
  43. package/dist/cjs/rules/implementsOnClasses.d.ts +0 -2
  44. package/dist/cjs/rules/importsAsDependencies.d.ts +0 -2
  45. package/dist/cjs/rules/informativeDocs.d.ts +0 -2
  46. package/dist/cjs/rules/linesBeforeBlock.d.ts +0 -2
  47. package/dist/cjs/rules/matchDescription.d.ts +0 -2
  48. package/dist/cjs/rules/matchName.d.ts +0 -2
  49. package/dist/cjs/rules/multilineBlocks.d.ts +0 -2
  50. package/dist/cjs/rules/noBadBlocks.d.ts +0 -2
  51. package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +0 -2
  52. package/dist/cjs/rules/noBlankBlocks.d.ts +0 -2
  53. package/dist/cjs/rules/noDefaults.d.ts +0 -2
  54. package/dist/cjs/rules/noMissingSyntax.d.ts +0 -9
  55. package/dist/cjs/rules/noMultiAsterisks.d.ts +0 -2
  56. package/dist/cjs/rules/noRestrictedSyntax.d.ts +0 -2
  57. package/dist/cjs/rules/noTypes.d.ts +0 -2
  58. package/dist/cjs/rules/noUndefinedTypes.d.ts +0 -2
  59. package/dist/cjs/rules/normalizeSeeLinks.d.ts +0 -2
  60. package/dist/cjs/rules/preferImportTag.d.ts +0 -2
  61. package/dist/cjs/rules/requireAsteriskPrefix.d.ts +0 -2
  62. package/dist/cjs/rules/requireDescription.d.ts +0 -2
  63. package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +0 -2
  64. package/dist/cjs/rules/requireExample.d.ts +0 -2
  65. package/dist/cjs/rules/requireFileOverview.d.ts +0 -2
  66. package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +0 -2
  67. package/dist/cjs/rules/requireJsdoc.d.ts +0 -24
  68. package/dist/cjs/rules/requireParam.d.ts +0 -3
  69. package/dist/cjs/rules/requireParamDescription.d.ts +0 -2
  70. package/dist/cjs/rules/requireParamName.d.ts +0 -2
  71. package/dist/cjs/rules/requireParamType.d.ts +0 -2
  72. package/dist/cjs/rules/requireProperty.d.ts +0 -2
  73. package/dist/cjs/rules/requirePropertyDescription.d.ts +0 -2
  74. package/dist/cjs/rules/requirePropertyName.d.ts +0 -2
  75. package/dist/cjs/rules/requirePropertyType.d.ts +0 -2
  76. package/dist/cjs/rules/requireRejects.d.ts +0 -2
  77. package/dist/cjs/rules/requireReturns.d.ts +0 -2
  78. package/dist/cjs/rules/requireReturnsCheck.d.ts +0 -2
  79. package/dist/cjs/rules/requireReturnsDescription.d.ts +0 -2
  80. package/dist/cjs/rules/requireReturnsType.d.ts +0 -2
  81. package/dist/cjs/rules/requireTags.d.ts +0 -2
  82. package/dist/cjs/rules/requireTemplate.d.ts +0 -2
  83. package/dist/cjs/rules/requireThrows.d.ts +0 -2
  84. package/dist/cjs/rules/requireYields.d.ts +0 -2
  85. package/dist/cjs/rules/requireYieldsCheck.d.ts +0 -2
  86. package/dist/cjs/rules/sortTags.d.ts +0 -2
  87. package/dist/cjs/rules/tagLines.d.ts +0 -2
  88. package/dist/cjs/rules/textEscaping.d.ts +0 -2
  89. package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +0 -2
  90. package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +0 -2
  91. package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +0 -2
  92. package/dist/cjs/rules/tsPreferFunctionType.d.ts +0 -2
  93. package/dist/cjs/rules/typeFormatting.d.ts +0 -2
  94. package/dist/cjs/rules/validTypes.d.ts +0 -2
  95. package/dist/cjs/tagNames.d.ts +0 -15
  96. package/dist/cjs/utils/hasReturnValue.d.ts +0 -19
  97. package/dist/defaultTagOrder.cjs +0 -46
  98. package/dist/defaultTagOrder.cjs.map +0 -1
  99. package/dist/exportParser.cjs +0 -732
  100. package/dist/exportParser.cjs.map +0 -1
  101. package/dist/generateDocs.cjs +0 -342
  102. package/dist/generateDocs.cjs.map +0 -1
  103. package/dist/generateOptions.cjs +0 -62
  104. package/dist/generateOptions.cjs.map +0 -1
  105. package/dist/generateRule.cjs +0 -248
  106. package/dist/generateRule.cjs.map +0 -1
  107. package/dist/generateRuleTypes.cjs +0 -24
  108. package/dist/generateRuleTypes.cjs.map +0 -1
  109. package/dist/getDefaultTagStructureForMode.cjs +0 -289
  110. package/dist/getDefaultTagStructureForMode.cjs.map +0 -1
  111. package/dist/getJsdocProcessorPlugin.cjs +0 -587
  112. package/dist/getJsdocProcessorPlugin.cjs.map +0 -1
  113. package/dist/getJsdocProcessorPlugin.cts +0 -5
  114. package/dist/index-cjs.cjs +0 -598
  115. package/dist/index-cjs.cjs.map +0 -1
  116. package/dist/index-cjs.d.ts +0 -24
  117. package/dist/index-esm.cjs +0 -162
  118. package/dist/index-esm.cjs.map +0 -1
  119. package/dist/index-esm.d.ts +0 -72
  120. package/dist/index.cjs +0 -746
  121. package/dist/index.cjs.cts +0 -3
  122. package/dist/index.cjs.map +0 -1
  123. package/dist/iterateJsdoc.cjs +0 -2150
  124. package/dist/iterateJsdoc.cjs.map +0 -1
  125. package/dist/iterateJsdoc.cts +0 -7
  126. package/dist/jsdocUtils.cjs +0 -1786
  127. package/dist/jsdocUtils.cjs.map +0 -1
  128. package/dist/rules/checkAccess.cjs +0 -40
  129. package/dist/rules/checkAccess.cjs.map +0 -1
  130. package/dist/rules/checkAlignment.cjs +0 -78
  131. package/dist/rules/checkAlignment.cjs.map +0 -1
  132. package/dist/rules/checkExamples.cjs +0 -521
  133. package/dist/rules/checkExamples.cjs.map +0 -1
  134. package/dist/rules/checkIndentation.cjs +0 -170
  135. package/dist/rules/checkIndentation.cjs.map +0 -1
  136. package/dist/rules/checkLineAlignment.cjs +0 -398
  137. package/dist/rules/checkLineAlignment.cjs.map +0 -1
  138. package/dist/rules/checkParamNames.cjs +0 -407
  139. package/dist/rules/checkParamNames.cjs.map +0 -1
  140. package/dist/rules/checkPropertyNames.cjs +0 -135
  141. package/dist/rules/checkPropertyNames.cjs.map +0 -1
  142. package/dist/rules/checkSyntax.cjs +0 -38
  143. package/dist/rules/checkSyntax.cjs.map +0 -1
  144. package/dist/rules/checkTagNames.cjs +0 -312
  145. package/dist/rules/checkTagNames.cjs.map +0 -1
  146. package/dist/rules/checkTemplateNames.cjs +0 -192
  147. package/dist/rules/checkTemplateNames.cjs.map +0 -1
  148. package/dist/rules/checkTypes.cjs +0 -111
  149. package/dist/rules/checkTypes.cjs.map +0 -1
  150. package/dist/rules/checkValues.cjs +0 -166
  151. package/dist/rules/checkValues.cjs.map +0 -1
  152. package/dist/rules/convertToJsdocComments.cjs +0 -356
  153. package/dist/rules/convertToJsdocComments.cjs.map +0 -1
  154. package/dist/rules/emptyTags.cjs +0 -98
  155. package/dist/rules/emptyTags.cjs.map +0 -1
  156. package/dist/rules/escapeInlineTags.cjs +0 -234
  157. package/dist/rules/escapeInlineTags.cjs.map +0 -1
  158. package/dist/rules/implementsOnClasses.cjs +0 -74
  159. package/dist/rules/implementsOnClasses.cjs.map +0 -1
  160. package/dist/rules/importsAsDependencies.cjs +0 -104
  161. package/dist/rules/importsAsDependencies.cjs.map +0 -1
  162. package/dist/rules/informativeDocs.cjs +0 -187
  163. package/dist/rules/informativeDocs.cjs.map +0 -1
  164. package/dist/rules/linesBeforeBlock.cjs +0 -120
  165. package/dist/rules/linesBeforeBlock.cjs.map +0 -1
  166. package/dist/rules/matchDescription.cjs +0 -356
  167. package/dist/rules/matchDescription.cjs.map +0 -1
  168. package/dist/rules/matchName.cjs +0 -160
  169. package/dist/rules/matchName.cjs.map +0 -1
  170. package/dist/rules/multilineBlocks.cjs +0 -431
  171. package/dist/rules/multilineBlocks.cjs.map +0 -1
  172. package/dist/rules/noBadBlocks.cjs +0 -100
  173. package/dist/rules/noBadBlocks.cjs.map +0 -1
  174. package/dist/rules/noBlankBlockDescriptions.cjs +0 -63
  175. package/dist/rules/noBlankBlockDescriptions.cjs.map +0 -1
  176. package/dist/rules/noBlankBlocks.cjs +0 -54
  177. package/dist/rules/noBlankBlocks.cjs.map +0 -1
  178. package/dist/rules/noDefaults.cjs +0 -102
  179. package/dist/rules/noDefaults.cjs.map +0 -1
  180. package/dist/rules/noMissingSyntax.cjs +0 -196
  181. package/dist/rules/noMissingSyntax.cjs.map +0 -1
  182. package/dist/rules/noMultiAsterisks.cjs +0 -126
  183. package/dist/rules/noMultiAsterisks.cjs.map +0 -1
  184. package/dist/rules/noRestrictedSyntax.cjs +0 -68
  185. package/dist/rules/noRestrictedSyntax.cjs.map +0 -1
  186. package/dist/rules/noTypes.cjs +0 -101
  187. package/dist/rules/noTypes.cjs.map +0 -1
  188. package/dist/rules/noUndefinedTypes.cjs +0 -616
  189. package/dist/rules/noUndefinedTypes.cjs.map +0 -1
  190. package/dist/rules/normalizeSeeLinks.cjs +0 -271
  191. package/dist/rules/normalizeSeeLinks.cjs.map +0 -1
  192. package/dist/rules/preferImportTag.cjs +0 -362
  193. package/dist/rules/preferImportTag.cjs.map +0 -1
  194. package/dist/rules/requireAsteriskPrefix.cjs +0 -190
  195. package/dist/rules/requireAsteriskPrefix.cjs.map +0 -1
  196. package/dist/rules/requireDescription.cjs +0 -164
  197. package/dist/rules/requireDescription.cjs.map +0 -1
  198. package/dist/rules/requireDescriptionCompleteSentence.cjs +0 -321
  199. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +0 -1
  200. package/dist/rules/requireExample.cjs +0 -136
  201. package/dist/rules/requireExample.cjs.map +0 -1
  202. package/dist/rules/requireFileOverview.cjs +0 -194
  203. package/dist/rules/requireFileOverview.cjs.map +0 -1
  204. package/dist/rules/requireHyphenBeforeParamDescription.cjs +0 -166
  205. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +0 -1
  206. package/dist/rules/requireJsdoc.cjs +0 -721
  207. package/dist/rules/requireJsdoc.cjs.map +0 -1
  208. package/dist/rules/requireParam.cjs +0 -772
  209. package/dist/rules/requireParam.cjs.map +0 -1
  210. package/dist/rules/requireParamDescription.cjs +0 -105
  211. package/dist/rules/requireParamDescription.cjs.map +0 -1
  212. package/dist/rules/requireParamName.cjs +0 -68
  213. package/dist/rules/requireParamName.cjs.map +0 -1
  214. package/dist/rules/requireParamType.cjs +0 -104
  215. package/dist/rules/requireParamType.cjs.map +0 -1
  216. package/dist/rules/requireProperty.cjs +0 -63
  217. package/dist/rules/requireProperty.cjs.map +0 -1
  218. package/dist/rules/requirePropertyDescription.cjs +0 -29
  219. package/dist/rules/requirePropertyDescription.cjs.map +0 -1
  220. package/dist/rules/requirePropertyName.cjs +0 -29
  221. package/dist/rules/requirePropertyName.cjs.map +0 -1
  222. package/dist/rules/requirePropertyType.cjs +0 -29
  223. package/dist/rules/requirePropertyType.cjs.map +0 -1
  224. package/dist/rules/requireRejects.cjs +0 -226
  225. package/dist/rules/requireRejects.cjs.map +0 -1
  226. package/dist/rules/requireReturns.cjs +0 -262
  227. package/dist/rules/requireReturns.cjs.map +0 -1
  228. package/dist/rules/requireReturnsCheck.cjs +0 -225
  229. package/dist/rules/requireReturnsCheck.cjs.map +0 -1
  230. package/dist/rules/requireReturnsDescription.cjs +0 -72
  231. package/dist/rules/requireReturnsDescription.cjs.map +0 -1
  232. package/dist/rules/requireReturnsType.cjs +0 -68
  233. package/dist/rules/requireReturnsType.cjs.map +0 -1
  234. package/dist/rules/requireTags.cjs +0 -74
  235. package/dist/rules/requireTags.cjs.map +0 -1
  236. package/dist/rules/requireTemplate.cjs +0 -220
  237. package/dist/rules/requireTemplate.cjs.map +0 -1
  238. package/dist/rules/requireThrows.cjs +0 -118
  239. package/dist/rules/requireThrows.cjs.map +0 -1
  240. package/dist/rules/requireYields.cjs +0 -224
  241. package/dist/rules/requireYields.cjs.map +0 -1
  242. package/dist/rules/requireYieldsCheck.cjs +0 -179
  243. package/dist/rules/requireYieldsCheck.cjs.map +0 -1
  244. package/dist/rules/sortTags.cjs +0 -656
  245. package/dist/rules/sortTags.cjs.map +0 -1
  246. package/dist/rules/tagLines.cjs +0 -374
  247. package/dist/rules/tagLines.cjs.map +0 -1
  248. package/dist/rules/textEscaping.cjs +0 -141
  249. package/dist/rules/textEscaping.cjs.map +0 -1
  250. package/dist/rules/tsMethodSignatureStyle.cjs +0 -240
  251. package/dist/rules/tsMethodSignatureStyle.cjs.map +0 -1
  252. package/dist/rules/tsNoEmptyObjectType.cjs +0 -62
  253. package/dist/rules/tsNoEmptyObjectType.cjs.map +0 -1
  254. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +0 -104
  255. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +0 -1
  256. package/dist/rules/tsPreferFunctionType.cjs +0 -110
  257. package/dist/rules/tsPreferFunctionType.cjs.map +0 -1
  258. package/dist/rules/typeFormatting.cjs +0 -607
  259. package/dist/rules/typeFormatting.cjs.map +0 -1
  260. package/dist/rules/validTypes.cjs +0 -324
  261. package/dist/rules/validTypes.cjs.map +0 -1
  262. package/dist/tagNames.cjs +0 -244
  263. package/dist/tagNames.cjs.map +0 -1
  264. package/dist/to-valid-identifier.cjs +0 -263
  265. package/dist/utils/hasReturnValue.cjs +0 -495
  266. package/dist/utils/hasReturnValue.cjs.map +0 -1
  267. package/rollup.config.js +0 -16
  268. package/src/getJsdocProcessorPlugin.cts +0 -5
  269. package/src/index-cjs.js +0 -758
  270. package/src/index-esm.js +0 -196
  271. package/src/index.cjs.cts +0 -3
  272. package/src/iterateJsdoc.cts +0 -7
package/dist/index.cjs DELETED
@@ -1,746 +0,0 @@
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 _normalizeSeeLinks = _interopRequireDefault(require("./rules/normalizeSeeLinks.cjs"));
48
- var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
49
- var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
50
- var _preferImportTag = _interopRequireDefault(require("./rules/preferImportTag.cjs"));
51
- var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
52
- var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
53
- var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
54
- var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
55
- var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
56
- var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
57
- var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
58
- var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
59
- var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
60
- var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
61
- var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
62
- var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
63
- var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
64
- var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
65
- var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
66
- var _requireRejects = _interopRequireDefault(require("./rules/requireRejects.cjs"));
67
- var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
68
- var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
69
- var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
70
- var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
71
- var _requireTags = _interopRequireDefault(require("./rules/requireTags.cjs"));
72
- var _requireTemplate = _interopRequireDefault(require("./rules/requireTemplate.cjs"));
73
- var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
74
- var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
75
- var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
76
- var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
77
- var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
78
- var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
79
- var _tsMethodSignatureStyle = _interopRequireDefault(require("./rules/tsMethodSignatureStyle.cjs"));
80
- var _tsNoEmptyObjectType = _interopRequireDefault(require("./rules/tsNoEmptyObjectType.cjs"));
81
- var _tsNoUnnecessaryTemplateExpression = _interopRequireDefault(require("./rules/tsNoUnnecessaryTemplateExpression.cjs"));
82
- var _tsPreferFunctionType = _interopRequireDefault(require("./rules/tsPreferFunctionType.cjs"));
83
- var _typeFormatting = _interopRequireDefault(require("./rules/typeFormatting.cjs"));
84
- var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
85
- var _eslint = require("eslint");
86
- var _semver = _interopRequireDefault(require("semver"));
87
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
88
- /* AUTO-GENERATED BY build SCRIPT */
89
- /* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
90
-
91
- /**
92
- * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
93
- * @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
94
- * @typedef {"" | "-error"} ErrorLevelVariants
95
- * @type {import('eslint').ESLint.Plugin & {
96
- * configs: Record<
97
- * `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
98
- * import('eslint').Linter.Config
99
- * > &
100
- * Record<
101
- * "examples"|"default-expressions"|"examples-and-default-expressions",
102
- * import('eslint').Linter.Config[]
103
- * > &
104
- * Record<"flat/recommended-mixed", import('eslint').Linter.Config[]>
105
- * }}
106
- */
107
- const index = {};
108
- index.configs = {};
109
- index.rules = {
110
- 'check-access': _checkAccess.default,
111
- 'check-alignment': _checkAlignment.default,
112
- 'check-examples': _checkExamples.default,
113
- 'check-indentation': _checkIndentation.default,
114
- 'check-line-alignment': _checkLineAlignment.default,
115
- 'check-param-names': _checkParamNames.default,
116
- 'check-property-names': _checkPropertyNames.default,
117
- 'check-syntax': _checkSyntax.default,
118
- 'check-tag-names': _checkTagNames.default,
119
- 'check-template-names': _checkTemplateNames.default,
120
- 'check-types': _checkTypes.default,
121
- 'check-values': _checkValues.default,
122
- 'convert-to-jsdoc-comments': _convertToJsdocComments.default,
123
- 'empty-tags': _emptyTags.default,
124
- 'escape-inline-tags': _escapeInlineTags.default,
125
- 'implements-on-classes': _implementsOnClasses.default,
126
- 'imports-as-dependencies': _importsAsDependencies.default,
127
- 'informative-docs': _informativeDocs.default,
128
- 'lines-before-block': _linesBeforeBlock.default,
129
- 'match-description': _matchDescription.default,
130
- 'match-name': _matchName.default,
131
- 'multiline-blocks': _multilineBlocks.default,
132
- 'no-bad-blocks': _noBadBlocks.default,
133
- 'no-blank-block-descriptions': _noBlankBlockDescriptions.default,
134
- 'no-blank-blocks': _noBlankBlocks.default,
135
- 'no-defaults': _noDefaults.default,
136
- 'no-missing-syntax': _noMissingSyntax.default,
137
- 'no-multi-asterisks': _noMultiAsterisks.default,
138
- 'no-restricted-syntax': _noRestrictedSyntax.default,
139
- 'no-types': _noTypes.default,
140
- 'no-undefined-types': _noUndefinedTypes.default,
141
- 'normalize-see-links': _normalizeSeeLinks.default,
142
- 'prefer-import-tag': _preferImportTag.default,
143
- 'reject-any-type': (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
144
- description: 'Reports use of `any` or `*` type',
145
- overrideSettings: {
146
- '*': {
147
- message: 'Prefer a more specific type to `*`',
148
- replacement: false,
149
- unifyParentAndChildTypeChecks: true
150
- },
151
- any: {
152
- message: 'Prefer a more specific type to `any`',
153
- replacement: false,
154
- unifyParentAndChildTypeChecks: true
155
- }
156
- },
157
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-any-type.md#repos-sticky-header'
158
- }),
159
- 'reject-function-type': (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
160
- description: 'Reports use of `Function` type',
161
- overrideSettings: {
162
- Function: {
163
- message: 'Prefer a more specific type to `Function`',
164
- replacement: false,
165
- unifyParentAndChildTypeChecks: true
166
- }
167
- },
168
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-function-type.md#repos-sticky-header'
169
- }),
170
- 'require-asterisk-prefix': _requireAsteriskPrefix.default,
171
- 'require-description': _requireDescription.default,
172
- 'require-description-complete-sentence': _requireDescriptionCompleteSentence.default,
173
- 'require-example': _requireExample.default,
174
- 'require-file-overview': _requireFileOverview.default,
175
- 'require-hyphen-before-param-description': _requireHyphenBeforeParamDescription.default,
176
- 'require-jsdoc': _requireJsdoc.default,
177
- 'require-next-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
178
- contexts: [{
179
- comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]):not([description!=""]))',
180
- context: 'any',
181
- message: '@next should have a description'
182
- }],
183
- description: 'Requires a description for `@next` tags',
184
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-description.md#repos-sticky-header'
185
- }),
186
- 'require-next-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
187
- contexts: [{
188
- comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([parsedType.type]))',
189
- context: 'any',
190
- message: '@next should have a type'
191
- }],
192
- description: 'Requires a type for `@next` tags',
193
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header'
194
- }),
195
- 'require-param': _requireParam.default,
196
- 'require-param-description': _requireParamDescription.default,
197
- 'require-param-name': _requireParamName.default,
198
- 'require-param-type': _requireParamType.default,
199
- 'require-property': _requireProperty.default,
200
- 'require-property-description': _requirePropertyDescription.default,
201
- 'require-property-name': _requirePropertyName.default,
202
- 'require-property-type': _requirePropertyType.default,
203
- 'require-rejects': _requireRejects.default,
204
- 'require-returns': _requireReturns.default,
205
- 'require-returns-check': _requireReturnsCheck.default,
206
- 'require-returns-description': _requireReturnsDescription.default,
207
- 'require-returns-type': _requireReturnsType.default,
208
- 'require-tags': _requireTags.default,
209
- 'require-template': _requireTemplate.default,
210
- 'require-template-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
211
- contexts: [{
212
- comment: 'JsdocBlock:has(JsdocTag[tag=template]:not([description!=""]))',
213
- context: 'any',
214
- message: '@template should have a description'
215
- }],
216
- description: 'Requires a description for `@template` tags',
217
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template-description.md#repos-sticky-header'
218
- }),
219
- 'require-throws': _requireThrows.default,
220
- 'require-throws-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
221
- contexts: [{
222
- comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([description!=""]))',
223
- context: 'any',
224
- message: '@throws should have a description'
225
- }],
226
- description: 'Requires a description for `@throws` tags',
227
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-description.md#repos-sticky-header'
228
- }),
229
- 'require-throws-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
230
- contexts: [{
231
- comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([parsedType.type]))',
232
- context: 'any',
233
- message: '@throws should have a type'
234
- }],
235
- description: 'Requires a type for `@throws` tags',
236
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header'
237
- }),
238
- 'require-yields': _requireYields.default,
239
- 'require-yields-check': _requireYieldsCheck.default,
240
- 'require-yields-description': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
241
- contexts: [{
242
- comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([name!=""]):not([description!=""]))',
243
- context: 'any',
244
- message: '@yields should have a description'
245
- }],
246
- description: 'Requires a description for `@yields` tags',
247
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-description.md#repos-sticky-header'
248
- }),
249
- 'require-yields-type': (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
250
- contexts: [{
251
- comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([parsedType.type]))',
252
- context: 'any',
253
- message: '@yields should have a type'
254
- }],
255
- description: 'Requires a type for `@yields` tags',
256
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header'
257
- }),
258
- 'sort-tags': _sortTags.default,
259
- 'tag-lines': _tagLines.default,
260
- 'text-escaping': _textEscaping.default,
261
- 'ts-method-signature-style': _tsMethodSignatureStyle.default,
262
- 'ts-no-empty-object-type': _tsNoEmptyObjectType.default,
263
- 'ts-no-unnecessary-template-expression': _tsNoUnnecessaryTemplateExpression.default,
264
- 'ts-prefer-function-type': _tsPreferFunctionType.default,
265
- 'type-formatting': _typeFormatting.default,
266
- 'valid-types': _validTypes.default
267
- };
268
-
269
- /**
270
- * @param {"warn"|"error"} warnOrError
271
- * @param {string} [flatName]
272
- * @returns {import('eslint').Linter.Config}
273
- */
274
- const createRecommendedRuleset = (warnOrError, flatName) => {
275
- return {
276
- ...(flatName ? {
277
- name: 'jsdoc/' + flatName
278
- } : {}),
279
- // @ts-expect-error ESLint 8 plugins
280
- plugins: flatName ? {
281
- jsdoc: index
282
- } : ['jsdoc'],
283
- rules: {
284
- 'jsdoc/check-access': warnOrError,
285
- 'jsdoc/check-alignment': warnOrError,
286
- 'jsdoc/check-examples': 'off',
287
- 'jsdoc/check-indentation': 'off',
288
- 'jsdoc/check-line-alignment': 'off',
289
- 'jsdoc/check-param-names': warnOrError,
290
- 'jsdoc/check-property-names': warnOrError,
291
- 'jsdoc/check-syntax': 'off',
292
- 'jsdoc/check-tag-names': warnOrError,
293
- 'jsdoc/check-template-names': 'off',
294
- 'jsdoc/check-types': warnOrError,
295
- 'jsdoc/check-values': warnOrError,
296
- 'jsdoc/convert-to-jsdoc-comments': 'off',
297
- 'jsdoc/empty-tags': warnOrError,
298
- 'jsdoc/escape-inline-tags': warnOrError,
299
- 'jsdoc/implements-on-classes': warnOrError,
300
- 'jsdoc/imports-as-dependencies': 'off',
301
- 'jsdoc/informative-docs': 'off',
302
- 'jsdoc/lines-before-block': 'off',
303
- 'jsdoc/match-description': 'off',
304
- 'jsdoc/match-name': 'off',
305
- 'jsdoc/multiline-blocks': warnOrError,
306
- 'jsdoc/no-bad-blocks': 'off',
307
- 'jsdoc/no-blank-block-descriptions': 'off',
308
- 'jsdoc/no-blank-blocks': 'off',
309
- 'jsdoc/no-defaults': warnOrError,
310
- 'jsdoc/no-missing-syntax': 'off',
311
- 'jsdoc/no-multi-asterisks': warnOrError,
312
- 'jsdoc/no-restricted-syntax': 'off',
313
- 'jsdoc/no-types': 'off',
314
- 'jsdoc/no-undefined-types': warnOrError,
315
- 'jsdoc/normalize-see-links': 'off',
316
- 'jsdoc/prefer-import-tag': 'off',
317
- 'jsdoc/reject-any-type': warnOrError,
318
- 'jsdoc/reject-function-type': warnOrError,
319
- 'jsdoc/require-asterisk-prefix': 'off',
320
- 'jsdoc/require-description': 'off',
321
- 'jsdoc/require-description-complete-sentence': 'off',
322
- 'jsdoc/require-example': 'off',
323
- 'jsdoc/require-file-overview': 'off',
324
- 'jsdoc/require-hyphen-before-param-description': 'off',
325
- 'jsdoc/require-jsdoc': warnOrError,
326
- 'jsdoc/require-next-description': 'off',
327
- 'jsdoc/require-next-type': warnOrError,
328
- 'jsdoc/require-param': warnOrError,
329
- 'jsdoc/require-param-description': warnOrError,
330
- 'jsdoc/require-param-name': warnOrError,
331
- 'jsdoc/require-param-type': warnOrError,
332
- 'jsdoc/require-property': warnOrError,
333
- 'jsdoc/require-property-description': warnOrError,
334
- 'jsdoc/require-property-name': warnOrError,
335
- 'jsdoc/require-property-type': warnOrError,
336
- 'jsdoc/require-rejects': 'off',
337
- 'jsdoc/require-returns': warnOrError,
338
- 'jsdoc/require-returns-check': warnOrError,
339
- 'jsdoc/require-returns-description': warnOrError,
340
- 'jsdoc/require-returns-type': warnOrError,
341
- 'jsdoc/require-tags': 'off',
342
- 'jsdoc/require-template': 'off',
343
- 'jsdoc/require-template-description': 'off',
344
- 'jsdoc/require-throws': 'off',
345
- 'jsdoc/require-throws-description': 'off',
346
- 'jsdoc/require-throws-type': warnOrError,
347
- 'jsdoc/require-yields': warnOrError,
348
- 'jsdoc/require-yields-check': warnOrError,
349
- 'jsdoc/require-yields-description': 'off',
350
- 'jsdoc/require-yields-type': warnOrError,
351
- 'jsdoc/sort-tags': 'off',
352
- 'jsdoc/tag-lines': warnOrError,
353
- 'jsdoc/text-escaping': 'off',
354
- 'jsdoc/ts-method-signature-style': 'off',
355
- 'jsdoc/ts-no-empty-object-type': warnOrError,
356
- 'jsdoc/ts-no-unnecessary-template-expression': 'off',
357
- 'jsdoc/ts-prefer-function-type': 'off',
358
- 'jsdoc/type-formatting': 'off',
359
- 'jsdoc/valid-types': warnOrError
360
- }
361
- };
362
- };
363
-
364
- /**
365
- * @param {"warn"|"error"} warnOrError
366
- * @param {string} [flatName]
367
- * @returns {import('eslint').Linter.Config}
368
- */
369
- const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
370
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
371
- return {
372
- ...ruleset,
373
- rules: {
374
- ...ruleset.rules,
375
- /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
376
- 'jsdoc/check-tag-names': [warnOrError, {
377
- typed: true
378
- }],
379
- 'jsdoc/no-types': warnOrError,
380
- 'jsdoc/no-undefined-types': 'off',
381
- 'jsdoc/require-param-type': 'off',
382
- 'jsdoc/require-property-type': 'off',
383
- 'jsdoc/require-returns-type': 'off'
384
- /* eslint-enable @stylistic/indent */
385
- }
386
- };
387
- };
388
-
389
- /**
390
- * @param {"warn"|"error"} warnOrError
391
- * @param {string} [flatName]
392
- * @returns {import('eslint').Linter.Config}
393
- */
394
- const createRecommendedTsDocRuleset = (warnOrError, flatName) => {
395
- const ruleset = createRecommendedTypeScriptRuleset(warnOrError, flatName);
396
- return {
397
- ...ruleset,
398
- rules: {
399
- ...ruleset.rules,
400
- /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
401
- 'jsdoc/require-next-type': 'off',
402
- 'jsdoc/require-throws-type': 'off',
403
- 'jsdoc/require-yields-type': 'off'
404
- /* eslint-enable @stylistic/indent */
405
- }
406
- };
407
- };
408
-
409
- /**
410
- * @param {"warn"|"error"} warnOrError
411
- * @param {string} [flatName]
412
- * @returns {import('eslint').Linter.Config}
413
- */
414
- const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
415
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
416
- return {
417
- ...ruleset,
418
- rules: {
419
- ...ruleset.rules,
420
- /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
421
- 'jsdoc/no-undefined-types': 'off'
422
- /* eslint-enable @stylistic/indent */
423
- }
424
- };
425
- };
426
-
427
- /**
428
- * @param {(string | unknown[])[]} ruleNames
429
- */
430
- const createStandaloneRulesetFactory = ruleNames => {
431
- /**
432
- * @param {"warn"|"error"} warnOrError
433
- * @param {string} [flatName]
434
- * @returns {import('eslint').Linter.Config}
435
- */
436
- return (warnOrError, flatName) => {
437
- return {
438
- name: 'jsdoc/' + flatName,
439
- plugins: {
440
- jsdoc: index
441
- },
442
- rules: Object.fromEntries(ruleNames.map(ruleName => {
443
- return typeof ruleName === 'string' ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
444
- }))
445
- };
446
- };
447
- };
448
- const contentsRules = ['jsdoc/informative-docs', 'jsdoc/match-description', 'jsdoc/no-blank-block-descriptions', 'jsdoc/no-blank-blocks', ['jsdoc/text-escaping', {
449
- escapeHTML: true
450
- }]];
451
- const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
452
- const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
453
- const logicalRules = ['jsdoc/check-access', 'jsdoc/check-param-names', 'jsdoc/check-property-names', 'jsdoc/check-syntax', 'jsdoc/check-tag-names', 'jsdoc/check-template-names', 'jsdoc/check-types', 'jsdoc/check-values', 'jsdoc/empty-tags', 'jsdoc/escape-inline-tags', 'jsdoc/implements-on-classes', 'jsdoc/require-returns-check', 'jsdoc/require-yields-check', 'jsdoc/no-bad-blocks', 'jsdoc/no-defaults', 'jsdoc/no-types', 'jsdoc/no-undefined-types', 'jsdoc/valid-types'];
454
- const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
455
- const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
456
- const requirementsRules = ['jsdoc/require-example', 'jsdoc/require-jsdoc', 'jsdoc/require-next-type', 'jsdoc/require-param', 'jsdoc/require-param-description', 'jsdoc/require-param-name', 'jsdoc/require-property', 'jsdoc/require-property-description', 'jsdoc/require-property-name', 'jsdoc/require-returns', 'jsdoc/require-returns-description', 'jsdoc/require-throws-type', 'jsdoc/require-yields', 'jsdoc/require-yields-type'];
457
- const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
458
- const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([...requirementsRules, 'jsdoc/require-param-type', 'jsdoc/require-property-type', 'jsdoc/require-returns-type', 'jsdoc/require-template']);
459
- const stylisticRules = ['jsdoc/check-alignment', 'jsdoc/check-line-alignment', 'jsdoc/lines-before-block', 'jsdoc/multiline-blocks', 'jsdoc/no-multi-asterisks', 'jsdoc/require-asterisk-prefix', ['jsdoc/require-hyphen-before-param-description', 'never'], 'jsdoc/tag-lines'];
460
- const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
461
- const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
462
-
463
- /* c8 ignore next 3 -- TS */
464
- if (!index.configs) {
465
- throw new Error('TypeScript guard');
466
- }
467
- index.configs.recommended = createRecommendedRuleset('warn');
468
- index.configs['recommended-error'] = createRecommendedRuleset('error');
469
- index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
470
- index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
471
- index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
472
- index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
473
- index.configs['recommended-tsdoc'] = createRecommendedTsDocRuleset('warn');
474
- index.configs['recommended-tsdoc-error'] = createRecommendedTsDocRuleset('error');
475
- index.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');
476
- index.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');
477
- index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');
478
- index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');
479
- index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');
480
- index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');
481
- index.configs['flat/recommended-tsdoc'] = createRecommendedTsDocRuleset('warn', 'flat/recommended-tsdoc');
482
- index.configs['flat/recommended-tsdoc-error'] = createRecommendedTsDocRuleset('error', 'flat/recommended-tsdoc-error');
483
- index.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');
484
- index.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');
485
- index.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');
486
- index.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');
487
- index.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');
488
- index.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');
489
- index.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');
490
- index.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');
491
- index.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');
492
- index.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');
493
- index.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');
494
- index.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');
495
- index.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');
496
- index.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');
497
- index.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');
498
- index.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');
499
- index.configs.examples = /** @type {import('eslint').Linter.Config[]} */[{
500
- files: ['**/*.js'],
501
- name: 'jsdoc/examples/processor',
502
- plugins: {
503
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)()
504
- },
505
- processor: 'examples/examples'
506
- }, {
507
- files: ['**/*.md/*.js'],
508
- name: 'jsdoc/examples/rules',
509
- rules: {
510
- // "always" newline rule at end unlikely in sample code
511
- '@stylistic/eol-last': 0,
512
- // Often wish to start `@example` code after newline; also may use
513
- // empty lines for spacing
514
- '@stylistic/no-multiple-empty-lines': 0,
515
- // Can generally look nicer to pad a little even if code imposes more stringency
516
- '@stylistic/padded-blocks': 0,
517
- '@typescript-eslint/no-unused-vars': 0,
518
- // Wouldn't generally expect example paths to resolve relative to JS file
519
- 'import/no-unresolved': 0,
520
- // Snippets likely too short to always include import/export info
521
- 'import/unambiguous': 0,
522
- 'jsdoc/require-file-overview': 0,
523
- // The end of a multiline comment would end the comment the example is in.
524
- 'jsdoc/require-jsdoc': 0,
525
- // See import/no-unresolved
526
- 'n/no-missing-import': 0,
527
- 'n/no-missing-require': 0,
528
- // Unlikely to have inadvertent debugging within examples
529
- 'no-console': 0,
530
- /* c8 ignore next 11 -- Coercion should work */
531
- ...(_semver.default.gte(_semver.default.coerce(_eslint.ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
532
- // "always" newline rule at end unlikely in sample code
533
- 'eol-last': 0,
534
- // Often wish to start `@example` code after newline; also may use
535
- // empty lines for spacing
536
- 'no-multiple-empty-lines': 0,
537
- // Can generally look nicer to pad a little even if code imposes more stringency
538
- 'padded-blocks': 0
539
- }),
540
- // Many variables in examples will be `undefined`
541
- 'no-undef': 0,
542
- // Common to define variables for clarity without always using them
543
- 'no-unused-vars': 0,
544
- // See import/no-unresolved
545
- 'node/no-missing-import': 0,
546
- 'node/no-missing-require': 0
547
- }
548
- }];
549
- index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config[]} */[{
550
- files: ['**/*.js'],
551
- name: 'jsdoc/default-expressions/processor',
552
- plugins: {
553
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
554
- checkDefaults: true,
555
- checkParams: true,
556
- checkProperties: true
557
- })
558
- },
559
- processor: 'examples/examples'
560
- }, {
561
- files: ['**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties'],
562
- name: 'jsdoc/default-expressions/rules',
563
- rules: {
564
- ...index.configs.examples[1].rules,
565
- '@stylistic/quotes': ['error', 'double'],
566
- '@stylistic/semi': ['error', 'never'],
567
- '@typescript-eslint/no-unused-expressions': 0,
568
- 'chai-friendly/no-unused-expressions': 0,
569
- 'no-empty-function': 0,
570
- 'no-new': 0,
571
- 'no-unused-expressions': 0,
572
- /* c8 ignore next 8 -- Coercion should work */
573
- ...(_semver.default.gte(_semver.default.coerce(_eslint.ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
574
- quotes: ['error', 'double'],
575
- semi: ['error', 'never']
576
- }),
577
- strict: 0
578
- }
579
- }];
580
- index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.Config[]} */[{
581
- name: 'jsdoc/examples-and-default-expressions',
582
- plugins: {
583
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
584
- checkDefaults: true,
585
- checkParams: true,
586
- checkProperties: true
587
- })
588
- }
589
- }, ...index.configs.examples.map(config => {
590
- return {
591
- ...config,
592
- plugins: {}
593
- };
594
- }), ...index.configs['default-expressions'].map(config => {
595
- return {
596
- ...config,
597
- plugins: {}
598
- };
599
- })];
600
- index.configs['flat/recommended-mixed'] = [{
601
- ...index.configs['flat/recommended-typescript-flavor'],
602
- files: ['**/*.{js,jsx,cjs,mjs}']
603
- }, {
604
- ...index.configs['flat/recommended-typescript'],
605
- files: ['**/*.{ts,tsx,cts,mts}']
606
- }];
607
- var _default = exports.default = index;
608
- /**
609
- * @type {((
610
- * cfg?: import('eslint').Linter.Config & {
611
- * config?: `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
612
- * mergeSettings?: boolean,
613
- * settings?: Partial<import('./iterateJsdoc.js').Settings>,
614
- * rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>},
615
- * extraRuleDefinitions?: {
616
- * forbid?: {
617
- * [contextName: string]: {
618
- * description?: string,
619
- * url?: string,
620
- * contexts: (string|{
621
- * message: string,
622
- * context: string,
623
- * comment: string
624
- * })[]
625
- * }
626
- * },
627
- * preferTypes?: {
628
- * [typeName: string]: {
629
- * description: string,
630
- * overrideSettings: {
631
- * [typeNodeName: string]: {
632
- * message: string,
633
- * replacement?: false|string,
634
- * unifyParentAndChildTypeChecks?: boolean,
635
- * }
636
- * },
637
- * url: string,
638
- * }
639
- * }
640
- * }
641
- * }
642
- * ) => import('eslint').Linter.Config)}
643
- */
644
- const jsdoc = function (cfg) {
645
- /** @type {import('eslint').Linter.Config} */
646
- let outputConfig = {
647
- plugins: {
648
- jsdoc: index
649
- }
650
- };
651
- if (cfg) {
652
- if (cfg.config) {
653
- // @ts-expect-error Security check
654
- if (cfg.config === '__proto__') {
655
- throw new TypeError('Disallowed config value');
656
- }
657
- outputConfig = /** @type {import('eslint').Linter.Config} */index.configs[cfg.config];
658
- }
659
- if (cfg.rules) {
660
- outputConfig.rules = {
661
- ...outputConfig.rules,
662
- ...cfg.rules
663
- };
664
- }
665
- if (cfg.plugins) {
666
- outputConfig.plugins = {
667
- ...outputConfig.plugins,
668
- ...cfg.plugins
669
- };
670
- }
671
- if (cfg.name) {
672
- outputConfig.name = cfg.name;
673
- }
674
- if (cfg.basePath) {
675
- outputConfig.basePath = cfg.basePath;
676
- }
677
- if (cfg.files) {
678
- outputConfig.files = cfg.files;
679
- }
680
- if (cfg.ignores) {
681
- outputConfig.ignores = cfg.ignores;
682
- }
683
- if (cfg.language) {
684
- outputConfig.language = cfg.language;
685
- }
686
- if (cfg.languageOptions) {
687
- outputConfig.languageOptions = cfg.languageOptions;
688
- }
689
- if (cfg.linterOptions) {
690
- outputConfig.linterOptions = cfg.linterOptions;
691
- }
692
- if (cfg.processor) {
693
- outputConfig.processor = cfg.processor;
694
- }
695
- if (cfg.extraRuleDefinitions) {
696
- if (!outputConfig.plugins?.jsdoc?.rules) {
697
- throw new Error('JSDoc plugin required for `extraRuleDefinitions`');
698
- }
699
- if (cfg.extraRuleDefinitions.forbid) {
700
- for (const [contextName, {
701
- contexts,
702
- description,
703
- url
704
- }] of Object.entries(cfg.extraRuleDefinitions.forbid)) {
705
- outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] = (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
706
- contextName,
707
- contexts,
708
- description,
709
- url
710
- });
711
- }
712
- }
713
- if (cfg.extraRuleDefinitions.preferTypes) {
714
- for (const [typeName, {
715
- description,
716
- overrideSettings,
717
- url
718
- }] of Object.entries(cfg.extraRuleDefinitions.preferTypes)) {
719
- outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] = (0, _buildRejectOrPreferRuleDefinition.buildRejectOrPreferRuleDefinition)({
720
- description,
721
- overrideSettings,
722
- typeName,
723
- url
724
- });
725
- }
726
- }
727
- }
728
- }
729
- outputConfig.settings = {
730
- jsdoc: cfg?.mergeSettings === false ? cfg.settings : (0, _objectDeepMerge.merge)({}, cfg?.settings ?? {}, cfg?.config?.includes('recommended') ? {
731
- // We may need to drop these for "typescript" (non-"flavor") configs,
732
- // if support is later added: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
733
- structuredTags: {
734
- next: {
735
- required: ['type']
736
- },
737
- rejects: {
738
- required: ['type']
739
- }
740
- }
741
- } : {})
742
- };
743
- return outputConfig;
744
- };
745
- exports.jsdoc = jsdoc;
746
- //# sourceMappingURL=index.cjs.map