@depup/eslint-plugin-jsdoc 62.8.0-depup.0

package/dist/tagNames.cjs

@@ -0,0 +1,244 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.typeScriptTags = exports.jsdocTags = exports.closureTags = void 0;
+/**
+ * @typedef {{
+ *   [key: string]: string[]
+ * }} AliasedTags
+ */
+
+/**
+ * @type {AliasedTags}
+ */
+const jsdocTagsUndocumented = {
+  // Undocumented but present; see
+  // https://github.com/jsdoc/jsdoc/issues/1283#issuecomment-516816802
+  // https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594
+  modifies: []
+};
+
+/**
+ * @type {AliasedTags}
+ */
+const jsdocTags = exports.jsdocTags = {
+  ...jsdocTagsUndocumented,
+  abstract: ['virtual'],
+  access: [],
+  alias: [],
+  async: [],
+  augments: ['extends'],
+  author: [],
+  borrows: [],
+  callback: [],
+  class: ['constructor'],
+  classdesc: [],
+  constant: ['const'],
+  constructs: [],
+  copyright: [],
+  default: ['defaultvalue'],
+  deprecated: [],
+  description: ['desc'],
+  enum: [],
+  event: [],
+  example: [],
+  exports: [],
+  external: ['host'],
+  file: ['fileoverview', 'overview'],
+  fires: ['emits'],
+  function: ['func', 'method'],
+  generator: [],
+  global: [],
+  hideconstructor: [],
+  ignore: [],
+  implements: [],
+  inheritdoc: [],
+  // Allowing casing distinct from jsdoc `definitions.js` (required in Closure)
+  inheritDoc: [],
+  inner: [],
+  instance: [],
+  interface: [],
+  kind: [],
+  lends: [],
+  license: [],
+  listens: [],
+  member: ['var'],
+  memberof: [],
+  'memberof!': [],
+  mixes: [],
+  mixin: [],
+  module: [],
+  name: [],
+  namespace: [],
+  override: [],
+  package: [],
+  param: ['arg', 'argument'],
+  private: [],
+  property: ['prop'],
+  protected: [],
+  public: [],
+  readonly: [],
+  requires: [],
+  returns: ['return'],
+  see: [],
+  since: [],
+  static: [],
+  summary: [],
+  this: [],
+  throws: ['exception'],
+  todo: [],
+  tutorial: [],
+  type: [],
+  typedef: [],
+  variation: [],
+  version: [],
+  yields: ['yield']
+};
+
+/**
+ * @see {@link https://tsdoc.org/}
+ * @type {AliasedTags}
+ */
+const tsdocTags = {
+  alpha: [],
+  beta: [],
+  decorator: [],
+  eventProperty: [],
+  experimental: [],
+  packageDocumentation: [],
+  privateRemarks: [],
+  remarks: [],
+  sealed: []
+};
+
+/**
+ * @see {@link https://typedoc.org/documents/Tags.html}
+ * @type {AliasedTags}
+ */
+const typedocTags = {
+  category: [],
+  // https://typedoc.org/documents/Tags._category.html#category-descriptions
+  categoryDescription: [],
+  // https://typedoc.org/documents/Tags._group.html#disablegroups
+  disableGroups: [],
+  document: [],
+  expand: [],
+  // https://typedoc.org/documents/Tags._expand.html#expandtype
+  expandType: [],
+  group: [],
+  // https://typedoc.org/documents/Tags._group.html#groupdescription
+  groupDescription: [],
+  hidden: [],
+  // https://typedoc.org/documents/Tags._category.html#navigation-customization
+  hideCategories: [],
+  // https://typedoc.org/documents/Tags._group.html#navigation-customization
+  hideGroups: [],
+  inline: [],
+  // https://typedoc.org/documents/Tags._inline.html#inlinetype
+  inlineType: [],
+  mergeModuleWith: [],
+  // https://typedoc.org/documents/Tags._expand.html#preventexpand
+  preventExpand: [],
+  // https://typedoc.org/documents/Tags._inline.html#preventinline
+  preventInline: [],
+  primaryExport: [],
+  // https://typedoc.org/documents/Tags._category.html#navigation-customization
+  showCategories: [],
+  // https://typedoc.org/documents/Tags._group.html#navigation-customization
+  showGroups: [],
+  sortStrategy: [],
+  useDeclaredType: []
+};
+
+/**
+ * @type {AliasedTags}
+ */
+const typeScriptTags = exports.typeScriptTags = {
+  ...jsdocTags,
+  ...tsdocTags,
+  ...typedocTags,
+  // https://github.com/microsoft/TypeScript/issues/22160
+  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
+  import: [],
+  // https://www.typescriptlang.org/tsconfig/#stripInternal
+  internal: [],
+  // https://typedoc.org/documents/Tags.TypeScript_Tags.html
+  jsx: [],
+  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc
+  overload: [],
+  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#satisfies-support-in-jsdoc
+  satisfies: [],
+  // `@template` is also in TypeScript per:
+  //      https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#template
+  template: [
+  // Alias as per https://typedoc.org/documents/Tags._typeParam.html
+  'typeParam']
+};
+
+/**
+ * @type {AliasedTags}
+ */
+const undocumentedClosureTags = {
+  // These are in Closure source but not in jsdoc source nor in the Closure
+  //  docs: https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java
+  closurePrimitive: [],
+  customElement: [],
+  expose: [],
+  hidden: [],
+  idGenerator: [],
+  meaning: [],
+  mixinClass: [],
+  mixinFunction: [],
+  ngInject: [],
+  owner: [],
+  typeSummary: [],
+  wizaction: []
+};
+const {
+  /* eslint-disable no-unused-vars */
+  inheritdoc,
+  internal,
+  overload,
+  // Will be inverted to prefer `return`
+  returns,
+  satisfies,
+  /* eslint-enable no-unused-vars */
+  ...typeScriptTagsInClosure
+} = typeScriptTags;
+
+/**
+ * @type {AliasedTags}
+ */
+const closureTags = exports.closureTags = {
+  ...typeScriptTagsInClosure,
+  ...undocumentedClosureTags,
+  // From https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
+  // These are all recognized in https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js
+  //   except for the experimental `noinline` and the casing differences noted below
+
+  // Defined as a synonym of `const` in jsdoc `definitions.js`
+  define: [],
+  dict: [],
+  export: [],
+  externs: [],
+  final: [],
+  // With casing distinct from jsdoc `definitions.js`
+  implicitCast: [],
+  noalias: [],
+  nocollapse: [],
+  nocompile: [],
+  noinline: [],
+  nosideeffects: [],
+  polymer: [],
+  polymerBehavior: [],
+  preserve: [],
+  // Defined as a synonym of `interface` in jsdoc `definitions.js`
+  record: [],
+  return: ['returns'],
+  struct: [],
+  suppress: [],
+  unrestricted: []
+};
+//# sourceMappingURL=tagNames.cjs.map

