eslint-plugin-jsdoc 63.3.3 → 64.0.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 (269) hide show
  1. package/package.json +23 -48
  2. package/src/index.js +3 -6
  3. package/dist/WarnSettings.cjs +0 -38
  4. package/dist/WarnSettings.cjs.map +0 -1
  5. package/dist/alignTransform.cjs +0 -402
  6. package/dist/alignTransform.cjs.map +0 -1
  7. package/dist/buildForbidRuleDefinition.cjs +0 -101
  8. package/dist/buildForbidRuleDefinition.cjs.map +0 -1
  9. package/dist/buildRejectOrPreferRuleDefinition.cjs +0 -352
  10. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +0 -1
  11. package/dist/cjs/WarnSettings.d.ts +0 -16
  12. package/dist/cjs/alignTransform.d.ts +0 -33
  13. package/dist/cjs/buildForbidRuleDefinition.d.ts +0 -14
  14. package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +0 -8
  15. package/dist/cjs/defaultTagOrder.d.ts +0 -4
  16. package/dist/cjs/exportParser.d.ts +0 -40
  17. package/dist/cjs/getDefaultTagStructureForMode.d.ts +0 -10
  18. package/dist/cjs/getJsdocProcessorPlugin.d.cts +0 -5
  19. package/dist/cjs/getJsdocProcessorPlugin.d.ts +0 -66
  20. package/dist/cjs/index-cjs.d.ts +0 -26
  21. package/dist/cjs/index.cjs.d.cts +0 -2
  22. package/dist/cjs/iterateJsdoc.d.cts +0 -7
  23. package/dist/cjs/iterateJsdoc.d.ts +0 -495
  24. package/dist/cjs/jsdocUtils.d.ts +0 -500
  25. package/dist/cjs/rules/checkAccess.d.ts +0 -2
  26. package/dist/cjs/rules/checkAlignment.d.ts +0 -2
  27. package/dist/cjs/rules/checkExamples.d.ts +0 -3
  28. package/dist/cjs/rules/checkIndentation.d.ts +0 -2
  29. package/dist/cjs/rules/checkLineAlignment.d.ts +0 -9
  30. package/dist/cjs/rules/checkParamNames.d.ts +0 -2
  31. package/dist/cjs/rules/checkPropertyNames.d.ts +0 -2
  32. package/dist/cjs/rules/checkSyntax.d.ts +0 -2
  33. package/dist/cjs/rules/checkTagNames.d.ts +0 -2
  34. package/dist/cjs/rules/checkTemplateNames.d.ts +0 -2
  35. package/dist/cjs/rules/checkTypes.d.ts +0 -7
  36. package/dist/cjs/rules/checkValues.d.ts +0 -2
  37. package/dist/cjs/rules/convertToJsdocComments.d.ts +0 -266
  38. package/dist/cjs/rules/emptyTags.d.ts +0 -2
  39. package/dist/cjs/rules/escapeInlineTags.d.ts +0 -2
  40. package/dist/cjs/rules/implementsOnClasses.d.ts +0 -2
  41. package/dist/cjs/rules/importsAsDependencies.d.ts +0 -2
  42. package/dist/cjs/rules/informativeDocs.d.ts +0 -2
  43. package/dist/cjs/rules/linesBeforeBlock.d.ts +0 -2
  44. package/dist/cjs/rules/matchDescription.d.ts +0 -2
  45. package/dist/cjs/rules/matchName.d.ts +0 -2
  46. package/dist/cjs/rules/multilineBlocks.d.ts +0 -2
  47. package/dist/cjs/rules/noBadBlocks.d.ts +0 -2
  48. package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +0 -2
  49. package/dist/cjs/rules/noBlankBlocks.d.ts +0 -2
  50. package/dist/cjs/rules/noDefaults.d.ts +0 -2
  51. package/dist/cjs/rules/noMissingSyntax.d.ts +0 -9
  52. package/dist/cjs/rules/noMultiAsterisks.d.ts +0 -2
  53. package/dist/cjs/rules/noRestrictedSyntax.d.ts +0 -2
  54. package/dist/cjs/rules/noTypes.d.ts +0 -2
  55. package/dist/cjs/rules/noUndefinedTypes.d.ts +0 -2
  56. package/dist/cjs/rules/normalizeSeeLinks.d.ts +0 -2
  57. package/dist/cjs/rules/preferImportTag.d.ts +0 -2
  58. package/dist/cjs/rules/requireAsteriskPrefix.d.ts +0 -2
  59. package/dist/cjs/rules/requireDescription.d.ts +0 -2
  60. package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +0 -2
  61. package/dist/cjs/rules/requireExample.d.ts +0 -2
  62. package/dist/cjs/rules/requireFileOverview.d.ts +0 -2
  63. package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +0 -2
  64. package/dist/cjs/rules/requireJsdoc.d.ts +0 -24
  65. package/dist/cjs/rules/requireParam.d.ts +0 -3
  66. package/dist/cjs/rules/requireParamDescription.d.ts +0 -2
  67. package/dist/cjs/rules/requireParamName.d.ts +0 -2
  68. package/dist/cjs/rules/requireParamType.d.ts +0 -2
  69. package/dist/cjs/rules/requireProperty.d.ts +0 -2
  70. package/dist/cjs/rules/requirePropertyDescription.d.ts +0 -2
  71. package/dist/cjs/rules/requirePropertyName.d.ts +0 -2
  72. package/dist/cjs/rules/requirePropertyType.d.ts +0 -2
  73. package/dist/cjs/rules/requireRejects.d.ts +0 -2
  74. package/dist/cjs/rules/requireReturns.d.ts +0 -2
  75. package/dist/cjs/rules/requireReturnsCheck.d.ts +0 -2
  76. package/dist/cjs/rules/requireReturnsDescription.d.ts +0 -2
  77. package/dist/cjs/rules/requireReturnsType.d.ts +0 -2
  78. package/dist/cjs/rules/requireTags.d.ts +0 -2
  79. package/dist/cjs/rules/requireTemplate.d.ts +0 -2
  80. package/dist/cjs/rules/requireThrows.d.ts +0 -2
  81. package/dist/cjs/rules/requireYields.d.ts +0 -2
  82. package/dist/cjs/rules/requireYieldsCheck.d.ts +0 -2
  83. package/dist/cjs/rules/sortTags.d.ts +0 -2
  84. package/dist/cjs/rules/tagLines.d.ts +0 -2
  85. package/dist/cjs/rules/textEscaping.d.ts +0 -2
  86. package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +0 -2
  87. package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +0 -2
  88. package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +0 -2
  89. package/dist/cjs/rules/tsPreferFunctionType.d.ts +0 -2
  90. package/dist/cjs/rules/typeFormatting.d.ts +0 -2
  91. package/dist/cjs/rules/validTypes.d.ts +0 -2
  92. package/dist/cjs/tagNames.d.ts +0 -15
  93. package/dist/cjs/utils/hasReturnValue.d.ts +0 -19
  94. package/dist/defaultTagOrder.cjs +0 -46
  95. package/dist/defaultTagOrder.cjs.map +0 -1
  96. package/dist/exportParser.cjs +0 -732
  97. package/dist/exportParser.cjs.map +0 -1
  98. package/dist/generateDocs.cjs +0 -342
  99. package/dist/generateDocs.cjs.map +0 -1
  100. package/dist/generateOptions.cjs +0 -62
  101. package/dist/generateOptions.cjs.map +0 -1
  102. package/dist/generateRule.cjs +0 -248
  103. package/dist/generateRule.cjs.map +0 -1
  104. package/dist/generateRuleTypes.cjs +0 -24
  105. package/dist/generateRuleTypes.cjs.map +0 -1
  106. package/dist/getDefaultTagStructureForMode.cjs +0 -289
  107. package/dist/getDefaultTagStructureForMode.cjs.map +0 -1
  108. package/dist/getJsdocProcessorPlugin.cjs +0 -587
  109. package/dist/getJsdocProcessorPlugin.cjs.map +0 -1
  110. package/dist/getJsdocProcessorPlugin.cts +0 -5
  111. package/dist/index-cjs.cjs +0 -600
  112. package/dist/index-cjs.cjs.map +0 -1
  113. package/dist/index-cjs.d.ts +0 -27
  114. package/dist/index-esm.cjs +0 -162
  115. package/dist/index-esm.cjs.map +0 -1
  116. package/dist/index-esm.d.ts +0 -72
  117. package/dist/index.cjs +0 -748
  118. package/dist/index.cjs.cts +0 -3
  119. package/dist/index.cjs.map +0 -1
  120. package/dist/iterateJsdoc.cjs +0 -2150
  121. package/dist/iterateJsdoc.cjs.map +0 -1
  122. package/dist/iterateJsdoc.cts +0 -7
  123. package/dist/jsdocUtils.cjs +0 -1786
  124. package/dist/jsdocUtils.cjs.map +0 -1
  125. package/dist/rules/checkAccess.cjs +0 -40
  126. package/dist/rules/checkAccess.cjs.map +0 -1
  127. package/dist/rules/checkAlignment.cjs +0 -78
  128. package/dist/rules/checkAlignment.cjs.map +0 -1
  129. package/dist/rules/checkExamples.cjs +0 -521
  130. package/dist/rules/checkExamples.cjs.map +0 -1
  131. package/dist/rules/checkIndentation.cjs +0 -170
  132. package/dist/rules/checkIndentation.cjs.map +0 -1
  133. package/dist/rules/checkLineAlignment.cjs +0 -398
  134. package/dist/rules/checkLineAlignment.cjs.map +0 -1
  135. package/dist/rules/checkParamNames.cjs +0 -407
  136. package/dist/rules/checkParamNames.cjs.map +0 -1
  137. package/dist/rules/checkPropertyNames.cjs +0 -135
  138. package/dist/rules/checkPropertyNames.cjs.map +0 -1
  139. package/dist/rules/checkSyntax.cjs +0 -38
  140. package/dist/rules/checkSyntax.cjs.map +0 -1
  141. package/dist/rules/checkTagNames.cjs +0 -312
  142. package/dist/rules/checkTagNames.cjs.map +0 -1
  143. package/dist/rules/checkTemplateNames.cjs +0 -192
  144. package/dist/rules/checkTemplateNames.cjs.map +0 -1
  145. package/dist/rules/checkTypes.cjs +0 -111
  146. package/dist/rules/checkTypes.cjs.map +0 -1
  147. package/dist/rules/checkValues.cjs +0 -166
  148. package/dist/rules/checkValues.cjs.map +0 -1
  149. package/dist/rules/convertToJsdocComments.cjs +0 -356
  150. package/dist/rules/convertToJsdocComments.cjs.map +0 -1
  151. package/dist/rules/emptyTags.cjs +0 -98
  152. package/dist/rules/emptyTags.cjs.map +0 -1
  153. package/dist/rules/escapeInlineTags.cjs +0 -234
  154. package/dist/rules/escapeInlineTags.cjs.map +0 -1
  155. package/dist/rules/implementsOnClasses.cjs +0 -74
  156. package/dist/rules/implementsOnClasses.cjs.map +0 -1
  157. package/dist/rules/importsAsDependencies.cjs +0 -104
  158. package/dist/rules/importsAsDependencies.cjs.map +0 -1
  159. package/dist/rules/informativeDocs.cjs +0 -187
  160. package/dist/rules/informativeDocs.cjs.map +0 -1
  161. package/dist/rules/linesBeforeBlock.cjs +0 -120
  162. package/dist/rules/linesBeforeBlock.cjs.map +0 -1
  163. package/dist/rules/matchDescription.cjs +0 -356
  164. package/dist/rules/matchDescription.cjs.map +0 -1
  165. package/dist/rules/matchName.cjs +0 -160
  166. package/dist/rules/matchName.cjs.map +0 -1
  167. package/dist/rules/multilineBlocks.cjs +0 -431
  168. package/dist/rules/multilineBlocks.cjs.map +0 -1
  169. package/dist/rules/noBadBlocks.cjs +0 -100
  170. package/dist/rules/noBadBlocks.cjs.map +0 -1
  171. package/dist/rules/noBlankBlockDescriptions.cjs +0 -63
  172. package/dist/rules/noBlankBlockDescriptions.cjs.map +0 -1
  173. package/dist/rules/noBlankBlocks.cjs +0 -54
  174. package/dist/rules/noBlankBlocks.cjs.map +0 -1
  175. package/dist/rules/noDefaults.cjs +0 -102
  176. package/dist/rules/noDefaults.cjs.map +0 -1
  177. package/dist/rules/noMissingSyntax.cjs +0 -196
  178. package/dist/rules/noMissingSyntax.cjs.map +0 -1
  179. package/dist/rules/noMultiAsterisks.cjs +0 -126
  180. package/dist/rules/noMultiAsterisks.cjs.map +0 -1
  181. package/dist/rules/noRestrictedSyntax.cjs +0 -68
  182. package/dist/rules/noRestrictedSyntax.cjs.map +0 -1
  183. package/dist/rules/noTypes.cjs +0 -101
  184. package/dist/rules/noTypes.cjs.map +0 -1
  185. package/dist/rules/noUndefinedTypes.cjs +0 -616
  186. package/dist/rules/noUndefinedTypes.cjs.map +0 -1
  187. package/dist/rules/normalizeSeeLinks.cjs +0 -271
  188. package/dist/rules/normalizeSeeLinks.cjs.map +0 -1
  189. package/dist/rules/preferImportTag.cjs +0 -362
  190. package/dist/rules/preferImportTag.cjs.map +0 -1
  191. package/dist/rules/requireAsteriskPrefix.cjs +0 -190
  192. package/dist/rules/requireAsteriskPrefix.cjs.map +0 -1
  193. package/dist/rules/requireDescription.cjs +0 -164
  194. package/dist/rules/requireDescription.cjs.map +0 -1
  195. package/dist/rules/requireDescriptionCompleteSentence.cjs +0 -321
  196. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +0 -1
  197. package/dist/rules/requireExample.cjs +0 -136
  198. package/dist/rules/requireExample.cjs.map +0 -1
  199. package/dist/rules/requireFileOverview.cjs +0 -194
  200. package/dist/rules/requireFileOverview.cjs.map +0 -1
  201. package/dist/rules/requireHyphenBeforeParamDescription.cjs +0 -166
  202. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +0 -1
  203. package/dist/rules/requireJsdoc.cjs +0 -721
  204. package/dist/rules/requireJsdoc.cjs.map +0 -1
  205. package/dist/rules/requireParam.cjs +0 -772
  206. package/dist/rules/requireParam.cjs.map +0 -1
  207. package/dist/rules/requireParamDescription.cjs +0 -105
  208. package/dist/rules/requireParamDescription.cjs.map +0 -1
  209. package/dist/rules/requireParamName.cjs +0 -68
  210. package/dist/rules/requireParamName.cjs.map +0 -1
  211. package/dist/rules/requireParamType.cjs +0 -104
  212. package/dist/rules/requireParamType.cjs.map +0 -1
  213. package/dist/rules/requireProperty.cjs +0 -63
  214. package/dist/rules/requireProperty.cjs.map +0 -1
  215. package/dist/rules/requirePropertyDescription.cjs +0 -29
  216. package/dist/rules/requirePropertyDescription.cjs.map +0 -1
  217. package/dist/rules/requirePropertyName.cjs +0 -29
  218. package/dist/rules/requirePropertyName.cjs.map +0 -1
  219. package/dist/rules/requirePropertyType.cjs +0 -29
  220. package/dist/rules/requirePropertyType.cjs.map +0 -1
  221. package/dist/rules/requireRejects.cjs +0 -226
  222. package/dist/rules/requireRejects.cjs.map +0 -1
  223. package/dist/rules/requireReturns.cjs +0 -262
  224. package/dist/rules/requireReturns.cjs.map +0 -1
  225. package/dist/rules/requireReturnsCheck.cjs +0 -225
  226. package/dist/rules/requireReturnsCheck.cjs.map +0 -1
  227. package/dist/rules/requireReturnsDescription.cjs +0 -72
  228. package/dist/rules/requireReturnsDescription.cjs.map +0 -1
  229. package/dist/rules/requireReturnsType.cjs +0 -68
  230. package/dist/rules/requireReturnsType.cjs.map +0 -1
  231. package/dist/rules/requireTags.cjs +0 -74
  232. package/dist/rules/requireTags.cjs.map +0 -1
  233. package/dist/rules/requireTemplate.cjs +0 -220
  234. package/dist/rules/requireTemplate.cjs.map +0 -1
  235. package/dist/rules/requireThrows.cjs +0 -118
  236. package/dist/rules/requireThrows.cjs.map +0 -1
  237. package/dist/rules/requireYields.cjs +0 -224
  238. package/dist/rules/requireYields.cjs.map +0 -1
  239. package/dist/rules/requireYieldsCheck.cjs +0 -179
  240. package/dist/rules/requireYieldsCheck.cjs.map +0 -1
  241. package/dist/rules/sortTags.cjs +0 -656
  242. package/dist/rules/sortTags.cjs.map +0 -1
  243. package/dist/rules/tagLines.cjs +0 -374
  244. package/dist/rules/tagLines.cjs.map +0 -1
  245. package/dist/rules/textEscaping.cjs +0 -141
  246. package/dist/rules/textEscaping.cjs.map +0 -1
  247. package/dist/rules/tsMethodSignatureStyle.cjs +0 -240
  248. package/dist/rules/tsMethodSignatureStyle.cjs.map +0 -1
  249. package/dist/rules/tsNoEmptyObjectType.cjs +0 -62
  250. package/dist/rules/tsNoEmptyObjectType.cjs.map +0 -1
  251. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +0 -104
  252. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +0 -1
  253. package/dist/rules/tsPreferFunctionType.cjs +0 -110
  254. package/dist/rules/tsPreferFunctionType.cjs.map +0 -1
  255. package/dist/rules/typeFormatting.cjs +0 -607
  256. package/dist/rules/typeFormatting.cjs.map +0 -1
  257. package/dist/rules/validTypes.cjs +0 -324
  258. package/dist/rules/validTypes.cjs.map +0 -1
  259. package/dist/tagNames.cjs +0 -244
  260. package/dist/tagNames.cjs.map +0 -1
  261. package/dist/to-valid-identifier.cjs +0 -263
  262. package/dist/utils/hasReturnValue.cjs +0 -495
  263. package/dist/utils/hasReturnValue.cjs.map +0 -1
  264. package/rollup.config.js +0 -16
  265. package/src/getJsdocProcessorPlugin.cts +0 -5
  266. package/src/index-cjs.js +0 -760
  267. package/src/index-esm.js +0 -196
  268. package/src/index.cjs.cts +0 -3
  269. package/src/iterateJsdoc.cts +0 -7
