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
package/dist/tagNames.cjs DELETED
@@ -1,244 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.typeScriptTags = exports.jsdocTags = exports.closureTags = void 0;
7
- /**
8
- * @typedef {{
9
- * [key: string]: string[]
10
- * }} AliasedTags
11
- */
12
-
13
- /**
14
- * @type {AliasedTags}
15
- */
16
- const jsdocTagsUndocumented = {
17
- // Undocumented but present; see
18
- // https://github.com/jsdoc/jsdoc/issues/1283#issuecomment-516816802
19
- // https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594
20
- modifies: []
21
- };
22
-
23
- /**
24
- * @type {AliasedTags}
25
- */
26
- const jsdocTags = exports.jsdocTags = {
27
- ...jsdocTagsUndocumented,
28
- abstract: ['virtual'],
29
- access: [],
30
- alias: [],
31
- async: [],
32
- augments: ['extends'],
33
- author: [],
34
- borrows: [],
35
- callback: [],
36
- class: ['constructor'],
37
- classdesc: [],
38
- constant: ['const'],
39
- constructs: [],
40
- copyright: [],
41
- default: ['defaultvalue'],
42
- deprecated: [],
43
- description: ['desc'],
44
- enum: [],
45
- event: [],
46
- example: [],
47
- exports: [],
48
- external: ['host'],
49
- file: ['fileoverview', 'overview'],
50
- fires: ['emits'],
51
- function: ['func', 'method'],
52
- generator: [],
53
- global: [],
54
- hideconstructor: [],
55
- ignore: [],
56
- implements: [],
57
- inheritdoc: [],
58
- // Allowing casing distinct from jsdoc `definitions.js` (required in Closure)
59
- inheritDoc: [],
60
- inner: [],
61
- instance: [],
62
- interface: [],
63
- kind: [],
64
- lends: [],
65
- license: [],
66
- listens: [],
67
- member: ['var'],
68
- memberof: [],
69
- 'memberof!': [],
70
- mixes: [],
71
- mixin: [],
72
- module: [],
73
- name: [],
74
- namespace: [],
75
- override: [],
76
- package: [],
77
- param: ['arg', 'argument'],
78
- private: [],
79
- property: ['prop'],
80
- protected: [],
81
- public: [],
82
- readonly: [],
83
- requires: [],
84
- returns: ['return'],
85
- see: [],
86
- since: [],
87
- static: [],
88
- summary: [],
89
- this: [],
90
- throws: ['exception'],
91
- todo: [],
92
- tutorial: [],
93
- type: [],
94
- typedef: [],
95
- variation: [],
96
- version: [],
97
- yields: ['yield']
98
- };
99
-
100
- /**
101
- * @see {@link https://tsdoc.org/}
102
- * @type {AliasedTags}
103
- */
104
- const tsdocTags = {
105
- alpha: [],
106
- beta: [],
107
- decorator: [],
108
- eventProperty: [],
109
- experimental: [],
110
- packageDocumentation: [],
111
- privateRemarks: [],
112
- remarks: [],
113
- sealed: []
114
- };
115
-
116
- /**
117
- * @see {@link https://typedoc.org/documents/Tags.html}
118
- * @type {AliasedTags}
119
- */
120
- const typedocTags = {
121
- category: [],
122
- // https://typedoc.org/documents/Tags._category.html#category-descriptions
123
- categoryDescription: [],
124
- // https://typedoc.org/documents/Tags._group.html#disablegroups
125
- disableGroups: [],
126
- document: [],
127
- expand: [],
128
- // https://typedoc.org/documents/Tags._expand.html#expandtype
129
- expandType: [],
130
- group: [],
131
- // https://typedoc.org/documents/Tags._group.html#groupdescription
132
- groupDescription: [],
133
- hidden: [],
134
- // https://typedoc.org/documents/Tags._category.html#navigation-customization
135
- hideCategories: [],
136
- // https://typedoc.org/documents/Tags._group.html#navigation-customization
137
- hideGroups: [],
138
- inline: [],
139
- // https://typedoc.org/documents/Tags._inline.html#inlinetype
140
- inlineType: [],
141
- mergeModuleWith: [],
142
- // https://typedoc.org/documents/Tags._expand.html#preventexpand
143
- preventExpand: [],
144
- // https://typedoc.org/documents/Tags._inline.html#preventinline
145
- preventInline: [],
146
- primaryExport: [],
147
- // https://typedoc.org/documents/Tags._category.html#navigation-customization
148
- showCategories: [],
149
- // https://typedoc.org/documents/Tags._group.html#navigation-customization
150
- showGroups: [],
151
- sortStrategy: [],
152
- useDeclaredType: []
153
- };
154
-
155
- /**
156
- * @type {AliasedTags}
157
- */
158
- const typeScriptTags = exports.typeScriptTags = {
159
- ...jsdocTags,
160
- ...tsdocTags,
161
- ...typedocTags,
162
- // https://github.com/microsoft/TypeScript/issues/22160
163
- // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
164
- import: [],
165
- // https://www.typescriptlang.org/tsconfig/#stripInternal
166
- internal: [],
167
- // https://typedoc.org/documents/Tags.TypeScript_Tags.html
168
- jsx: [],
169
- // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc
170
- overload: [],
171
- // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#satisfies-support-in-jsdoc
172
- satisfies: [],
173
- // `@template` is also in TypeScript per:
174
- // https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#template
175
- template: [
176
- // Alias as per https://typedoc.org/documents/Tags._typeParam.html
177
- 'typeParam']
178
- };
179
-
180
- /**
181
- * @type {AliasedTags}
182
- */
183
- const undocumentedClosureTags = {
184
- // These are in Closure source but not in jsdoc source nor in the Closure
185
- // docs: https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java
186
- closurePrimitive: [],
187
- customElement: [],
188
- expose: [],
189
- hidden: [],
190
- idGenerator: [],
191
- meaning: [],
192
- mixinClass: [],
193
- mixinFunction: [],
194
- ngInject: [],
195
- owner: [],
196
- typeSummary: [],
197
- wizaction: []
198
- };
199
- const {
200
- /* eslint-disable no-unused-vars */
201
- inheritdoc,
202
- internal,
203
- overload,
204
- // Will be inverted to prefer `return`
205
- returns,
206
- satisfies,
207
- /* eslint-enable no-unused-vars */
208
- ...typeScriptTagsInClosure
209
- } = typeScriptTags;
210
-
211
- /**
212
- * @type {AliasedTags}
213
- */
214
- const closureTags = exports.closureTags = {
215
- ...typeScriptTagsInClosure,
216
- ...undocumentedClosureTags,
217
- // From https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
218
- // These are all recognized in https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js
219
- // except for the experimental `noinline` and the casing differences noted below
220
-
221
- // Defined as a synonym of `const` in jsdoc `definitions.js`
222
- define: [],
223
- dict: [],
224
- export: [],
225
- externs: [],
226
- final: [],
227
- // With casing distinct from jsdoc `definitions.js`
228
- implicitCast: [],
229
- noalias: [],
230
- nocollapse: [],
231
- nocompile: [],
232
- noinline: [],
233
- nosideeffects: [],
234
- polymer: [],
235
- polymerBehavior: [],
236
- preserve: [],
237
- // Defined as a synonym of `interface` in jsdoc `definitions.js`
238
- record: [],
239
- return: ['returns'],
240
- struct: [],
241
- suppress: [],
242
- unrestricted: []
243
- };
244
- //# sourceMappingURL=tagNames.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tagNames.cjs","names":[],"sources":["../src/tagNames.js"],"sourcesContent":["/**\n * @typedef {{\n * [key: string]: string[]\n * }} AliasedTags\n */\n\n/**\n * @type {AliasedTags}\n */\nconst jsdocTagsUndocumented = {\n // Undocumented but present; see\n // https://github.com/jsdoc/jsdoc/issues/1283#issuecomment-516816802\n // https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594\n modifies: [],\n};\n\n/**\n * @type {AliasedTags}\n */\nconst jsdocTags = {\n ...jsdocTagsUndocumented,\n abstract: [\n 'virtual',\n ],\n access: [],\n alias: [],\n async: [],\n augments: [\n 'extends',\n ],\n author: [],\n borrows: [],\n callback: [],\n class: [\n 'constructor',\n ],\n classdesc: [],\n constant: [\n 'const',\n ],\n constructs: [],\n copyright: [],\n default: [\n 'defaultvalue',\n ],\n deprecated: [],\n description: [\n 'desc',\n ],\n enum: [],\n event: [],\n example: [],\n exports: [],\n external: [\n 'host',\n ],\n file: [\n 'fileoverview',\n 'overview',\n ],\n fires: [\n 'emits',\n ],\n function: [\n 'func',\n 'method',\n ],\n generator: [],\n global: [],\n hideconstructor: [],\n ignore: [],\n implements: [],\n inheritdoc: [],\n\n // Allowing casing distinct from jsdoc `definitions.js` (required in Closure)\n inheritDoc: [],\n\n inner: [],\n instance: [],\n interface: [],\n kind: [],\n lends: [],\n license: [],\n listens: [],\n member: [\n 'var',\n ],\n memberof: [],\n 'memberof!': [],\n mixes: [],\n mixin: [],\n\n module: [],\n name: [],\n namespace: [],\n override: [],\n package: [],\n param: [\n 'arg',\n 'argument',\n ],\n private: [],\n property: [\n 'prop',\n ],\n protected: [],\n public: [],\n readonly: [],\n requires: [],\n returns: [\n 'return',\n ],\n see: [],\n since: [],\n static: [],\n summary: [],\n\n this: [],\n throws: [\n 'exception',\n ],\n todo: [],\n tutorial: [],\n type: [],\n typedef: [],\n variation: [],\n version: [],\n yields: [\n 'yield',\n ],\n};\n\n/**\n * @see {@link https://tsdoc.org/}\n * @type {AliasedTags}\n */\nconst tsdocTags = {\n alpha: [],\n beta: [],\n decorator: [],\n eventProperty: [],\n experimental: [],\n packageDocumentation: [],\n privateRemarks: [],\n remarks: [],\n sealed: [],\n};\n\n/**\n * @see {@link https://typedoc.org/documents/Tags.html}\n * @type {AliasedTags}\n */\nconst typedocTags = {\n category: [],\n // https://typedoc.org/documents/Tags._category.html#category-descriptions\n categoryDescription: [],\n // https://typedoc.org/documents/Tags._group.html#disablegroups\n disableGroups: [],\n document: [],\n expand: [],\n // https://typedoc.org/documents/Tags._expand.html#expandtype\n expandType: [],\n group: [],\n // https://typedoc.org/documents/Tags._group.html#groupdescription\n groupDescription: [],\n hidden: [],\n // https://typedoc.org/documents/Tags._category.html#navigation-customization\n hideCategories: [],\n // https://typedoc.org/documents/Tags._group.html#navigation-customization\n hideGroups: [],\n inline: [],\n // https://typedoc.org/documents/Tags._inline.html#inlinetype\n inlineType: [],\n mergeModuleWith: [],\n // https://typedoc.org/documents/Tags._expand.html#preventexpand\n preventExpand: [],\n // https://typedoc.org/documents/Tags._inline.html#preventinline\n preventInline: [],\n primaryExport: [],\n // https://typedoc.org/documents/Tags._category.html#navigation-customization\n showCategories: [],\n // https://typedoc.org/documents/Tags._group.html#navigation-customization\n showGroups: [],\n sortStrategy: [],\n useDeclaredType: [],\n};\n\n/**\n * @type {AliasedTags}\n */\nconst typeScriptTags = {\n ...jsdocTags,\n ...tsdocTags,\n ...typedocTags,\n\n // https://github.com/microsoft/TypeScript/issues/22160\n // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag\n import: [],\n\n // https://www.typescriptlang.org/tsconfig/#stripInternal\n internal: [],\n\n // https://typedoc.org/documents/Tags.TypeScript_Tags.html\n jsx: [],\n\n // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc\n overload: [],\n\n // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#satisfies-support-in-jsdoc\n satisfies: [],\n\n // `@template` is also in TypeScript per:\n // https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#template\n template: [\n // Alias as per https://typedoc.org/documents/Tags._typeParam.html\n 'typeParam',\n ],\n};\n\n/**\n * @type {AliasedTags}\n */\nconst undocumentedClosureTags = {\n // These are in Closure source but not in jsdoc source nor in the Closure\n // docs: https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java\n closurePrimitive: [],\n customElement: [],\n expose: [],\n hidden: [],\n idGenerator: [],\n meaning: [],\n mixinClass: [],\n mixinFunction: [],\n ngInject: [],\n owner: [],\n typeSummary: [],\n wizaction: [],\n};\n\nconst {\n /* eslint-disable no-unused-vars */\n inheritdoc,\n internal,\n overload,\n // Will be inverted to prefer `return`\n returns,\n\n satisfies,\n /* eslint-enable no-unused-vars */\n ...typeScriptTagsInClosure\n} = typeScriptTags;\n\n/**\n * @type {AliasedTags}\n */\nconst closureTags = {\n ...typeScriptTagsInClosure,\n ...undocumentedClosureTags,\n\n // From https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler\n // These are all recognized in https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js\n // except for the experimental `noinline` and the casing differences noted below\n\n // Defined as a synonym of `const` in jsdoc `definitions.js`\n define: [],\n\n dict: [],\n export: [],\n externs: [],\n final: [],\n\n // With casing distinct from jsdoc `definitions.js`\n implicitCast: [],\n\n noalias: [],\n nocollapse: [],\n nocompile: [],\n noinline: [],\n nosideeffects: [],\n polymer: [],\n polymerBehavior: [],\n preserve: [],\n\n // Defined as a synonym of `interface` in jsdoc `definitions.js`\n record: [],\n\n return: [\n 'returns',\n ],\n\n struct: [],\n suppress: [],\n\n unrestricted: [],\n};\n\nexport {\n closureTags,\n jsdocTags,\n typeScriptTags,\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA,MAAM,qBAAqB,GAAG;EAC5B;EACA;EACA;EACA,QAAQ,EAAE;AACZ,CAAC;;AAED;AACA;AACA;AACA,MAAM,SAAS,uBAAG;EAChB,GAAG,qBAAqB;EACxB,QAAQ,EAAE,CACR,SAAS,CACV;EACD,MAAM,EAAE,EAAE;EACV,KAAK,EAAE,EAAE;EACT,KAAK,EAAE,EAAE;EACT,QAAQ,EAAE,CACR,SAAS,CACV;EACD,MAAM,EAAE,EAAE;EACV,OAAO,EAAE,EAAE;EACX,QAAQ,EAAE,EAAE;EACZ,KAAK,EAAE,CACL,aAAa,CACd;EACD,SAAS,EAAE,EAAE;EACb,QAAQ,EAAE,CACR,OAAO,CACR;EACD,UAAU,EAAE,EAAE;EACd,SAAS,EAAE,EAAE;EACb,OAAO,EAAE,CACP,cAAc,CACf;EACD,UAAU,EAAE,EAAE;EACd,WAAW,EAAE,CACX,MAAM,CACP;EACD,IAAI,EAAE,EAAE;EACR,KAAK,EAAE,EAAE;EACT,OAAO,EAAE,EAAE;EACX,OAAO,EAAE,EAAE;EACX,QAAQ,EAAE,CACR,MAAM,CACP;EACD,IAAI,EAAE,CACJ,cAAc,EACd,UAAU,CACX;EACD,KAAK,EAAE,CACL,OAAO,CACR;EACD,QAAQ,EAAE,CACR,MAAM,EACN,QAAQ,CACT;EACD,SAAS,EAAE,EAAE;EACb,MAAM,EAAE,EAAE;EACV,eAAe,EAAE,EAAE;EACnB,MAAM,EAAE,EAAE;EACV,UAAU,EAAE,EAAE;EACd,UAAU,EAAE,EAAE;EAEd;EACA,UAAU,EAAE,EAAE;EAEd,KAAK,EAAE,EAAE;EACT,QAAQ,EAAE,EAAE;EACZ,SAAS,EAAE,EAAE;EACb,IAAI,EAAE,EAAE;EACR,KAAK,EAAE,EAAE;EACT,OAAO,EAAE,EAAE;EACX,OAAO,EAAE,EAAE;EACX,MAAM,EAAE,CACN,KAAK,CACN;EACD,QAAQ,EAAE,EAAE;EACZ,WAAW,EAAE,EAAE;EACf,KAAK,EAAE,EAAE;EACT,KAAK,EAAE,EAAE;EAET,MAAM,EAAE,EAAE;EACV,IAAI,EAAE,EAAE;EACR,SAAS,EAAE,EAAE;EACb,QAAQ,EAAE,EAAE;EACZ,OAAO,EAAE,EAAE;EACX,KAAK,EAAE,CACL,KAAK,EACL,UAAU,CACX;EACD,OAAO,EAAE,EAAE;EACX,QAAQ,EAAE,CACR,MAAM,CACP;EACD,SAAS,EAAE,EAAE;EACb,MAAM,EAAE,EAAE;EACV,QAAQ,EAAE,EAAE;EACZ,QAAQ,EAAE,EAAE;EACZ,OAAO,EAAE,CACP,QAAQ,CACT;EACD,GAAG,EAAE,EAAE;EACP,KAAK,EAAE,EAAE;EACT,MAAM,EAAE,EAAE;EACV,OAAO,EAAE,EAAE;EAEX,IAAI,EAAE,EAAE;EACR,MAAM,EAAE,CACN,WAAW,CACZ;EACD,IAAI,EAAE,EAAE;EACR,QAAQ,EAAE,EAAE;EACZ,IAAI,EAAE,EAAE;EACR,OAAO,EAAE,EAAE;EACX,SAAS,EAAE,EAAE;EACb,OAAO,EAAE,EAAE;EACX,MAAM,EAAE,CACN,OAAO;AAEX,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,SAAS,GAAG;EAChB,KAAK,EAAE,EAAE;EACT,IAAI,EAAE,EAAE;EACR,SAAS,EAAE,EAAE;EACb,aAAa,EAAE,EAAE;EACjB,YAAY,EAAE,EAAE;EAChB,oBAAoB,EAAE,EAAE;EACxB,cAAc,EAAE,EAAE;EAClB,OAAO,EAAE,EAAE;EACX,MAAM,EAAE;AACV,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAG;EAClB,QAAQ,EAAE,EAAE;EACZ;EACA,mBAAmB,EAAE,EAAE;EACvB;EACA,aAAa,EAAE,EAAE;EACjB,QAAQ,EAAE,EAAE;EACZ,MAAM,EAAE,EAAE;EACV;EACA,UAAU,EAAE,EAAE;EACd,KAAK,EAAE,EAAE;EACT;EACA,gBAAgB,EAAE,EAAE;EACpB,MAAM,EAAE,EAAE;EACV;EACA,cAAc,EAAE,EAAE;EAClB;EACA,UAAU,EAAE,EAAE;EACd,MAAM,EAAE,EAAE;EACV;EACA,UAAU,EAAE,EAAE;EACd,eAAe,EAAE,EAAE;EACnB;EACA,aAAa,EAAE,EAAE;EACjB;EACA,aAAa,EAAE,EAAE;EACjB,aAAa,EAAE,EAAE;EACjB;EACA,cAAc,EAAE,EAAE;EAClB;EACA,UAAU,EAAE,EAAE;EACd,YAAY,EAAE,EAAE;EAChB,eAAe,EAAE;AACnB,CAAC;;AAED;AACA;AACA;AACA,MAAM,cAAc,4BAAG;EACrB,GAAG,SAAS;EACZ,GAAG,SAAS;EACZ,GAAG,WAAW;EAEd;EACA;EACA,MAAM,EAAE,EAAE;EAEV;EACA,QAAQ,EAAE,EAAE;EAEZ;EACA,GAAG,EAAE,EAAE;EAEP;EACA,QAAQ,EAAE,EAAE;EAEZ;EACA,SAAS,EAAE,EAAE;EAEb;EACA;EACA,QAAQ,EAAE;EACR;EACA,WAAW;AAEf,CAAC;;AAED;AACA;AACA;AACA,MAAM,uBAAuB,GAAG;EAC9B;EACA;EACA,gBAAgB,EAAE,EAAE;EACpB,aAAa,EAAE,EAAE;EACjB,MAAM,EAAE,EAAE;EACV,MAAM,EAAE,EAAE;EACV,WAAW,EAAE,EAAE;EACf,OAAO,EAAE,EAAE;EACX,UAAU,EAAE,EAAE;EACd,aAAa,EAAE,EAAE;EACjB,QAAQ,EAAE,EAAE;EACZ,KAAK,EAAE,EAAE;EACT,WAAW,EAAE,EAAE;EACf,SAAS,EAAE;AACb,CAAC;AAED,MAAM;EACJ;EACA,UAAU;EACV,QAAQ;EACR,QAAQ;EACR;EACA,OAAO;EAEP,SAAS;EACT;EACA,GAAG;AACL,CAAC,GAAG,cAAc;;AAElB;AACA;AACA;AACA,MAAM,WAAW,yBAAG;EAClB,GAAG,uBAAuB;EAC1B,GAAG,uBAAuB;EAE1B;EACA;EACA;;EAEA;EACA,MAAM,EAAE,EAAE;EAEV,IAAI,EAAE,EAAE;EACR,MAAM,EAAE,EAAE;EACV,OAAO,EAAE,EAAE;EACX,KAAK,EAAE,EAAE;EAET;EACA,YAAY,EAAE,EAAE;EAEhB,OAAO,EAAE,EAAE;EACX,UAAU,EAAE,EAAE;EACd,SAAS,EAAE,EAAE;EACb,QAAQ,EAAE,EAAE;EACZ,aAAa,EAAE,EAAE;EACjB,OAAO,EAAE,EAAE;EACX,eAAe,EAAE,EAAE;EACnB,QAAQ,EAAE,EAAE;EAEZ;EACA,MAAM,EAAE,EAAE;EAEV,MAAM,EAAE,CACN,SAAS,CACV;EAED,MAAM,EAAE,EAAE;EACV,QAAQ,EAAE,EAAE;EAEZ,YAAY,EAAE;AAChB,CAAC","ignoreList":[]}
@@ -1,263 +0,0 @@
1
- 'use strict';
2
-
3
- // https://262.ecma-international.org/14.0/#sec-keywords-and-reserved-words
4
- // 14 is ES2023
5
- const identifiers = [
6
- // Keywords
7
- 'await',
8
- 'break',
9
- 'case',
10
- 'catch',
11
- 'class',
12
- 'const',
13
- 'continue',
14
- 'debugger',
15
- 'default',
16
- 'delete',
17
- 'do',
18
- 'else',
19
- 'enum',
20
- 'export',
21
- 'extends',
22
- 'false',
23
- 'finally',
24
- 'for',
25
- 'function',
26
- 'if',
27
- 'import',
28
- 'in',
29
- 'instanceof',
30
- 'new',
31
- 'null',
32
- 'return',
33
- 'super',
34
- 'switch',
35
- 'this',
36
- 'throw',
37
- 'true',
38
- 'try',
39
- 'typeof',
40
- 'var',
41
- 'void',
42
- 'while',
43
- 'with',
44
- 'yield',
45
-
46
- // Future reserved keywords (strict mode)
47
- 'implements',
48
- 'interface',
49
- 'let',
50
- 'package',
51
- 'private',
52
- 'protected',
53
- 'public',
54
- 'static',
55
-
56
- // Not keywords, but still restricted
57
- 'arguments',
58
- 'eval',
59
- ];
60
-
61
- // https://262.ecma-international.org/14.0/#sec-value-properties-of-the-global-object
62
- const globalProperties = [
63
- 'globalThis',
64
- 'Infinity',
65
- 'NaN',
66
- 'undefined',
67
- ];
68
-
69
- function reservedIdentifiers$1({includeGlobalProperties = false} = {}) {
70
- return new Set([
71
- ...identifiers,
72
- ...(includeGlobalProperties ? globalProperties : []),
73
- ]);
74
- }
75
-
76
- /* eslint-disable no-bitwise */
77
-
78
- const BASE = 62;
79
- const BASE_BIGINT = 62n;
80
- const DEFAULT_ALPHABET = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
81
-
82
- const cachedEncoder = new globalThis.TextEncoder();
83
- const cachedDecoder = new globalThis.TextDecoder();
84
-
85
- function assertString(value, label) {
86
- if (typeof value !== 'string') {
87
- throw new TypeError(`The \`${label}\` parameter must be a string, got \`${value}\` (${typeof value}).`);
88
- }
89
- }
90
-
91
- function validateAlphabet(alphabet) {
92
- if (typeof alphabet !== 'string') {
93
- throw new TypeError(`The alphabet must be a string, got \`${alphabet}\` (${typeof alphabet}).`);
94
- }
95
-
96
- if (alphabet.length !== BASE) {
97
- throw new TypeError(`The alphabet must be exactly ${BASE} characters long, got ${alphabet.length}.`);
98
- }
99
-
100
- const uniqueCharacters = new Set(alphabet);
101
- if (uniqueCharacters.size !== BASE) {
102
- throw new TypeError(`The alphabet must contain ${BASE} unique characters, got ${uniqueCharacters.size}.`);
103
- }
104
- }
105
-
106
- class Base62 {
107
- constructor(options = {}) {
108
- const alphabet = options.alphabet ?? DEFAULT_ALPHABET;
109
- validateAlphabet(alphabet);
110
- this.alphabet = [...alphabet];
111
- this.indices = new Map(this.alphabet.map((character, index) => [character, index]));
112
- }
113
-
114
- #getIndex(character) {
115
- const index = this.indices.get(character);
116
-
117
- if (index === undefined) {
118
- throw new TypeError(`Unexpected character for Base62 encoding: \`${character}\`.`);
119
- }
120
-
121
- return index;
122
- }
123
-
124
- encodeString(string) {
125
- assertString(string, 'string');
126
- return this.encodeBytes(cachedEncoder.encode(string));
127
- }
128
-
129
- decodeString(encodedString) {
130
- assertString(encodedString, 'encodedString');
131
- return cachedDecoder.decode(this.decodeBytes(encodedString));
132
- }
133
-
134
- encodeBytes(bytes) {
135
- if (!(bytes instanceof Uint8Array)) {
136
- throw new TypeError('The `bytes` parameter must be an instance of Uint8Array.');
137
- }
138
-
139
- if (bytes.length === 0) {
140
- return '';
141
- }
142
-
143
- // Prepend 0x01 to the byte array before encoding to ensure the BigInt conversion
144
- // does not strip any leading zeros and to prevent any byte sequence from being
145
- // interpreted as a numerically zero value.
146
- let value = 1n;
147
-
148
- for (const byte of bytes) {
149
- value = (value << 8n) | BigInt(byte);
150
- }
151
-
152
- return this.encodeBigInt(value);
153
- }
154
-
155
- decodeBytes(encodedString) {
156
- assertString(encodedString, 'encodedString');
157
-
158
- if (encodedString.length === 0) {
159
- return new Uint8Array();
160
- }
161
-
162
- let value = this.decodeBigInt(encodedString);
163
-
164
- const byteArray = [];
165
- while (value > 0n) {
166
- byteArray.push(Number(value & 0xFFn));
167
- value >>= 8n;
168
- }
169
-
170
- // Remove the 0x01 that was prepended during encoding.
171
- return Uint8Array.from(byteArray.reverse().slice(1));
172
- }
173
-
174
- encodeInteger(integer) {
175
- if (!Number.isInteger(integer)) {
176
- throw new TypeError(`Expected an integer, got \`${integer}\` (${typeof integer}).`);
177
- }
178
-
179
- if (integer < 0) {
180
- throw new TypeError('The integer must be non-negative.');
181
- }
182
-
183
- if (integer === 0) {
184
- return this.alphabet[0];
185
- }
186
-
187
- let encodedString = '';
188
- while (integer > 0) {
189
- encodedString = this.alphabet[integer % BASE] + encodedString;
190
- integer = Math.floor(integer / BASE);
191
- }
192
-
193
- return encodedString;
194
- }
195
-
196
- decodeInteger(encodedString) {
197
- assertString(encodedString, 'encodedString');
198
-
199
- let integer = 0;
200
- for (const character of encodedString) {
201
- integer = (integer * BASE) + this.#getIndex(character);
202
- }
203
-
204
- return integer;
205
- }
206
-
207
- encodeBigInt(bigint) {
208
- if (typeof bigint !== 'bigint') {
209
- throw new TypeError(`Expected a bigint, got \`${bigint}\` (${typeof bigint}).`);
210
- }
211
-
212
- if (bigint < 0) {
213
- throw new TypeError('The bigint must be non-negative.');
214
- }
215
-
216
- if (bigint === 0n) {
217
- return this.alphabet[0];
218
- }
219
-
220
- let encodedString = '';
221
- while (bigint > 0n) {
222
- encodedString = this.alphabet[Number(bigint % BASE_BIGINT)] + encodedString;
223
- bigint /= BASE_BIGINT;
224
- }
225
-
226
- return encodedString;
227
- }
228
-
229
- decodeBigInt(encodedString) {
230
- assertString(encodedString, 'encodedString');
231
-
232
- let bigint = 0n;
233
- for (const character of encodedString) {
234
- bigint = (bigint * BASE_BIGINT) + BigInt(this.#getIndex(character));
235
- }
236
-
237
- return bigint;
238
- }
239
- }
240
-
241
- // Create default instance with standard alphabet
242
- const defaultBase62 = new Base62();
243
- const encodeInteger = integer => defaultBase62.encodeInteger(integer);
244
-
245
- const reservedIdentifiers = reservedIdentifiers$1({includeGlobalProperties: true});
246
-
247
- const encodeCodePoint = x => `$${encodeInteger(x.codePointAt(0))}$`;
248
-
249
- function toValidIdentifier(value) {
250
- if (typeof value !== 'string') {
251
- throw new TypeError(`Expected a string, got \`${typeof value}\`.`);
252
- }
253
-
254
- if (reservedIdentifiers.has(value)) {
255
- // We prefix with underscore to avoid any potential conflicts with the Base62 encoded string.
256
- return `$_${value}$`;
257
- }
258
-
259
- return value.replaceAll(/(?<!^)\P{ID_Continue}/gu, encodeCodePoint)
260
- .replaceAll(/^[^_\p{ID_Start}]/gu, encodeCodePoint);
261
- }
262
-
263
- module.exports = toValidIdentifier;