package/dist/tagNames.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagNames.cjs","names":["jsdocTagsUndocumented","modifies","jsdocTags","exports","abstract","access","alias","async","augments","author","borrows","callback","class","classdesc","constant","constructs","copyright","default","deprecated","description","enum","event","example","external","file","fires","function","generator","global","hideconstructor","ignore","implements","inheritdoc","inheritDoc","inner","instance","interface","kind","lends","license","listens","member","memberof","mixes","mixin","module","name","namespace","override","package","param","private","property","protected","public","readonly","requires","returns","see","since","static","summary","this","throws","todo","tutorial","type","typedef","variation","version","yields","tsdocTags","alpha","beta","decorator","eventProperty","experimental","packageDocumentation","privateRemarks","remarks","sealed","typedocTags","category","categoryDescription","disableGroups","document","expand","expandType","group","groupDescription","hidden","hideCategories","hideGroups","inline","inlineType","mergeModuleWith","preventExpand","preventInline","primaryExport","showCategories","showGroups","sortStrategy","useDeclaredType","typeScriptTags","import","internal","jsx","overload","satisfies","template","undocumentedClosureTags","closurePrimitive","customElement","expose","idGenerator","meaning","mixinClass","mixinFunction","ngInject","owner","typeSummary","wizaction","typeScriptTagsInClosure","closureTags","define","dict","export","externs","final","implicitCast","noalias","nocollapse","nocompile","noinline","nosideeffects","polymer","polymerBehavior","preserve","record","return","struct","suppress","unrestricted"],"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,MAAMA,qBAAqB,GAAG;EAC5B;EACA;EACA;EACAC,QAAQ,EAAE;AACZ,CAAC;;AAED;AACA;AACA;AACA,MAAMC,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG;EAChB,GAAGF,qBAAqB;EACxBI,QAAQ,EAAE,CACR,SAAS,CACV;EACDC,MAAM,EAAE,EAAE;EACVC,KAAK,EAAE,EAAE;EACTC,KAAK,EAAE,EAAE;EACTC,QAAQ,EAAE,CACR,SAAS,CACV;EACDC,MAAM,EAAE,EAAE;EACVC,OAAO,EAAE,EAAE;EACXC,QAAQ,EAAE,EAAE;EACZC,KAAK,EAAE,CACL,aAAa,CACd;EACDC,SAAS,EAAE,EAAE;EACbC,QAAQ,EAAE,CACR,OAAO,CACR;EACDC,UAAU,EAAE,EAAE;EACdC,SAAS,EAAE,EAAE;EACbC,OAAO,EAAE,CACP,cAAc,CACf;EACDC,UAAU,EAAE,EAAE;EACdC,WAAW,EAAE,CACX,MAAM,CACP;EACDC,IAAI,EAAE,EAAE;EACRC,KAAK,EAAE,EAAE;EACTC,OAAO,EAAE,EAAE;EACXnB,OAAO,EAAE,EAAE;EACXoB,QAAQ,EAAE,CACR,MAAM,CACP;EACDC,IAAI,EAAE,CACJ,cAAc,EACd,UAAU,CACX;EACDC,KAAK,EAAE,CACL,OAAO,CACR;EACDC,QAAQ,EAAE,CACR,MAAM,EACN,QAAQ,CACT;EACDC,SAAS,EAAE,EAAE;EACbC,MAAM,EAAE,EAAE;EACVC,eAAe,EAAE,EAAE;EACnBC,MAAM,EAAE,EAAE;EACVC,UAAU,EAAE,EAAE;EACdC,UAAU,EAAE,EAAE;EAEd;EACAC,UAAU,EAAE,EAAE;EAEdC,KAAK,EAAE,EAAE;EACTC,QAAQ,EAAE,EAAE;EACZC,SAAS,EAAE,EAAE;EACbC,IAAI,EAAE,EAAE;EACRC,KAAK,EAAE,EAAE;EACTC,OAAO,EAAE,EAAE;EACXC,OAAO,EAAE,EAAE;EACXC,MAAM,EAAE,CACN,KAAK,CACN;EACDC,QAAQ,EAAE,EAAE;EACZ,WAAW,EAAE,EAAE;EACfC,KAAK,EAAE,EAAE;EACTC,KAAK,EAAE,EAAE;EAETC,MAAM,EAAE,EAAE;EACVC,IAAI,EAAE,EAAE;EACRC,SAAS,EAAE,EAAE;EACbC,QAAQ,EAAE,EAAE;EACZC,OAAO,EAAE,EAAE;EACXC,KAAK,EAAE,CACL,KAAK,EACL,UAAU,CACX;EACDC,OAAO,EAAE,EAAE;EACXC,QAAQ,EAAE,CACR,MAAM,CACP;EACDC,SAAS,EAAE,EAAE;EACbC,MAAM,EAAE,EAAE;EACVC,QAAQ,EAAE,EAAE;EACZC,QAAQ,EAAE,EAAE;EACZC,OAAO,EAAE,CACP,QAAQ,CACT;EACDC,GAAG,EAAE,EAAE;EACPC,KAAK,EAAE,EAAE;EACTC,MAAM,EAAE,EAAE;EACVC,OAAO,EAAE,EAAE;EAEXC,IAAI,EAAE,EAAE;EACRC,MAAM,EAAE,CACN,WAAW,CACZ;EACDC,IAAI,EAAE,EAAE;EACRC,QAAQ,EAAE,EAAE;EACZC,IAAI,EAAE,EAAE;EACRC,OAAO,EAAE,EAAE;EACXC,SAAS,EAAE,EAAE;EACbC,OAAO,EAAE,EAAE;EACXC,MAAM,EAAE,CACN,OAAO;AAEX,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,SAAS,GAAG;EAChBC,KAAK,EAAE,EAAE;EACTC,IAAI,EAAE,EAAE;EACRC,SAAS,EAAE,EAAE;EACbC,aAAa,EAAE,EAAE;EACjBC,YAAY,EAAE,EAAE;EAChBC,oBAAoB,EAAE,EAAE;EACxBC,cAAc,EAAE,EAAE;EAClBC,OAAO,EAAE,EAAE;EACXC,MAAM,EAAE;AACV,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAG;EAClBC,QAAQ,EAAE,EAAE;EACZ;EACAC,mBAAmB,EAAE,EAAE;EACvB;EACAC,aAAa,EAAE,EAAE;EACjBC,QAAQ,EAAE,EAAE;EACZC,MAAM,EAAE,EAAE;EACV;EACAC,UAAU,EAAE,EAAE;EACdC,KAAK,EAAE,EAAE;EACT;EACAC,gBAAgB,EAAE,EAAE;EACpBC,MAAM,EAAE,EAAE;EACV;EACAC,cAAc,EAAE,EAAE;EAClB;EACAC,UAAU,EAAE,EAAE;EACdC,MAAM,EAAE,EAAE;EACV;EACAC,UAAU,EAAE,EAAE;EACdC,eAAe,EAAE,EAAE;EACnB;EACAC,aAAa,EAAE,EAAE;EACjB;EACAC,aAAa,EAAE,EAAE;EACjBC,aAAa,EAAE,EAAE;EACjB;EACAC,cAAc,EAAE,EAAE;EAClB;EACAC,UAAU,EAAE,EAAE;EACdC,YAAY,EAAE,EAAE;EAChBC,eAAe,EAAE;AACnB,CAAC;;AAED;AACA;AACA;AACA,MAAMC,cAAc,GAAApG,OAAA,CAAAoG,cAAA,GAAG;EACrB,GAAGrG,SAAS;EACZ,GAAGqE,SAAS;EACZ,GAAGU,WAAW;EAEd;EACA;EACAuB,MAAM,EAAE,EAAE;EAEV;EACAC,QAAQ,EAAE,EAAE;EAEZ;EACAC,GAAG,EAAE,EAAE;EAEP;EACAC,QAAQ,EAAE,EAAE;EAEZ;EACAC,SAAS,EAAE,EAAE;EAEb;EACA;EACAC,QAAQ,EAAE;EACR;EACA,WAAW;AAEf,CAAC;;AAED;AACA;AACA;AACA,MAAMC,uBAAuB,GAAG;EAC9B;EACA;EACAC,gBAAgB,EAAE,EAAE;EACpBC,aAAa,EAAE,EAAE;EACjBC,MAAM,EAAE,EAAE;EACVvB,MAAM,EAAE,EAAE;EACVwB,WAAW,EAAE,EAAE;EACfC,OAAO,EAAE,EAAE;EACXC,UAAU,EAAE,EAAE;EACdC,aAAa,EAAE,EAAE;EACjBC,QAAQ,EAAE,EAAE;EACZC,KAAK,EAAE,EAAE;EACTC,WAAW,EAAE,EAAE;EACfC,SAAS,EAAE;AACb,CAAC;AAED,MAAM;EACJ;EACAzF,UAAU;EACVyE,QAAQ;EACRE,QAAQ;EACR;EACAlD,OAAO;EAEPmD,SAAS;EACT;EACA,GAAGc;AACL,CAAC,GAAGnB,cAAc;;AAElB;AACA;AACA;AACA,MAAMoB,WAAW,GAAAxH,OAAA,CAAAwH,WAAA,GAAG;EAClB,GAAGD,uBAAuB;EAC1B,GAAGZ,uBAAuB;EAE1B;EACA;EACA;;EAEA;EACAc,MAAM,EAAE,EAAE;EAEVC,IAAI,EAAE,EAAE;EACRC,MAAM,EAAE,EAAE;EACVC,OAAO,EAAE,EAAE;EACXC,KAAK,EAAE,EAAE;EAET;EACAC,YAAY,EAAE,EAAE;EAEhBC,OAAO,EAAE,EAAE;EACXC,UAAU,EAAE,EAAE;EACdC,SAAS,EAAE,EAAE;EACbC,QAAQ,EAAE,EAAE;EACZC,aAAa,EAAE,EAAE;EACjBC,OAAO,EAAE,EAAE;EACXC,eAAe,EAAE,EAAE;EACnBC,QAAQ,EAAE,EAAE;EAEZ;EACAC,MAAM,EAAE,EAAE;EAEVC,MAAM,EAAE,CACN,SAAS,CACV;EAEDC,MAAM,EAAE,EAAE;EACVC,QAAQ,EAAE,EAAE;EAEZC,YAAY,EAAE;AAChB,CAAC","ignoreList":[]}

