eslint-plugin-jsdoc 63.3.3 → 64.0.1

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