eslint-plugin-jsdoc/dist/tagNames.cjs.map

JSDoc linting rules for ESLint.

{"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","typeScriptTags","import","internal","overload","satisfies","template","undocumentedClosureTags","closurePrimitive","customElement","expose","hidden","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 * @type {AliasedTags}\n */\nconst typeScriptTags = {\n  ...jsdocTags,\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://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/type-checking-javascript-files.html#supported-jsdoc\n  template: [],\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  satisfies,\n\n  // Will be inverted to prefer `return`\n  returns,\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,MAAMC,cAAc,GAAApE,OAAA,CAAAoE,cAAA,GAAG;EACrB,GAAGrE,SAAS;EAEZ;EACA;EACAsE,MAAM,EAAE,EAAE;EAEV;EACAC,QAAQ,EAAE,EAAE;EAEZ;EACAC,QAAQ,EAAE,EAAE;EAEZ;EACAC,SAAS,EAAE,EAAE;EAEb;EACA;EACAC,QAAQ,EAAE;AACZ,CAAC;;AAED;AACA;AACA;AACA,MAAMC,uBAAuB,GAAG;EAC9B;EACA;EACAC,gBAAgB,EAAE,EAAE;EACpBC,aAAa,EAAE,EAAE;EACjBC,MAAM,EAAE,EAAE;EACVC,MAAM,EAAE,EAAE;EACVC,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;EACAzD,UAAU;EACVyC,QAAQ;EACRC,QAAQ;EACRC,SAAS;EAET;EACAlB,OAAO;EACP;EACA,GAAGiC;AACL,CAAC,GAAGnB,cAAc;;AAElB;AACA;AACA;AACA,MAAMoB,WAAW,GAAAxF,OAAA,CAAAwF,WAAA,GAAG;EAClB,GAAGD,uBAAuB;EAC1B,GAAGb,uBAAuB;EAE1B;EACA;EACA;;EAEA;EACAe,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":[]}