package/dist/tagNames.d.ts

@@ -0,0 +1,16 @@
+export type AliasedTags = {
+    [key: string]: string[];
+};
+/**
+ * @type {AliasedTags}
+ */
+export const closureTags: AliasedTags;
+/**
+ * @type {AliasedTags}
+ */
+export const jsdocTags: AliasedTags;
+/**
+ * @type {AliasedTags}
+ */
+export const typeScriptTags: AliasedTags;
+//# sourceMappingURL=tagNames.d.ts.map

package/dist/to-valid-identifier.cjs

@@ -0,0 +1,263 @@
+'use strict';
+
+// https://262.ecma-international.org/14.0/#sec-keywords-and-reserved-words
+// 14 is ES2023
+const identifiers = [
+	// Keywords
+	'await',
+	'break',
+	'case',
+	'catch',
+	'class',
+	'const',
+	'continue',
+	'debugger',
+	'default',
+	'delete',
+	'do',
+	'else',
+	'enum',
+	'export',
+	'extends',
+	'false',
+	'finally',
+	'for',
+	'function',
+	'if',
+	'import',
+	'in',
+	'instanceof',
+	'new',
+	'null',
+	'return',
+	'super',
+	'switch',
+	'this',
+	'throw',
+	'true',
+	'try',
+	'typeof',
+	'var',
+	'void',
+	'while',
+	'with',
+	'yield',
+
+	// Future reserved keywords (strict mode)
+	'implements',
+	'interface',
+	'let',
+	'package',
+	'private',
+	'protected',
+	'public',
+	'static',
+
+	// Not keywords, but still restricted
+	'arguments',
+	'eval',
+];
+
+// https://262.ecma-international.org/14.0/#sec-value-properties-of-the-global-object
+const globalProperties = [
+	'globalThis',
+	'Infinity',
+	'NaN',
+	'undefined',
+];
+
+function reservedIdentifiers$1({includeGlobalProperties = false} = {}) {
+	return new Set([
+		...identifiers,
+		...(includeGlobalProperties ? globalProperties : []),
+	]);
+}
+
+/* eslint-disable no-bitwise */
+
+const BASE = 62;
+const BASE_BIGINT = 62n;
+const DEFAULT_ALPHABET = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+
+const cachedEncoder = new globalThis.TextEncoder();
+const cachedDecoder = new globalThis.TextDecoder();
+
+function assertString(value, label) {
+	if (typeof value !== 'string') {
+		throw new TypeError(`The \`${label}\` parameter must be a string, got \`${value}\` (${typeof value}).`);
+	}
+}
+
+function validateAlphabet(alphabet) {
+	if (typeof alphabet !== 'string') {
+		throw new TypeError(`The alphabet must be a string, got \`${alphabet}\` (${typeof alphabet}).`);
+	}
+
+	if (alphabet.length !== BASE) {
+		throw new TypeError(`The alphabet must be exactly ${BASE} characters long, got ${alphabet.length}.`);
+	}
+
+	const uniqueCharacters = new Set(alphabet);
+	if (uniqueCharacters.size !== BASE) {
+		throw new TypeError(`The alphabet must contain ${BASE} unique characters, got ${uniqueCharacters.size}.`);
+	}
+}
+
+class Base62 {
+	constructor(options = {}) {
+		const alphabet = options.alphabet ?? DEFAULT_ALPHABET;
+		validateAlphabet(alphabet);
+		this.alphabet = [...alphabet];
+		this.indices = new Map(this.alphabet.map((character, index) => [character, index]));
+	}
+
+	#getIndex(character) {
+		const index = this.indices.get(character);
+
+		if (index === undefined) {
+			throw new TypeError(`Unexpected character for Base62 encoding: \`${character}\`.`);
+		}
+
+		return index;
+	}
+
+	encodeString(string) {
+		assertString(string, 'string');
+		return this.encodeBytes(cachedEncoder.encode(string));
+	}
+
+	decodeString(encodedString) {
+		assertString(encodedString, 'encodedString');
+		return cachedDecoder.decode(this.decodeBytes(encodedString));
+	}
+
+	encodeBytes(bytes) {
+		if (!(bytes instanceof Uint8Array)) {
+			throw new TypeError('The `bytes` parameter must be an instance of Uint8Array.');
+		}
+
+		if (bytes.length === 0) {
+			return '';
+		}
+
+		// Prepend 0x01 to the byte array before encoding to ensure the BigInt conversion
+		// does not strip any leading zeros and to prevent any byte sequence from being
+		// interpreted as a numerically zero value.
+		let value = 1n;
+
+		for (const byte of bytes) {
+			value = (value << 8n) | BigInt(byte);
+		}
+
+		return this.encodeBigInt(value);
+	}
+
+	decodeBytes(encodedString) {
+		assertString(encodedString, 'encodedString');
+
+		if (encodedString.length === 0) {
+			return new Uint8Array();
+		}
+
+		let value = this.decodeBigInt(encodedString);
+
+		const byteArray = [];
+		while (value > 0n) {
+			byteArray.push(Number(value & 0xFFn));
+			value >>= 8n;
+		}
+
+		// Remove the 0x01 that was prepended during encoding.
+		return Uint8Array.from(byteArray.reverse().slice(1));
+	}
+
+	encodeInteger(integer) {
+		if (!Number.isInteger(integer)) {
+			throw new TypeError(`Expected an integer, got \`${integer}\` (${typeof integer}).`);
+		}
+
+		if (integer < 0) {
+			throw new TypeError('The integer must be non-negative.');
+		}
+
+		if (integer === 0) {
+			return this.alphabet[0];
+		}
+
+		let encodedString = '';
+		while (integer > 0) {
+			encodedString = this.alphabet[integer % BASE] + encodedString;
+			integer = Math.floor(integer / BASE);
+		}
+
+		return encodedString;
+	}
+
+	decodeInteger(encodedString) {
+		assertString(encodedString, 'encodedString');
+
+		let integer = 0;
+		for (const character of encodedString) {
+			integer = (integer * BASE) + this.#getIndex(character);
+		}
+
+		return integer;
+	}
+
+	encodeBigInt(bigint) {
+		if (typeof bigint !== 'bigint') {
+			throw new TypeError(`Expected a bigint, got \`${bigint}\` (${typeof bigint}).`);
+		}
+
+		if (bigint < 0) {
+			throw new TypeError('The bigint must be non-negative.');
+		}
+
+		if (bigint === 0n) {
+			return this.alphabet[0];
+		}
+
+		let encodedString = '';
+		while (bigint > 0n) {
+			encodedString = this.alphabet[Number(bigint % BASE_BIGINT)] + encodedString;
+			bigint /= BASE_BIGINT;
+		}
+
+		return encodedString;
+	}
+
+	decodeBigInt(encodedString) {
+		assertString(encodedString, 'encodedString');
+
+		let bigint = 0n;
+		for (const character of encodedString) {
+			bigint = (bigint * BASE_BIGINT) + BigInt(this.#getIndex(character));
+		}
+
+		return bigint;
+	}
+}
+
+// Create default instance with standard alphabet
+const defaultBase62 = new Base62();
+const encodeInteger = integer => defaultBase62.encodeInteger(integer);
+
+const reservedIdentifiers = reservedIdentifiers$1({includeGlobalProperties: true});
+
+const encodeCodePoint = x => `$${encodeInteger(x.codePointAt(0))}$`;
+
+function toValidIdentifier(value) {
+	if (typeof value !== 'string') {
+		throw new TypeError(`Expected a string, got \`${typeof value}\`.`);
+	}
+
+	if (reservedIdentifiers.has(value)) {
+		// We prefix with underscore to avoid any potential conflicts with the Base62 encoded string.
+		return `$_${value}$`;
+	}
+
+	return value.replaceAll(/(?<!^)\P{ID_Continue}/gu, encodeCodePoint)
+		.replaceAll(/^[^_\p{ID_Start}]/gu, encodeCodePoint);
+}
+
+module.exports = toValidIdentifier;