@@ -1,54 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
- var _default = exports.default = (0, _iterateJsdoc.default)(({
10
- context,
11
- jsdoc,
12
- utils
13
- }) => {
14
- if (jsdoc.tags.length) {
15
- return;
16
- }
17
- const {
18
- description,
19
- lastDescriptionLine
20
- } = utils.getDescription();
21
- if (description.trim()) {
22
- return;
23
- }
24
- const {
25
- enableFixer
26
- } = context.options[0] || {};
27
- utils.reportJSDoc('No empty blocks', {
28
- line: lastDescriptionLine
29
- }, enableFixer ? () => {
30
- jsdoc.source.splice(0);
31
- } : null);
32
- }, {
33
- iterateAllJsdocs: true,
34
- meta: {
35
- docs: {
36
- description: 'Removes empty blocks with nothing but possibly line breaks',
37
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header'
38
- },
39
- fixable: 'code',
40
- schema: [{
41
- additionalProperties: false,
42
- properties: {
43
- enableFixer: {
44
- description: 'Whether or not to auto-remove the blank block. Defaults to `false`.',
45
- type: 'boolean'
46
- }
47
- },
48
- type: 'object'
49
- }],
50
- type: 'suggestion'
51
- }
52
- });
53
- module.exports = exports.default;
54
- //# sourceMappingURL=noBlankBlocks.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noBlankBlocks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noBlankBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n utils,\n}) => {\n if (jsdoc.tags.length) {\n return;\n }\n\n const {\n description,\n lastDescriptionLine,\n } = utils.getDescription();\n if (description.trim()) {\n return;\n }\n\n const {\n enableFixer,\n } = context.options[0] || {};\n\n utils.reportJSDoc(\n 'No empty blocks',\n {\n line: lastDescriptionLine,\n },\n enableFixer ? () => {\n jsdoc.source.splice(0);\n } : null,\n );\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Removes empty blocks with nothing but possibly line breaks',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n enableFixer: {\n description: 'Whether or not to auto-remove the blank block. Defaults to `false`.',\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAAA,iCAE/B,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL;AACF,CAAC,KAAK;EACJ,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;IACrB;EACF;EAEA,MAAM;IACJ,WAAW;IACX;EACF,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;EAC1B,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE;IACtB;EACF;EAEA,MAAM;IACJ;EACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,KAAK,CAAC,WAAW,CACf,iBAAiB,EACjB;IACE,IAAI,EAAE;EACR,CAAC,EACD,WAAW,GAAG,MAAM;IAClB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;EACxB,CAAC,GAAG,IACN,CAAC;AACH,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,4DAA4D;MACzE,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,WAAW,EAAE;UACX,WAAW,EAAE,qEAAqE;UAClF,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,102 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
- var _default = exports.default = (0, _iterateJsdoc.default)(({
10
- context,
11
- utils
12
- }) => {
13
- const {
14
- noOptionalParamNames
15
- } = context.options[0] || {};
16
- const paramTags = utils.getPresentTags(['param', 'arg', 'argument']);
17
- for (const tag of paramTags) {
18
- if (noOptionalParamNames && tag.optional) {
19
- utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {
20
- utils.changeTag(tag, {
21
- name: tag.name.replace(/([^=]*)(=.+)?/v, '$1')
22
- });
23
- });
24
- } else if (tag.default) {
25
- utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
26
- utils.changeTag(tag, {
27
- name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]')
28
- });
29
- });
30
- }
31
- }
32
- const defaultTags = utils.getPresentTags(['default', 'defaultvalue']);
33
- for (const tag of defaultTags) {
34
- if (tag.description.trim()) {
35
- utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
36
- utils.changeTag(tag, {
37
- description: '',
38
- postTag: ''
39
- });
40
- });
41
- }
42
- }
43
- }, {
44
- contextDefaults: true,
45
- meta: {
46
- docs: {
47
- description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',
48
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header'
49
- },
50
- fixable: 'code',
51
- schema: [{
52
- additionalProperties: false,
53
- properties: {
54
- contexts: {
55
- description: `Set this to an array of strings representing the AST context (or an object with
56
- optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
57
-
58
- \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
59
-
60
- Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
61
- \`FunctionExpression\`). Set to \`"any"\` if you want
62
- the rule to apply to any JSDoc block throughout your files (as is necessary
63
- for finding function blocks not attached to a function declaration or
64
- expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
65
- \`@method\`) (including those associated with an \`@interface\`).
66
-
67
- See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
68
- section of our Advanced docs for more on the expected format.`,
69
- items: {
70
- anyOf: [{
71
- type: 'string'
72
- }, {
73
- additionalProperties: false,
74
- properties: {
75
- comment: {
76
- type: 'string'
77
- },
78
- context: {
79
- type: 'string'
80
- }
81
- },
82
- type: 'object'
83
- }]
84
- },
85
- type: 'array'
86
- },
87
- noOptionalParamNames: {
88
- description: `Set this to \`true\` to report the presence of optional parameters. May be
89
- used if the project is insisting on optionality being indicated by
90
- the presence of ES6 default parameters (bearing in mind that such
91
- "defaults" are only applied when the supplied value is missing or
92
- \`undefined\` but not for \`null\` or other "falsey" values).`,
93
- type: 'boolean'
94
- }
95
- },
96
- type: 'object'
97
- }],
98
- type: 'suggestion'
99
- }
100
- });
101
- module.exports = exports.default;
102
- //# sourceMappingURL=noDefaults.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noDefaults.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noDefaults.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n const {\n noOptionalParamNames,\n } = context.options[0] || {};\n const paramTags = utils.getPresentTags([\n 'param', 'arg', 'argument',\n ]);\n for (const tag of paramTags) {\n if (noOptionalParamNames && tag.optional) {\n utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '$1'),\n });\n });\n } else if (tag.default) {\n utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]'),\n });\n });\n }\n }\n\n const defaultTags = utils.getPresentTags([\n 'default', 'defaultvalue',\n ]);\n for (const tag of defaultTags) {\n if (tag.description.trim()) {\n utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n description: '',\n postTag: '',\n });\n });\n }\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n contexts: {\n description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`, \\`FunctionDeclaration\\`,\n\\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n noOptionalParamNames: {\n description: `Set this to \\`true\\` to report the presence of optional parameters. May be\nused if the project is insisting on optionality being indicated by\nthe presence of ES6 default parameters (bearing in mind that such\n\"defaults\" are only applied when the supplied value is missing or\n\\`undefined\\` but not for \\`null\\` or other \"falsey\" values).`,\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAAA,iCAE/B,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP;AACF,CAAC,KAAK;EACJ,MAAM;IACJ;EACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,CACrC,OAAO,EAAE,KAAK,EAAE,UAAU,CAC3B,CAAC;EACF,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE;IAC3B,IAAI,oBAAoB,IAAI,GAAG,CAAC,QAAQ,EAAE;MACxC,KAAK,CAAC,WAAW,CAAC,8CAA8C,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM;QACrF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;UACnB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI;QAC/C,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE;MACtB,KAAK,CAAC,WAAW,CAAC,kCAAkC,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM;QACzE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;UACnB,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM;QACjD,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;EACF;EAEA,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,CACvC,SAAS,EAAE,cAAc,CAC1B,CAAC;EACF,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE;IAC7B,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE;MAC1B,KAAK,CAAC,WAAW,CAAC,wCAAwC,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM;QAC/E,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;UACnB,WAAW,EAAE,EAAE;UACf,OAAO,EAAE;QACX,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;EACF;AACF,CAAC,EAAE;EACD,eAAe,EAAE,IAAI;EACrB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,0FAA0F;MACvG,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClD,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,oBAAoB,EAAE;UACpB,WAAW,EAAE;AACzB;AACA;AACA;AACA,8DAA8D;UAClD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,196 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
- /**
10
- * @typedef {{
11
- * comment: string,
12
- * context: string,
13
- * message: string,
14
- * minimum: import('../iterateJsdoc.js').Integer
15
- * }} ContextObject
16
- */
17
-
18
- /**
19
- * @typedef {string|ContextObject} Context
20
- */
21
-
22
- /**
23
- * @param {import('../iterateJsdoc.js').StateObject} state
24
- * @returns {void}
25
- */
26
- const setDefaults = state => {
27
- if (!state.selectorMap) {
28
- state.selectorMap = {};
29
- }
30
- };
31
-
32
- /**
33
- * @param {import('../iterateJsdoc.js').StateObject} state
34
- * @param {string} selector
35
- * @param {string} comment
36
- * @returns {void}
37
- */
38
- const incrementSelector = (state, selector, comment) => {
39
- if (!state.selectorMap[selector]) {
40
- state.selectorMap[selector] = {};
41
- }
42
- if (!state.selectorMap[selector][comment]) {
43
- state.selectorMap[selector][comment] = 0;
44
- }
45
- state.selectorMap[selector][comment]++;
46
- };
47
- var _default = exports.default = (0, _iterateJsdoc.default)(({
48
- context,
49
- info: {
50
- comment
51
- },
52
- state,
53
- utils
54
- }) => {
55
- if (!context.options[0]) {
56
- // Handle error later
57
- return;
58
- }
59
-
60
- /**
61
- * @type {Context[]}
62
- */
63
- const contexts = context.options[0].contexts;
64
- const {
65
- contextStr
66
- } = utils.findContext(contexts, comment);
67
- setDefaults(state);
68
- incrementSelector(state, contextStr, String(comment));
69
- }, {
70
- contextSelected: true,
71
- exit({
72
- context,
73
- settings,
74
- state
75
- }) {
76
- if (!context.options.length && !settings.contexts) {
77
- context.report({
78
- loc: {
79
- end: {
80
- column: 1,
81
- line: 1
82
- },
83
- start: {
84
- column: 1,
85
- line: 1
86
- }
87
- },
88
- message: 'Rule `no-missing-syntax` is missing a `contexts` option.'
89
- });
90
- return;
91
- }
92
- setDefaults(state);
93
-
94
- /**
95
- * @type {Context[]}
96
- */
97
- const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;
98
-
99
- // Report when MISSING
100
- contexts.some(cntxt => {
101
- const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;
102
- const comment = typeof cntxt === 'string' ? '' : cntxt?.comment ?? '';
103
- const contextKey = contextStr === 'any' ? 'undefined' : contextStr;
104
- if ((!state.selectorMap[contextKey] || !state.selectorMap[contextKey][comment] || state.selectorMap[contextKey][comment] < (
105
- // @ts-expect-error comment would need an object, not string
106
- cntxt?.minimum ?? 1)) && (contextStr !== 'any' || Object.values(state.selectorMap).every(cmmnt => {
107
- return !cmmnt[comment] || cmmnt[comment] < (
108
- // @ts-expect-error comment would need an object, not string
109
- cntxt?.minimum ?? 1);
110
- }))) {
111
- const message = typeof cntxt === 'string' ? 'Syntax is required: {{context}}' : cntxt?.message ?? 'Syntax is required: {{context}}' + (comment ? ' with {{comment}}' : '');
112
- context.report({
113
- data: {
114
- comment,
115
- context: contextStr
116
- },
117
- loc: {
118
- end: {
119
- column: 1,
120
- line: 1
121
- },
122
- start: {
123
- column: 1,
124
- line: 1
125
- }
126
- },
127
- message
128
- });
129
- return true;
130
- }
131
- return false;
132
- });
133
- },
134
- matchContext: true,
135
- meta: {
136
- docs: {
137
- description: 'Reports when certain comment structures are always expected.',
138
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header'
139
- },
140
- schema: [{
141
- additionalProperties: false,
142
- properties: {
143
- contexts: {
144
- description: `Set this to an array of strings representing the AST context (or an object with
145
- optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
146
-
147
- \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
148
-
149
- Use the \`minimum\` property (defaults to 1) to indicate how many are required
150
- for the rule to be reported.
151
-
152
- Use the \`message\` property to indicate the specific error to be shown when an
153
- error is reported for that context being found missing. You may use
154
- \`{{context}}\` and \`{{comment}}\` with such messages. Defaults to
155
- \`"Syntax is required: {{context}}"\`, or with a comment, to
156
- \`"Syntax is required: {{context}} with {{comment}}"\`.
157
-
158
- Set to \`"any"\` if you want the rule to apply to any JSDoc block throughout
159
- your files (as is necessary for finding function blocks not attached to a
160
- function declaration or expression, i.e., \`@callback\` or \`@function\` (or its
161
- aliases \`@func\` or \`@method\`) (including those associated with an \`@interface\`).
162
-
163
- See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
164
- section of our Advanced docs for more on the expected format.`,
165
- items: {
166
- anyOf: [{
167
- type: 'string'
168
- }, {
169
- additionalProperties: false,
170
- properties: {
171
- comment: {
172
- type: 'string'
173
- },
174
- context: {
175
- type: 'string'
176
- },
177
- message: {
178
- type: 'string'
179
- },
180
- minimum: {
181
- type: 'integer'
182
- }
183
- },
184
- type: 'object'
185
- }]
186
- },
187
- type: 'array'
188
- }
189
- },
190
- type: 'object'
191
- }],
192
- type: 'suggestion'
193
- }
194
- });
195
- module.exports = exports.default;
196
- //# sourceMappingURL=noMissingSyntax.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noMissingSyntax.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noMissingSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {{\n * comment: string,\n * context: string,\n * message: string,\n * minimum: import('../iterateJsdoc.js').Integer\n * }} ContextObject\n */\n\n/**\n * @typedef {string|ContextObject} Context\n */\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n if (!state.selectorMap) {\n state.selectorMap = {};\n }\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @param {string} selector\n * @param {string} comment\n * @returns {void}\n */\nconst incrementSelector = (state, selector, comment) => {\n if (!state.selectorMap[selector]) {\n state.selectorMap[selector] = {};\n }\n\n if (!state.selectorMap[selector][comment]) {\n state.selectorMap[selector][comment] = 0;\n }\n\n state.selectorMap[selector][comment]++;\n};\n\nexport default iterateJsdoc(({\n context,\n info: {\n comment,\n },\n state,\n utils,\n}) => {\n if (!context.options[0]) {\n // Handle error later\n return;\n }\n\n /**\n * @type {Context[]}\n */\n const contexts = context.options[0].contexts;\n\n const {\n contextStr,\n } = utils.findContext(contexts, comment);\n\n setDefaults(state);\n\n incrementSelector(state, contextStr, String(comment));\n}, {\n contextSelected: true,\n exit ({\n context,\n settings,\n state,\n }) {\n if (!context.options.length && !settings.contexts) {\n context.report({\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message: 'Rule `no-missing-syntax` is missing a `contexts` option.',\n });\n\n return;\n }\n\n setDefaults(state);\n\n /**\n * @type {Context[]}\n */\n const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;\n\n // Report when MISSING\n contexts.some((cntxt) => {\n const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;\n const comment = typeof cntxt === 'string' ? '' : cntxt?.comment ?? '';\n\n const contextKey = contextStr === 'any' ? 'undefined' : contextStr;\n\n if (\n (!state.selectorMap[contextKey] ||\n !state.selectorMap[contextKey][comment] ||\n state.selectorMap[contextKey][comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n )) &&\n (contextStr !== 'any' || Object.values(state.selectorMap).every((cmmnt) => {\n return !cmmnt[comment] || cmmnt[comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n );\n }))\n ) {\n const message = typeof cntxt === 'string' ?\n 'Syntax is required: {{context}}' :\n cntxt?.message ?? ('Syntax is required: {{context}}' +\n (comment ? ' with {{comment}}' : ''));\n context.report({\n data: {\n comment,\n context: contextStr,\n },\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message,\n });\n\n return true;\n }\n\n return false;\n });\n },\n matchContext: true,\n meta: {\n docs: {\n description: 'Reports when certain comment structures are always expected.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n contexts: {\n description: `Set this to an array of strings representing the AST context (or an object with\noptional \\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nUse the \\`minimum\\` property (defaults to 1) to indicate how many are required\nfor the rule to be reported.\n\nUse the \\`message\\` property to indicate the specific error to be shown when an\nerror is reported for that context being found missing. You may use\n\\`{{context}}\\` and \\`{{comment}}\\` with such messages. Defaults to\n\\`\"Syntax is required: {{context}}\"\\`, or with a comment, to\n\\`\"Syntax is required: {{context}} with {{comment}}\"\\`.\n\nSet to \\`\"any\"\\` if you want the rule to apply to any JSDoc block throughout\nyour files (as is necessary for finding function blocks not attached to a\nfunction declaration or expression, i.e., \\`@callback\\` or \\`@function\\` (or its\naliases \\`@func\\` or \\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n message: {\n type: 'string',\n },\n minimum: {\n type: 'integer',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAI,KAAK,IAAK;EAC7B,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;IACtB,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,KAAK;EACtD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;IAChC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;EAClC;EAEA,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE;IACzC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;EAC1C;EAEA,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE;AACxC,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,IAAI,EAAE;IACJ;EACF,CAAC;EACD,KAAK;EACL;AACF,CAAC,KAAK;EACJ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;IACvB;IACA;EACF;;EAEA;AACF;AACA;EACE,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ;EAE5C,MAAM;IACJ;EACF,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC;EAExC,WAAW,CAAC,KAAK,CAAC;EAElB,iBAAiB,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC,EAAE;EACD,eAAe,EAAE,IAAI;EACrB,IAAI,CAAE;IACJ,OAAO;IACP,QAAQ;IACR;EACF,CAAC,EAAE;IACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;MACjD,OAAO,CAAC,MAAM,CAAC;QACb,GAAG,EAAE;UACH,GAAG,EAAE;YACH,MAAM,EAAE,CAAC;YACT,IAAI,EAAE;UACR,CAAC;UACD,KAAK,EAAE;YACL,MAAM,EAAE,CAAC;YACT,IAAI,EAAE;UACR;QACF,CAAC;QACD,OAAO,EAAE;MACX,CAAC,CAAC;MAEF;IACF;IAEA,WAAW,CAAC,KAAK,CAAC;;IAElB;AACJ;AACA;IACI,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,IAAI,QAAQ,EAAE,QAAQ;;IAE1E;IACA,QAAQ,CAAC,IAAI,CAAE,KAAK,IAAK;MACvB,MAAM,UAAU,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,GAAG,KAAK;MAC7E,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,GAAG,KAAK,EAAE,OAAO,IAAI,EAAE;MAErE,MAAM,UAAU,GAAG,UAAU,KAAK,KAAK,GAAG,WAAW,GAAG,UAAU;MAElE,IACE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,IAC/B,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IACvC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;MACpC;MACA,KAAK,EAAE,OAAO,IAAI,CAAC,CACpB,MACA,UAAU,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,KAAK,CAAE,KAAK,IAAK;QACzE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC;QACtC;QACA,KAAK,EAAE,OAAO,IAAI,CAAC,CACpB;MACH,CAAC,CAAC,CAAC,EACH;QACA,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,QAAQ,GACvC,iCAAiC,GACjC,KAAK,EAAE,OAAO,IAAK,iCAAiC,IACjD,OAAO,GAAG,mBAAmB,GAAG,EAAE,CAAE;QACzC,OAAO,CAAC,MAAM,CAAC;UACb,IAAI,EAAE;YACJ,OAAO;YACP,OAAO,EAAE;UACX,CAAC;UACD,GAAG,EAAE;YACH,GAAG,EAAE;cACH,MAAM,EAAE,CAAC;cACT,IAAI,EAAE;YACR,CAAC;YACD,KAAK,EAAE;cACL,MAAM,EAAE,CAAC;cACT,IAAI,EAAE;YACR;UACF,CAAC;UACD;QACF,CAAC,CAAC;QAEF,OAAO,IAAI;MACb;MAEA,OAAO,KAAK;IACd,CAAC,CAAC;EACJ,CAAC;EACD,YAAY,EAAE,IAAI;EAClB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,8DAA8D;MAC3E,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClD,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,126 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
- const middleAsterisksBlockWS = /^([\t ]|\*(?!\*))+/v;
10
- const middleAsterisksNoBlockWS = /^\*+/v;
11
- const endAsterisksSingleLineBlockWS = /\*((?:\*|(?: |\t))*)\*$/v;
12
- const endAsterisksMultipleLineBlockWS = /((?:\*|(?: |\t))*)\*$/v;
13
- const endAsterisksSingleLineNoBlockWS = /\*(\**)\*$/v;
14
- const endAsterisksMultipleLineNoBlockWS = /(\**)\*$/v;
15
- var _default = exports.default = (0, _iterateJsdoc.default)(({
16
- context,
17
- jsdoc,
18
- utils
19
- }) => {
20
- const {
21
- allowWhitespace = false,
22
- preventAtEnd = true,
23
- preventAtMiddleLines = true
24
- } = context.options[0] || {};
25
- const middleAsterisks = allowWhitespace ? middleAsterisksNoBlockWS : middleAsterisksBlockWS;
26
- jsdoc.source.some(({
27
- number,
28
- tokens
29
- }) => {
30
- const {
31
- delimiter,
32
- description,
33
- end,
34
- name,
35
- postDelimiter,
36
- tag,
37
- type
38
- } = tokens;
39
- if (preventAtMiddleLines && !end && !tag && !type && !name && (!allowWhitespace && middleAsterisks.test(description) || allowWhitespace && middleAsterisks.test(postDelimiter + description))) {
40
- // console.log('description', JSON.stringify(description));
41
- const fix = () => {
42
- tokens.description = description.replace(middleAsterisks, '');
43
- };
44
- utils.reportJSDoc('Should be no multiple asterisks on middle lines.', {
45
- line: number
46
- }, fix, true);
47
- return true;
48
- }
49
- if (!preventAtEnd || !end) {
50
- return false;
51
- }
52
- const isSingleLineBlock = delimiter === '/**';
53
- const delim = isSingleLineBlock ? '*' : delimiter;
54
- const endAsterisks = allowWhitespace ? isSingleLineBlock ? endAsterisksSingleLineNoBlockWS : endAsterisksMultipleLineNoBlockWS : isSingleLineBlock ? endAsterisksSingleLineBlockWS : endAsterisksMultipleLineBlockWS;
55
- const endingAsterisksAndSpaces = (allowWhitespace ? postDelimiter + description + delim : description + delim).match(endAsterisks);
56
- if (!endingAsterisksAndSpaces || !isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()) {
57
- return false;
58
- }
59
- const endFix = () => {
60
- if (!isSingleLineBlock) {
61
- tokens.delimiter = '';
62
- }
63
- tokens.description = (description + delim).replace(endAsterisks, '');
64
- };
65
- utils.reportJSDoc('Should be no multiple asterisks on end lines.', {
66
- line: number
67
- }, endFix, true);
68
- return true;
69
- });
70
- }, {
71
- iterateAllJsdocs: true,
72
- meta: {
73
- docs: {
74
- description: 'Prevents use of multiple asterisks at the beginning of lines.',
75
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md#repos-sticky-header'
76
- },
77
- fixable: 'code',
78
- schema: [{
79
- additionalProperties: false,
80
- properties: {
81
- allowWhitespace: {
82
- description: `Set to \`true\` if you wish to allow asterisks after a space (as with Markdown):
83
-
84
- \`\`\`js
85
- /**
86
- * *bold* text
87
- */
88
- \`\`\`
89
-
90
- Defaults to \`false\`.`,
91
- type: 'boolean'
92
- },
93
- preventAtEnd: {
94
- description: `Prevent the likes of this:
95
-
96
- \`\`\`js
97
- /**
98
- *
99
- *
100
- **/
101
- \`\`\`
102
-
103
- Defaults to \`true\`.`,
104
- type: 'boolean'
105
- },
106
- preventAtMiddleLines: {
107
- description: `Prevent the likes of this:
108
-
109
- \`\`\`js
110
- /**
111
- *
112
- **
113
- */
114
- \`\`\`
115
-
116
- Defaults to \`true\`.`,
117
- type: 'boolean'
118
- }
119
- },
120
- type: 'object'
121
- }],
122
- type: 'suggestion'
123
- }
124
- });
125
- module.exports = exports.default;
126
- //# sourceMappingURL=noMultiAsterisks.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noMultiAsterisks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noMultiAsterisks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst middleAsterisksBlockWS = /^([\\t ]|\\*(?!\\*))+/v;\nconst middleAsterisksNoBlockWS = /^\\*+/v;\n\nconst endAsterisksSingleLineBlockWS = /\\*((?:\\*|(?: |\\t))*)\\*$/v;\nconst endAsterisksMultipleLineBlockWS = /((?:\\*|(?: |\\t))*)\\*$/v;\n\nconst endAsterisksSingleLineNoBlockWS = /\\*(\\**)\\*$/v;\nconst endAsterisksMultipleLineNoBlockWS = /(\\**)\\*$/v;\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n utils,\n}) => {\n const {\n allowWhitespace = false,\n preventAtEnd = true,\n preventAtMiddleLines = true,\n } = context.options[0] || {};\n\n const middleAsterisks = allowWhitespace ? middleAsterisksNoBlockWS : middleAsterisksBlockWS;\n\n jsdoc.source.some(({\n number,\n tokens,\n }) => {\n const {\n delimiter,\n description,\n end,\n name,\n postDelimiter,\n tag,\n type,\n } = tokens;\n\n if (\n preventAtMiddleLines &&\n !end && !tag && !type && !name &&\n (\n !allowWhitespace && middleAsterisks.test(description) ||\n allowWhitespace && middleAsterisks.test(postDelimiter + description)\n )\n ) {\n // console.log('description', JSON.stringify(description));\n const fix = () => {\n tokens.description = description.replace(middleAsterisks, '');\n };\n\n utils.reportJSDoc(\n 'Should be no multiple asterisks on middle lines.',\n {\n line: number,\n },\n fix,\n true,\n );\n\n return true;\n }\n\n if (!preventAtEnd || !end) {\n return false;\n }\n\n const isSingleLineBlock = delimiter === '/**';\n const delim = isSingleLineBlock ? '*' : delimiter;\n const endAsterisks = allowWhitespace ?\n (isSingleLineBlock ? endAsterisksSingleLineNoBlockWS : endAsterisksMultipleLineNoBlockWS) :\n (isSingleLineBlock ? endAsterisksSingleLineBlockWS : endAsterisksMultipleLineBlockWS);\n\n const endingAsterisksAndSpaces = (\n allowWhitespace ? postDelimiter + description + delim : description + delim\n ).match(\n endAsterisks,\n );\n\n if (\n !endingAsterisksAndSpaces ||\n !isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()\n ) {\n return false;\n }\n\n const endFix = () => {\n if (!isSingleLineBlock) {\n tokens.delimiter = '';\n }\n\n tokens.description = (description + delim).replace(endAsterisks, '');\n };\n\n utils.reportJSDoc(\n 'Should be no multiple asterisks on end lines.',\n {\n line: number,\n },\n endFix,\n true,\n );\n\n return true;\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Prevents use of multiple asterisks at the beginning of lines.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n allowWhitespace: {\n description: `Set to \\`true\\` if you wish to allow asterisks after a space (as with Markdown):\n\n\\`\\`\\`js\n/**\n * *bold* text\n */\n\\`\\`\\`\n\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n preventAtEnd: {\n description: `Prevent the likes of this:\n\n\\`\\`\\`js\n/**\n *\n *\n **/\n\\`\\`\\`\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n preventAtMiddleLines: {\n description: `Prevent the likes of this:\n\n\\`\\`\\`js\n/**\n *\n **\n */\n\\`\\`\\`\n\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C,MAAM,sBAAsB,GAAG,qBAAqB;AACpD,MAAM,wBAAwB,GAAG,OAAO;AAExC,MAAM,6BAA6B,GAAG,0BAA0B;AAChE,MAAM,+BAA+B,GAAG,wBAAwB;AAEhE,MAAM,+BAA+B,GAAG,aAAa;AACrD,MAAM,iCAAiC,GAAG,WAAW;AAAC,iCAEvC,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,eAAe,GAAG,KAAK;IACvB,YAAY,GAAG,IAAI;IACnB,oBAAoB,GAAG;EACzB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM,eAAe,GAAG,eAAe,GAAG,wBAAwB,GAAG,sBAAsB;EAE3F,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjB,MAAM;IACN;EACF,CAAC,KAAK;IACJ,MAAM;MACJ,SAAS;MACT,WAAW;MACX,GAAG;MACH,IAAI;MACJ,aAAa;MACb,GAAG;MACH;IACF,CAAC,GAAG,MAAM;IAEV,IACE,oBAAoB,IACpB,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAE5B,CAAC,eAAe,IAAI,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,IACrD,eAAe,IAAI,eAAe,CAAC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,CACrE,EACD;MACA;MACA,MAAM,GAAG,GAAG,MAAM;QAChB,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;MAC/D,CAAC;MAED,KAAK,CAAC,WAAW,CACf,kDAAkD,EAClD;QACE,IAAI,EAAE;MACR,CAAC,EACD,GAAG,EACH,IACF,CAAC;MAED,OAAO,IAAI;IACb;IAEA,IAAI,CAAC,YAAY,IAAI,CAAC,GAAG,EAAE;MACzB,OAAO,KAAK;IACd;IAEA,MAAM,iBAAiB,GAAG,SAAS,KAAK,KAAK;IAC7C,MAAM,KAAK,GAAG,iBAAiB,GAAG,GAAG,GAAG,SAAS;IACjD,MAAM,YAAY,GAAG,eAAe,GACjC,iBAAiB,GAAG,+BAA+B,GAAG,iCAAiC,GACvF,iBAAiB,GAAG,6BAA6B,GAAG,+BAAgC;IAEvF,MAAM,wBAAwB,GAAG,CAC/B,eAAe,GAAG,aAAa,GAAG,WAAW,GAAG,KAAK,GAAG,WAAW,GAAG,KAAK,EAC3E,KAAK,CACL,YACF,CAAC;IAED,IACE,CAAC,wBAAwB,IACzB,CAAC,iBAAiB,IAAI,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EACxF;MACA,OAAO,KAAK;IACd;IAEA,MAAM,MAAM,GAAG,MAAM;MACnB,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,CAAC,SAAS,GAAG,EAAE;MACvB;MAEA,MAAM,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,KAAK,EAAE,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,WAAW,CACf,+CAA+C,EAC/C;MACE,IAAI,EAAE;IACR,CAAC,EACD,MAAM,EACN,IACF,CAAC;IAED,OAAO,IAAI;EACb,CAAC,CAAC;AACJ,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,+DAA+D;MAC5E,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,eAAe,EAAE;UACf,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,uBAAuB;UACX,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,oBAAoB,EAAE;UACpB,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,sBAAsB;UACV,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,68 +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 _default = exports.default = (0, _buildForbidRuleDefinition.buildForbidRuleDefinition)({
9
- getContexts(context, report) {
10
- if (!context.options.length) {
11
- report('Rule `no-restricted-syntax` is missing a `contexts` option.');
12
- return false;
13
- }
14
- const {
15
- contexts
16
- } = context.options[0];
17
- return contexts;
18
- },
19
- schema: [{
20
- additionalProperties: false,
21
- properties: {
22
- contexts: {
23
- description: `Set this to an array of strings representing the AST context (or an object with
24
- \`context\` and \`comment\` properties) where you wish the rule to be applied.
25
-
26
- \`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
27
-
28
- Use the \`message\` property to indicate the specific error to be shown when an
29
- error is reported for that context being found. Defaults to
30
- \`"Syntax is restricted: {{context}}"\`, or with a comment, to
31
- \`"Syntax is restricted: {{context}} with {{comment}}"\`.
32
-
33
- Set to \`"any"\` if you want the rule to apply to any JSDoc block throughout
34
- your files (as is necessary for finding function blocks not attached to a
35
- function declaration or expression, i.e., \`@callback\` or \`@function\` (or its
36
- aliases \`@func\` or \`@method\`) (including those associated with an \`@interface\`).
37
-
38
- See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
39
- section of our Advanced docs for more on the expected format.`,
40
- items: {
41
- anyOf: [{
42
- type: 'string'
43
- }, {
44
- additionalProperties: false,
45
- properties: {
46
- comment: {
47
- type: 'string'
48
- },
49
- context: {
50
- type: 'string'
51
- },
52
- message: {
53
- type: 'string'
54
- }
55
- },
56
- type: 'object'
57
- }]
58
- },
59
- type: 'array'
60
- }
61
- },
62
- required: ['contexts'],
63
- type: 'object'
64
- }],
65
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header'
66
- });
67
- module.exports = exports.default;
68
- //# sourceMappingURL=noRestrictedSyntax.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noRestrictedSyntax.cjs","names":["buildForbidRuleDefinition"],"sources":["../../src/rules/noRestrictedSyntax.js"],"sourcesContent":["import {\n buildForbidRuleDefinition,\n} from '../buildForbidRuleDefinition.js';\n\nexport default buildForbidRuleDefinition({\n getContexts (context, report) {\n if (!context.options.length) {\n report('Rule `no-restricted-syntax` is missing a `contexts` option.');\n return false;\n }\n\n const {\n contexts,\n } = context.options[0];\n\n return contexts;\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n contexts: {\n description: `Set this to an array of strings representing the AST context (or an object with\n\\`context\\` and \\`comment\\` properties) where you wish the rule to be applied.\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nUse the \\`message\\` property to indicate the specific error to be shown when an\nerror is reported for that context being found. Defaults to\n\\`\"Syntax is restricted: {{context}}\"\\`, or with a comment, to\n\\`\"Syntax is restricted: {{context}} with {{comment}}\"\\`.\n\nSet to \\`\"any\"\\` if you want the rule to apply to any JSDoc block throughout\nyour files (as is necessary for finding function blocks not attached to a\nfunction declaration or expression, i.e., \\`@callback\\` or \\`@function\\` (or its\naliases \\`@func\\` or \\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n message: {\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n },\n required: [\n 'contexts',\n ],\n type: 'object',\n },\n ],\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',\n});\n"],"mappings":";;;;;;AAAA;AAEyC,iCAE1B,IAAAA,2BAAA,yBAAyB,EAAC;EACvC,WAAW,CAAE,OAAO,EAAE,MAAM,EAAE;IAC5B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE;MAC3B,MAAM,CAAC,6DAA6D,CAAC;MACrE,OAAO,KAAK;IACd;IAEA,MAAM;MACJ;IACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtB,OAAO,QAAQ;EACjB,CAAC;EACD,MAAM,EAAE,CACN;IACE,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;MACV,QAAQ,EAAE;QACR,WAAW,EAAE;AACvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;QACpD,KAAK,EAAE;UACL,KAAK,EAAE,CACL;YACE,IAAI,EAAE;UACR,CAAC,EACD;YACE,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;cACV,OAAO,EAAE;gBACP,IAAI,EAAE;cACR,CAAC;cACD,OAAO,EAAE;gBACP,IAAI,EAAE;cACR,CAAC;cACD,OAAO,EAAE;gBACP,IAAI,EAAE;cACR;YACF,CAAC;YACD,IAAI,EAAE;UACR,CAAC;QAEL,CAAC;QACD,IAAI,EAAE;MACR;IACF,CAAC;IACD,QAAQ,EAAE,CACR,UAAU,CACX;IACD,IAAI,EAAE;EACR,CAAC,CACF;EACD,GAAG,EAAE;AACP,CAAC,CAAC;AAAA","ignoreList":[]}