eslint-plugin-jsdoc 37.8.2 → 37.9.3

package/CONTRIBUTING.md

@@ -55,7 +55,7 @@ can use `npm run test-index`.
 To test specific rules, you can supply a comma-separated list with the `--rule`
 flag passed to `test-index`, e.g., for `check-examples` and `require-example`:
 
-`npm run --rule=check-examples,require-example test-index`.
+`npm run test-index --rule=check-examples,require-example`.
 
 You can further limit this by providing `--invalid` and/or `--valid` flags
 with a comma-separated list of 0-based indexes that you wish to include (also

package/README.md

@@ -1259,33 +1259,33 @@ function quux () {}
 // Message: @example error (semi): Missing semicolon.
 
 /**
- * @example const i = 5;
- * quux2()
+ * @example const j = 5;
+ * quux2();
  */
 function quux2 () {
 
 }
 // "jsdoc/check-examples": ["error"|"warn", {"matchingFileName":"../../jsdocUtils.js"}]
-// Message: @example warning (id-length): Identifier name 'i' is too short (< 2).
+// Message: @example warning (id-length): Identifier name 'j' is too short (< 2).
 
 /**
- * @example const i = 5;
- * quux2()
+ * @example const k = 5;
+ * quux2();
  */
 function quux2 () {
 
 }
 // "jsdoc/check-examples": ["error"|"warn", {"configFile":".eslintrc.json","matchingFileName":"../../jsdocUtils.js"}]
-// Message: @example warning (id-length): Identifier name 'i' is too short (< 2).
+// Message: @example warning (id-length): Identifier name 'k' is too short (< 2).
 
 /**
- * @example const i = 5;
- * quux2()
+ * @example const m = 5;
+ * quux2();
  */
 function quux2 () {
 
 }
-// Message: @example warning (id-length): Identifier name 'i' is too short (< 2).
+// Message: @example warning (id-length): Identifier name 'm' is too short (< 2).
 
 /**
  * @example const i = 5;
@@ -5818,6 +5818,9 @@ This rule checks the values for a handful of tags:
 5. `@variation` - If `numericOnlyVariation` is set, will checks that there
     is a value present, and that it is an integer (otherwise, jsdoc allows any
     value).
+6. `@kind` - Insists that it be one of the allowed values: 'class',
+    'constant', 'event', 'external', 'file', 'function', 'member', 'mixin',
+    'module', 'namespace', 'typedef',
 
 <a name="eslint-plugin-jsdoc-rules-check-values-options-8"></a>
 #### Options
@@ -5857,7 +5860,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to
 |||
 |---|---|
 |Context|everywhere|
-|Tags|`@version`, `@since`, `@license`, `@author`, `@variation`|
+|Tags|`@version`, `@since`, `@kind`, `@license`, `@author`, `@variation`|
 |Recommended|true|
 |Options|`allowedAuthors`, `allowedLicenses`, `licensePattern`|
 |Settings|`tagNamePreference`|
@@ -5881,6 +5884,22 @@ function quux (foo) {
 }
 // Message: Invalid JSDoc @version: "3.1".
 
+/**
+ * @kind
+ */
+function quux (foo) {
+
+}
+// Message: Missing JSDoc @kind value.
+
+/**
+ * @kind -3
+ */
+function quux (foo) {
+
+}
+// Message: Invalid JSDoc @kind: "-3"; must be one of: class, constant, event, external, file, function, member, mixin, module, namespace, typedef.
+
 /**
  * @variation -3
  */
@@ -6108,6 +6127,13 @@ function quux (foo) {
  * @license MIT
  */
 'use strict';
+
+/**
+ * @kind function
+ */
+function quux (foo) {
+
+}
 ````
 
 
@@ -9235,6 +9261,12 @@ const MY_ENUM = Object.freeze({
   VAL_A: "myvala"
 } as const);
 // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag ~ JsdocTag[tag=/private|protected/])","context":"any","message":"Access modifier tags must come first"},{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTag[tag=\"enum\"])","context":":declaration:not(TSEnumDeclaration):not(:has(ObjectExpression)), :function","message":"@enum is only allowed on potential enum types"}]}]
+
+/**
+ * @param {(...args: any[]) => any} fn
+ * @returns {(...args: any[]) => any}
+ */
+// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"type\"]:has([value=/FunctionComponent/]))","context":"any","message":"The `FunctionComponent` type is not allowed. Please use `FC` instead."}]}]
 ````
 
 
@@ -21249,7 +21281,7 @@ function quux() {
 
 /**
  *
- * @fires {module:namespace.SomeClass#event:ext_anevent}
+ * @fires module:namespace.SomeClass#event:ext_anevent
  */
 function quux() {
 

package/dist/getDefaultTagStructureForMode.js

@@ -58,40 +58,43 @@ const getDefaultTagStructureForMode = mode => {
   //   problematic as not attached so presumably not useable without it
   ['nameContents', 'namepath-defining'], // "namepath"
   ['nameRequired', true]])], ['class', new Map([// Allows for "name"'s in signature, but indicated as optional
-  ['nameContents', 'namepath-defining'], ['typeAllowed', true]])], ['const', new Map([// Allows for "name"'s in signature, but indicated as optional
+  ['nameContents', 'namepath-defining'], // Not in use, but should be this value if using to power `empty-tags`
+  ['nameAllowed', true], ['typeAllowed', true]])], ['const', new Map([// Allows for "name"'s in signature, but indicated as optional
   ['nameContents', 'namepath-defining'], ['typeAllowed', true]])], ['constant', new Map([// Allows for "name"'s in signature, but indicated as optional
   ['nameContents', 'namepath-defining'], ['typeAllowed', true]])], ['constructor', new Map([// Allows for "name"'s in signature, but indicated as optional
-  ['nameContents', 'namepath-defining'], ['typeAllowed', true]])], ['define', new Map([['typeRequired', isClosure]])], ['emits', new Map([// Signature seems to require a "name" (of an event) and no counter-examples
-  ['nameContents', 'namepath-referencing']])], ['enum', new Map([// Has example showing curly brackets but not in doc signature
+  ['nameContents', 'namepath-defining'], ['typeAllowed', true]])], ['constructs', new Map([// Allows for "name"'s in signature, but indicated as optional
+  ['nameContents', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['define', new Map([['typeRequired', isClosure]])], ['emits', new Map([// Signature seems to require a "name" (of an event) and no counter-examples
+  ['nameContents', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['enum', new Map([// Has example showing curly brackets but not in doc signature
   ['typeAllowed', true]])], ['event', new Map([// The doc signature of `event` seems to require a "name"
   ['nameRequired', true], // Appears to require a "name" in its signature, albeit somewhat
   //  different from other "name"'s (including as described
   //  at https://jsdoc.app/about-namepaths.html )
   ['nameContents', 'namepath-defining']])], ['exception', new Map([// Shows curly brackets in the signature and in the examples
-  ['typeAllowed', true]])], ['export', new Map([['typeAllowed', isClosureOrPermissive]])], ['extends', new Map([// Signature seems to require a "namepath" (and no counter-examples)
+  ['typeAllowed', true]])], // Closure
+  ['export', new Map([['typeAllowed', isClosureOrPermissive]])], ['exports', new Map([['nameContents', 'namepath-defining'], ['nameRequired', isJsdoc], ['typeAllowed', isClosureOrPermissive]])], ['extends', new Map([// Signature seems to require a "namepath" (and no counter-examples)
   ['nameContents', 'namepath-referencing'], // Does not show curly brackets in either the signature or examples
   ['typeAllowed', isTypescriptOrClosure || isPermissive], ['nameRequired', isJsdoc], // "namepath"
   ['typeOrNameRequired', isTypescriptOrClosure || isPermissive]])], ['external', new Map([// Appears to require a "name" in its signature, albeit somewhat
   //  different from other "name"'s (including as described
   //  at https://jsdoc.app/about-namepaths.html )
   ['nameContents', 'namepath-defining'], // "name" (and a special syntax for the `external` name)
-  ['nameRequired', true]])], ['fires', new Map([// Signature seems to require a "name" (of an event) and no
+  ['nameRequired', true], ['typeAllowed', false]])], ['fires', new Map([// Signature seems to require a "name" (of an event) and no
   //  counter-examples
-  ['nameContents', 'namepath-referencing']])], ['function', new Map([// Allows for "name"'s in signature, but indicated as optional
-  ['nameContents', 'namepath-defining']])], ['func', new Map([// Allows for "name"'s in signature, but indicated as optional
+  ['nameContents', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['function', new Map([// Allows for "name"'s in signature, but indicated as optional
+  ['nameContents', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['func', new Map([// Allows for "name"'s in signature, but indicated as optional
   ['nameContents', 'namepath-defining']])], ['host', new Map([// Appears to require a "name" in its signature, albeit somewhat
   //  different from other "name"'s (including as described
   //  at https://jsdoc.app/about-namepaths.html )
   ['nameContents', 'namepath-defining'], // See `external`
-  ['nameRequired', true], // "namepath"
-  ['typeOrNameRequired', true]])], ['interface', new Map([// Allows for "name" in signature, but indicates as optional
-  ['nameContents', isJsdocTypescriptOrPermissive ? 'namepath-defining' : false]])], ['implements', new Map([// Shows curly brackets in the doc signature and examples
+  ['nameRequired', true], ['typeAllowed', false]])], ['interface', new Map([// Allows for "name" in signature, but indicates as optional
+  ['nameContents', isJsdocTypescriptOrPermissive ? 'namepath-defining' : false], // Not in use, but should be this value if using to power `empty-tags`
+  ['nameAllowed', isClosure], ['typeAllowed', false]])], ['implements', new Map([// Shows curly brackets in the doc signature and examples
   // "typeExpression"
   ['typeRequired', true]])], ['lends', new Map([// Signature seems to require a "namepath" (and no counter-examples)
   ['nameContents', 'namepath-referencing'], // "namepath"
   ['typeOrNameRequired', true]])], ['listens', new Map([// Signature seems to require a "name" (of an event) and no
   //  counter-examples
-  ['nameContents', 'namepath-referencing']])], ['member', new Map([// Allows for "name"'s in signature, but indicated as optional
+  ['nameContents', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['member', new Map([// Allows for "name"'s in signature, but indicated as optional
   ['nameContents', 'namepath-defining'], // Has example showing curly brackets but not in doc signature
   ['typeAllowed', true]])], ['memberof', new Map([// Signature seems to require a "namepath" (and no counter-examples),
   //  though it allows an incomplete namepath ending with connecting symbol
@@ -104,7 +107,7 @@ const getDefaultTagStructureForMode = mode => {
   //   counter-examples
   ['nameContents', 'namepath-referencing'], // "OtherObjectPath"
   ['typeOrNameRequired', true]])], ['mixin', new Map([// Allows for "name"'s in signature, but indicated as optional
-  ['nameContents', 'namepath-defining']])], ['modifies', new Map([// Has no documentation, but test example has curly brackets, and
+  ['nameContents', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['modifies', new Map([// Has no documentation, but test example has curly brackets, and
   //  "name" would be suggested rather than "namepath" based on example;
   //  not sure if name is required
   ['typeAllowed', true]])], ['module', new Map([// Optional "name" and no curly brackets
@@ -137,7 +140,8 @@ const getDefaultTagStructureForMode = mode => {
   ['typeAllowed', true]])], ['protected', new Map([// Shows the signature with curly brackets but not in the example
   // "typeExpression"
   ['typeAllowed', isClosureOrPermissive]])], ['public', new Map([// Does not show a signature nor show curly brackets in the example
-  ['typeAllowed', isClosureOrPermissive]])], ['returns', new Map([// Shows curly brackets in the signature and in the examples
+  ['typeAllowed', isClosureOrPermissive]])], ['requires', new Map([// <someModuleName>
+  ['nameContents', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['returns', new Map([// Shows curly brackets in the signature and in the examples
   ['typeAllowed', true]])], ['return', new Map([// Shows curly brackets in the signature and in the examples
   ['typeAllowed', true]])], ['see', new Map([// Signature allows for "namepath" or text, so user must configure to
   //  'namepath-referencing' to enforce checks
@@ -149,7 +153,8 @@ const getDefaultTagStructureForMode = mode => {
   // Not used with namepath in Closure/TypeScript, however
   ['nameContents', isJsdoc ? 'namepath-referencing' : false], ['typeRequired', isTypescriptOrClosure], // namepath
   ['typeOrNameRequired', isJsdoc]])], ['throws', new Map([// Shows curly brackets in the signature and in the examples
-  ['typeAllowed', true]])], ['type', new Map([// Shows curly brackets in the doc signature and examples
+  ['typeAllowed', true]])], ['tutorial', new Map([// (a tutorial ID)
+  ['nameRequired', true], ['typeAllowed', false]])], ['type', new Map([// Shows curly brackets in the doc signature and examples
   // "typeName"
   ['typeRequired', true]])], ['typedef', new Map([// Seems to require a "namepath" in the signature (with no
   //  counter-examples)

package/dist/getDefaultTagStructureForMode.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/getDefaultTagStructureForMode.js"],"names":["getDefaultTagStructureForMode","mode","isJsdoc","isClosure","isTypescript","isPermissive","isJsdocOrPermissive","isJsdocOrTypescript","isTypescriptOrClosure","isClosureOrPermissive","isJsdocTypescriptOrPermissive","Map"],"mappings":";;;;;;;AAAA,MAAMA,6BAA6B,GAAIC,IAAD,IAAU;AAC9C,QAAMC,OAAO,GAAGD,IAAI,KAAK,OAAzB;AACA,QAAME,SAAS,GAAGF,IAAI,KAAK,SAA3B;AACA,QAAMG,YAAY,GAAGH,IAAI,KAAK,YAA9B;AACA,QAAMI,YAAY,GAAGJ,IAAI,KAAK,YAA9B;AAEA,QAAMK,mBAAmB,GAAGJ,OAAO,IAAIG,YAAvC;AACA,QAAME,mBAAmB,GAAGL,OAAO,IAAIE,YAAvC;AACA,QAAMI,qBAAqB,GAAGJ,YAAY,IAAID,SAA9C;AACA,QAAMM,qBAAqB,GAAGN,SAAS,IAAIE,YAA3C;AACA,QAAMK,6BAA6B,GAAGH,mBAAmB,IAAIF,YAA7D,CAV8C,CAY9C;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AAEA;AACA;AAEA;AACA;AACA;AACA;AAEA;AACA;AAEA;AACA;AACA;AACA;AACA;;AAEA,SAAO,IAAIM,GAAJ,CAAQ,CACb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,EAMf;AACA,GACE,oBADF,EACwB,IADxB,CAPe,CAAR,CADX,CADa,EAeb,CACE,KADF,EACS,IAAIA,GAAJ,CAAQ,CACb,CACE,cADF,EACkB,mBADlB,CADa,EAKb;AACA,GACE,cADF,EACkB,IADlB,CANa,EAUb;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZa,CAAR,CADT,CAfa,EAkCb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,mBADlB,CADkB,EAKlB;AACA,GACE,cADF,EACkB,IADlB,CANkB,EAUlB;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZkB,CAAR,CADd,CAlCa,EAqDb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,sBADlB,CAFkB,EAMlB;AACA,GACE,aADF,EACiB,IADjB,CAPkB,EAWlB;AACA,GACE,oBADF,EACwB,IADxB,CAZkB,CAAR,CADd,CArDa,EAwEb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHiB,EAOjB;AACA,GACE,oBADF,EACwB,IADxB,CARiB,CAAR,CADb,CAxEa,EAuFb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJkB,EAQlB;AACA,GACE,cADF,EACkB,IADlB,CATkB,CAAR,CADd,CAvFa,EAuGb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,EAMf,CACE,aADF,EACiB,IADjB,CANe,CAAR,CADX,CAvGa,EAoHb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,EAMf,CACE,aADF,EACiB,IADjB,CANe,CAAR,CADX,CApHa,EAgIb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,mBADlB,CAFkB,EAMlB,CACE,aADF,EACiB,IADjB,CANkB,CAAR,CADd,CAhIa,EA4Ib,CACE,aADF,EACiB,IAAIA,GAAJ,CAAQ,CACrB;AACA,GACE,cADF,EACkB,mBADlB,CAFqB,EAMrB,CACE,aADF,EACiB,IADjB,CANqB,CAAR,CADjB,CA5Ia,EAyJb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB,CACE,cADF,EACkBR,SADlB,CADgB,CAAR,CADZ,CAzJa,EAiKb,CACE,OADF,EACW,IAAIQ,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,CAAR,CADX,CAjKa,EA0Kb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA,GACE,aADF,EACiB,IADjB,CAFc,CAAR,CADV,CA1Ka,EAmLb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,IADlB,CAFe,EAMf;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CATe,CAAR,CADX,CAnLa,EAmMb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,aADF,EACiB,IADjB,CAFmB,CAAR,CADf,CAnMa,EA4Mb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB,CACE,aADF,EACiBF,qBADjB,CADgB,CAAR,CADZ,CA5Ma,EAoNb,CACE,SADF,EACa,IAAIE,GAAJ,CAAQ,CACjB;AACA,GACE,cADF,EACkB,sBADlB,CAFiB,EAMjB;AACA,GACE,aADF,EACiBH,qBAAqB,IAAIH,YAD1C,CAPiB,EAWjB,CACE,cADF,EACkBH,OADlB,CAXiB,EAejB;AACA,GACE,oBADF,EACwBM,qBAAqB,IAAIH,YADjD,CAhBiB,CAAR,CADb,CApNa,EA2Ob,CACE,UADF,EACc,IAAIM,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJkB,EAQlB;AACA,GACE,cADF,EACkB,IADlB,CATkB,CAAR,CADd,CA3Oa,EA2Pb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHe,CAAR,CADX,CA3Pa,EAqQb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,mBADlB,CAFkB,CAAR,CADd,CArQa,EA6Qb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA,GACE,cADF,EACkB,mBADlB,CAFc,CAAR,CADV,CA7Qa,EAsRb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJc,EAQd;AACA,GACE,cADF,EACkB,IADlB,CATc,EAad;AACA,GACE,oBADF,EACwB,IADxB,CAdc,CAAR,CADV,CAtRa,EA2Sb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,cADF,EAEED,6BAA6B,GAAG,mBAAH,GAAyB,KAFxD,CAFmB,CAAR,CADf,CA3Sa,EAqTb,CACE,YADF,EACgB,IAAIC,GAAJ,CAAQ,CACpB;AACA;AACA,GACE,cADF,EACkB,IADlB,CAHoB,CAAR,CADhB,CArTa,EA+Tb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,EAMf;AACA,GACE,oBADF,EACwB,IADxB,CAPe,CAAR,CADX,CA/Ta,EA6Ub,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHiB,CAAR,CADb,CA7Ua,EAuVb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,cADF,EACkB,mBADlB,CAFgB,EAMhB;AACA,GACE,aADF,EACiB,IADjB,CAPgB,CAAR,CADZ,CAvVa,EAqWb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHkB,EAOlB;AACA,GACE,oBADF,EACwB,IADxB,CARkB,CAAR,CADd,CArWa,EAmXb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHmB,EAOnB;AACA,GACE,oBADF,EACwB,IADxB,CARmB,CAAR,CADf,CAnXa,EAkYb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,cADF,EACkB,mBADlB,CAFgB,CAAR,CADZ,CAlYa,EA0Yb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHe,EAOf;AACA,GACE,oBADF,EACwB,IADxB,CARe,CAAR,CADX,CA1Ya,EAyZb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,CAAR,CADX,CAzZa,EAkab,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,aADF,EACiB,IADjB,CAJkB,CAAR,CADd,CAlaa,EA6ab,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA;AACA;AACA,GACE,cADF,EACkBT,OAAO,GAAG,mBAAH,GAAyB,MADlD,CAJgB,EAQhB;AACA,GACE,aADF,EACiB,IADjB,CATgB,CAAR,CADZ,CA7aa,EA6bb,CACE,MADF,EACU,IAAIS,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAHc,EAOd;AACA,GACE,cADF,EACkB,IADlB,CARc,EAYd;AACA,GACE,oBADF,EACwB,IADxB,CAbc,CAAR,CADV,CA7ba,EAidb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,cADF,EACkB,mBADlB,CAFmB,EAMnB;AACA,GACE,aADF,EACiB,IADjB,CAPmB,CAAR,CADf,CAjda,EA8db,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHiB,CAAR,CADb,CA9da,EAweb,CACE,OADF,EACW,IAAIE,GAAJ,CAAQ,CACf,CACE,cADF,EACkB,mBADlB,CADe,EAKf;AACA;AACA;AACA;AACA,GACE,cADF,EACkB,IADlB,CATe,EAaf;AACA;AACA,GACE,aADF,EACiB,IADjB,CAfe,CAAR,CADX,CAxea,EA8fb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHiB,CAAR,CADb,CA9fa,EAwgBb,CACE,MADF,EACU,IAAIE,GAAJ,CAAQ,CACd,CACE,cADF,EACkB,mBADlB,CADc,EAKd;AACA,GACE,cADF,EACkB,IADlB,CANc,EAUd;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZc,CAAR,CADV,CAxgBa,EA2hBb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,mBADlB,CADkB,EAKlB;AACA;AACA,GACE,cADF,EACkB,IADlB,CAPkB,EAWlB;AACA;AACA,GACE,aADF,EACiB,IADjB,CAbkB,CAAR,CADd,CA3hBa,EA+iBb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHmB,CAAR,CADf,CA/iBa,EAyjBb,CACE,QADF,EACY,IAAIE,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiBF,qBADjB,CAFgB,CAAR,CADZ,CAzjBa,EAkkBb,CACE,SADF,EACa,IAAIE,GAAJ,CAAQ,CACjB;AACA,GACE,aADF,EACiB,IADjB,CAFiB,CAAR,CADb,CAlkBa,EA0kBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CA1kBa,EAmlBb,CACE,KADF,EACS,IAAIA,GAAJ,CAAQ,CACb;AACA;AACA,GACE,cADF,EACkB,MADlB,CAHa,CAAR,CADT,CAnlBa,EA6lBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiBF,qBADjB,CAFgB,CAAR,CADZ,CA7lBa,EAsmBb,CACE,UADF,EACc,IAAIE,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,CAACR,SADnB,CADkB,EAIlB,CACE,cADF,EACkBA,SADlB,CAJkB,CAAR,CADd,CAtmBa,EAinBb,CACE,UADF,EACc,IAAIQ,GAAJ,CAAQ,CAClB,CACE,cADF,EACkBT,OAAO,GAAG,MAAH,GAAY,sBADrC,CADkB,EAKlB;AACA;AACA;AACA,GACE,aADF,EACiBM,qBAAqB,IAAIH,YAD1C,CARkB,CAAR,CADd,CAjnBa,EAgoBb,CACE,MADF,EACU,IAAIM,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkBT,OAAO,GAAG,sBAAH,GAA4B,KADrD,CAHc,EAOd,CACE,cADF,EACkBM,qBADlB,CAPc,EAWd;AACA,GACE,oBADF,EACwBN,OADxB,CAZc,CAAR,CADV,CAhoBa,EAmpBb,CACE,QADF,EACY,IAAIS,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CAnpBa,EA4pBb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkB,IADlB,CAHc,CAAR,CADV,CA5pBa,EAsqBb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAHiB,EAOjB;AACA;AACA;AACA,GACE,cADF,EACkBL,mBADlB,CAViB,EAcjB;AACA;AAEA;AACA,GACE,aADF,EACiB,IADjB,CAlBiB,EAsBjB;AACA;AACA,GACE,oBADF,EACwB,CAACF,YADzB,CAxBiB,CAAR,CADb,CAtqBa,EAqsBb,CACE,KADF,EACS,IAAIO,GAAJ,CAAQ,CACb;AACA,GACE,cADF,EACkB,mBADlB,CAFa,EAMb;AACA,GACE,aADF,EACiB,IADjB,CAPa,CAAR,CADT,CArsBa,EAmtBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CAntBa,EA2tBb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,aADF,EACiB,IADjB,CAFe,CAAR,CADX,CA3tBa,CAAR,CAAP;AAouBD,CA9wBD;;eAgxBeX,6B","sourcesContent":["const getDefaultTagStructureForMode = (mode) => {\n  const isJsdoc = mode === 'jsdoc';\n  const isClosure = mode === 'closure';\n  const isTypescript = mode === 'typescript';\n  const isPermissive = mode === 'permissive';\n\n  const isJsdocOrPermissive = isJsdoc || isPermissive;\n  const isJsdocOrTypescript = isJsdoc || isTypescript;\n  const isTypescriptOrClosure = isTypescript || isClosure;\n  const isClosureOrPermissive = isClosure || isPermissive;\n  const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;\n\n  // Properties:\n  // `nameContents` - 'namepath-referencing'|'namepath-defining'|'text'|false\n  // `typeAllowed` - boolean\n  // `nameRequired` - boolean\n  // `typeRequired` - boolean\n  // `typeOrNameRequired` - boolean\n\n  // All of `typeAllowed` have a signature with \"type\" except for\n  //  `augments`/`extends` (\"namepath\")\n  //  `param`/`arg`/`argument` (no signature)\n  //  `property`/`prop` (no signature)\n  //  `modifies` (undocumented)\n\n  // None of the `nameContents: 'namepath-defining'` show as having curly\n  //  brackets for their name/namepath\n\n  // Among `namepath-defining` and `namepath-referencing`, these do not seem\n  //  to allow curly brackets in their doc signature or examples (`modifies`\n  //  references namepaths within its type brackets and `param` is\n  //  name-defining but not namepath-defining, so not part of these groups)\n\n  // Todo: Should support special processing for \"name\" as distinct from\n  //   \"namepath\" (e.g., param can't define a namepath)\n\n  // Once checking inline tags:\n  // Todo: Re: `typeOrNameRequired`, `@link` (or @linkcode/@linkplain) seems\n  //  to require a namepath OR URL and might be checked as such.\n  // Todo: Should support a `tutorialID` type (for `@tutorial` block and\n  //  inline)\n\n  return new Map([\n    [\n      'alias', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'arg', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `param`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'argument', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `param`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'augments', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // Does not show curly brackets in either the signature or examples\n        [\n          'typeAllowed', true,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'borrows', new Map([\n        // `borrows` has a different format, however, so needs special parsing;\n        //   seems to require both, and as \"namepath\"'s\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'callback', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //   counter-examples); TypeScript does not enforce but seems\n        //   problematic as not attached so presumably not useable without it\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"namepath\"\n        [\n          'nameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'class', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'const', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'constant', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'constructor', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'define', new Map([\n        [\n          'typeRequired', isClosure,\n        ],\n      ]),\n    ],\n\n    [\n      'emits', new Map([\n        // Signature seems to require a \"name\" (of an event) and no counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n      ]),\n    ],\n\n    [\n      'enum', new Map([\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'event', new Map([\n        // The doc signature of `event` seems to require a \"name\"\n        [\n          'nameRequired', true,\n        ],\n\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n\n    [\n      'exception', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'export', new Map([\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'extends', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // Does not show curly brackets in either the signature or examples\n        [\n          'typeAllowed', isTypescriptOrClosure || isPermissive,\n        ],\n\n        [\n          'nameRequired', isJsdoc,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', isTypescriptOrClosure || isPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'external', new Map([\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"name\" (and a special syntax for the `external` name)\n        [\n          'nameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'fires', new Map([\n        // Signature seems to require a \"name\" (of an event) and no\n        //  counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n      ]),\n    ],\n\n    [\n      'function', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n    [\n      'func', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n\n    [\n      'host', new Map([\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `external`\n        [\n          'nameRequired', true,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'interface', new Map([\n        // Allows for \"name\" in signature, but indicates as optional\n        [\n          'nameContents',\n          isJsdocTypescriptOrPermissive ? 'namepath-defining' : false,\n        ],\n      ]),\n    ],\n\n    [\n      'implements', new Map([\n        // Shows curly brackets in the doc signature and examples\n        // \"typeExpression\"\n        [\n          'typeRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'lends', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'listens', new Map([\n        // Signature seems to require a \"name\" (of an event) and no\n        //  counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n      ]),\n    ],\n\n    [\n      'member', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'memberof', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples),\n        //  though it allows an incomplete namepath ending with connecting symbol\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n    [\n      'memberof!', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples),\n        //  though it allows an incomplete namepath ending with connecting symbol\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'method', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n    [\n      'mixes', new Map([\n        // Signature seems to require a \"OtherObjectPath\" with no\n        //   counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"OtherObjectPath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'mixin', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n\n    [\n      'modifies', new Map([\n        // Has no documentation, but test example has curly brackets, and\n        //  \"name\" would be suggested rather than \"namepath\" based on example;\n        //  not sure if name is required\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'module', new Map([\n        // Optional \"name\" and no curly brackets\n        //  this block impacts `no-undefined-types` and `valid-types` (search for\n        //  \"isNamepathDefiningTag|tagMightHaveNamepath|tagMightHaveEitherTypeOrNamePosition\")\n        [\n          'nameContents', isJsdoc ? 'namepath-defining' : 'text',\n        ],\n\n        // Shows the signature with curly brackets but not in the example\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'name', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //   counter-examples)\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"namepath\"\n        [\n          'nameRequired', true,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'namespace', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Shows the signature with curly brackets but not in the example\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'package', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'param', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Though no signature provided requiring, per\n        //  https://jsdoc.app/tags-param.html:\n        // \"The @param tag requires you to specify the name of the parameter you\n        //  are documenting.\"\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'private', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'prop', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `property`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'property', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // No docs indicate required, but since parallel to `param`, we treat as\n        //   such:\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'protected', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'public', new Map([\n        // Does not show a signature nor show curly brackets in the example\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'returns', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'return', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'see', new Map([\n        // Signature allows for \"namepath\" or text, so user must configure to\n        //  'namepath-referencing' to enforce checks\n        [\n          'nameContents', 'text',\n        ],\n      ]),\n    ],\n\n    [\n      'static', new Map([\n        // Does not show a signature nor show curly brackets in the example\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'suppress', new Map([\n        [\n          'nameContents', !isClosure,\n        ],\n        [\n          'typeRequired', isClosure,\n        ],\n      ]),\n    ],\n\n    [\n      'template', new Map([\n        [\n          'nameContents', isJsdoc ? 'text' : 'namepath-referencing',\n        ],\n\n        // Though defines `nameContents: 'namepath-defining'` in a sense, it is\n        //   not parseable in the same way for template (e.g., allowing commas),\n        //   so not adding\n        [\n          'typeAllowed', isTypescriptOrClosure || isPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'this', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        // Not used with namepath in Closure/TypeScript, however\n        [\n          'nameContents', isJsdoc ? 'namepath-referencing' : false,\n        ],\n\n        [\n          'typeRequired', isTypescriptOrClosure,\n        ],\n\n        // namepath\n        [\n          'typeOrNameRequired', isJsdoc,\n        ],\n      ]),\n    ],\n\n    [\n      'throws', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'type', new Map([\n        // Shows curly brackets in the doc signature and examples\n        // \"typeName\"\n        [\n          'typeRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'typedef', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //  counter-examples)\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // TypeScript may allow it to be dropped if followed by @property or @member;\n        //   also shown as missing in Closure\n        // \"namepath\"\n        [\n          'nameRequired', isJsdocOrPermissive,\n        ],\n\n        // Is not `typeRequired` for TypeScript because it gives an error:\n        // JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n\n        // TypeScript may allow it to be dropped if followed by @property or @member\n        // \"namepath\"\n        [\n          'typeOrNameRequired', !isTypescript,\n        ],\n      ]),\n    ],\n\n    [\n      'var', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'yields', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'yield', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n  ]);\n};\n\nexport default getDefaultTagStructureForMode;\n"],"file":"getDefaultTagStructureForMode.js"}
+{"version":3,"sources":["../src/getDefaultTagStructureForMode.js"],"names":["getDefaultTagStructureForMode","mode","isJsdoc","isClosure","isTypescript","isPermissive","isJsdocOrPermissive","isJsdocOrTypescript","isTypescriptOrClosure","isClosureOrPermissive","isJsdocTypescriptOrPermissive","Map"],"mappings":";;;;;;;AAAA,MAAMA,6BAA6B,GAAIC,IAAD,IAAU;AAC9C,QAAMC,OAAO,GAAGD,IAAI,KAAK,OAAzB;AACA,QAAME,SAAS,GAAGF,IAAI,KAAK,SAA3B;AACA,QAAMG,YAAY,GAAGH,IAAI,KAAK,YAA9B;AACA,QAAMI,YAAY,GAAGJ,IAAI,KAAK,YAA9B;AAEA,QAAMK,mBAAmB,GAAGJ,OAAO,IAAIG,YAAvC;AACA,QAAME,mBAAmB,GAAGL,OAAO,IAAIE,YAAvC;AACA,QAAMI,qBAAqB,GAAGJ,YAAY,IAAID,SAA9C;AACA,QAAMM,qBAAqB,GAAGN,SAAS,IAAIE,YAA3C;AACA,QAAMK,6BAA6B,GAAGH,mBAAmB,IAAIF,YAA7D,CAV8C,CAY9C;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AAEA;AACA;AAEA;AACA;AACA;AACA;AAEA;AACA;AAEA;AACA;AACA;AACA;AACA;;AAEA,SAAO,IAAIM,GAAJ,CAAQ,CACb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,EAMf;AACA,GACE,oBADF,EACwB,IADxB,CAPe,CAAR,CADX,CADa,EAeb,CACE,KADF,EACS,IAAIA,GAAJ,CAAQ,CACb,CACE,cADF,EACkB,mBADlB,CADa,EAKb;AACA,GACE,cADF,EACkB,IADlB,CANa,EAUb;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZa,CAAR,CADT,CAfa,EAkCb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,mBADlB,CADkB,EAKlB;AACA,GACE,cADF,EACkB,IADlB,CANkB,EAUlB;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZkB,CAAR,CADd,CAlCa,EAqDb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,sBADlB,CAFkB,EAMlB;AACA,GACE,aADF,EACiB,IADjB,CAPkB,EAWlB;AACA,GACE,oBADF,EACwB,IADxB,CAZkB,CAAR,CADd,CArDa,EAwEb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHiB,EAOjB;AACA,GACE,oBADF,EACwB,IADxB,CARiB,CAAR,CADb,CAxEa,EAuFb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJkB,EAQlB;AACA,GACE,cADF,EACkB,IADlB,CATkB,CAAR,CADd,CAvFa,EAuGb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,EAMf;AACA,GACE,aADF,EACiB,IADjB,CAPe,EAWf,CACE,aADF,EACiB,IADjB,CAXe,CAAR,CADX,CAvGa,EAyHb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,EAMf,CACE,aADF,EACiB,IADjB,CANe,CAAR,CADX,CAzHa,EAqIb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,mBADlB,CAFkB,EAMlB,CACE,aADF,EACiB,IADjB,CANkB,CAAR,CADd,CArIa,EAiJb,CACE,aADF,EACiB,IAAIA,GAAJ,CAAQ,CACrB;AACA,GACE,cADF,EACkB,mBADlB,CAFqB,EAMrB,CACE,aADF,EACiB,IADjB,CANqB,CAAR,CADjB,CAjJa,EA8Jb,CACE,YADF,EACgB,IAAIA,GAAJ,CAAQ,CACpB;AACA,GACE,cADF,EACkB,mBADlB,CAFoB,EAMpB,CACE,cADF,EACkB,KADlB,CANoB,EAUpB,CACE,aADF,EACiB,KADjB,CAVoB,CAAR,CADhB,CA9Ja,EA+Kb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB,CACE,cADF,EACkBR,SADlB,CADgB,CAAR,CADZ,CA/Ka,EAuLb,CACE,OADF,EACW,IAAIQ,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,EAMf,CACE,cADF,EACkB,IADlB,CANe,EAUf,CACE,aADF,EACiB,KADjB,CAVe,CAAR,CADX,CAvLa,EAwMb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA,GACE,aADF,EACiB,IADjB,CAFc,CAAR,CADV,CAxMa,EAiNb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,IADlB,CAFe,EAMf;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CATe,CAAR,CADX,CAjNa,EAiOb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,aADF,EACiB,IADjB,CAFmB,CAAR,CADf,CAjOa,EA0Ob;AACA,GACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB,CACE,aADF,EACiBF,qBADjB,CADgB,CAAR,CADZ,CA3Oa,EAmPb,CACE,SADF,EACa,IAAIE,GAAJ,CAAQ,CACjB,CACE,cADF,EACkB,mBADlB,CADiB,EAKjB,CACE,cADF,EACkBT,OADlB,CALiB,EASjB,CACE,aADF,EACiBO,qBADjB,CATiB,CAAR,CADb,CAnPa,EAmQb,CACE,SADF,EACa,IAAIE,GAAJ,CAAQ,CACjB;AACA,GACE,cADF,EACkB,sBADlB,CAFiB,EAMjB;AACA,GACE,aADF,EACiBH,qBAAqB,IAAIH,YAD1C,CAPiB,EAWjB,CACE,cADF,EACkBH,OADlB,CAXiB,EAejB;AACA,GACE,oBADF,EACwBM,qBAAqB,IAAIH,YADjD,CAhBiB,CAAR,CADb,CAnQa,EA0Rb,CACE,UADF,EACc,IAAIM,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJkB,EAQlB;AACA,GACE,cADF,EACkB,IADlB,CATkB,EAalB,CACE,aADF,EACiB,KADjB,CAbkB,CAAR,CADd,CA1Ra,EA8Sb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHe,EAOf,CACE,cADF,EACkB,IADlB,CAPe,EAWf,CACE,aADF,EACiB,KADjB,CAXe,CAAR,CADX,CA9Sa,EAgUb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,mBADlB,CAFkB,EAMlB,CACE,cADF,EACkB,KADlB,CANkB,EAUlB,CACE,aADF,EACiB,KADjB,CAVkB,CAAR,CADd,CAhUa,EAgVb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA,GACE,cADF,EACkB,mBADlB,CAFc,CAAR,CADV,CAhVa,EAyVb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAJc,EAQd;AACA,GACE,cADF,EACkB,IADlB,CATc,EAad,CACE,aADF,EACiB,KADjB,CAbc,CAAR,CADV,CAzVa,EA6Wb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,cADF,EAEED,6BAA6B,GAAG,mBAAH,GAAyB,KAFxD,CAFmB,EAOnB;AACA,GACE,aADF,EACiBP,SADjB,CARmB,EAYnB,CACE,aADF,EACiB,KADjB,CAZmB,CAAR,CADf,CA7Wa,EAgYb,CACE,YADF,EACgB,IAAIQ,GAAJ,CAAQ,CACpB;AACA;AACA,GACE,cADF,EACkB,IADlB,CAHoB,CAAR,CADhB,CAhYa,EA0Yb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,sBADlB,CAFe,EAMf;AACA,GACE,oBADF,EACwB,IADxB,CAPe,CAAR,CADX,CA1Ya,EAwZb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHiB,EAOjB,CACE,cADF,EACkB,IADlB,CAPiB,EAWjB,CACE,aADF,EACiB,KADjB,CAXiB,CAAR,CADb,CAxZa,EA0ab,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,cADF,EACkB,mBADlB,CAFgB,EAMhB;AACA,GACE,aADF,EACiB,IADjB,CAPgB,CAAR,CADZ,CA1aa,EAwbb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHkB,EAOlB;AACA,GACE,oBADF,EACwB,IADxB,CARkB,CAAR,CADd,CAxba,EAscb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHmB,EAOnB;AACA,GACE,oBADF,EACwB,IADxB,CARmB,CAAR,CADf,CAtca,EAqdb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,cADF,EACkB,mBADlB,CAFgB,CAAR,CADZ,CArda,EA6db,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA;AACA,GACE,cADF,EACkB,sBADlB,CAHe,EAOf;AACA,GACE,oBADF,EACwB,IADxB,CARe,CAAR,CADX,CA7da,EA4eb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,cADF,EACkB,mBADlB,CAFe,EAMf,CACE,cADF,EACkB,KADlB,CANe,EAUf,CACE,aADF,EACiB,KADjB,CAVe,CAAR,CADX,CA5ea,EA6fb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA;AACA;AACA,GACE,aADF,EACiB,IADjB,CAJkB,CAAR,CADd,CA7fa,EAwgBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA;AACA;AACA,GACE,cADF,EACkBT,OAAO,GAAG,mBAAH,GAAyB,MADlD,CAJgB,EAQhB;AACA,GACE,aADF,EACiB,IADjB,CATgB,CAAR,CADZ,CAxgBa,EAwhBb,CACE,MADF,EACU,IAAIS,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAHc,EAOd;AACA,GACE,cADF,EACkB,IADlB,CARc,EAYd;AACA,GACE,oBADF,EACwB,IADxB,CAbc,CAAR,CADV,CAxhBa,EA4iBb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA,GACE,cADF,EACkB,mBADlB,CAFmB,EAMnB;AACA,GACE,aADF,EACiB,IADjB,CAPmB,CAAR,CADf,CA5iBa,EAyjBb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHiB,CAAR,CADb,CAzjBa,EAmkBb,CACE,OADF,EACW,IAAIE,GAAJ,CAAQ,CACf,CACE,cADF,EACkB,mBADlB,CADe,EAKf;AACA;AACA;AACA;AACA,GACE,cADF,EACkB,IADlB,CATe,EAaf;AACA;AACA,GACE,aADF,EACiB,IADjB,CAfe,CAAR,CADX,CAnkBa,EAylBb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHiB,CAAR,CADb,CAzlBa,EAmmBb,CACE,MADF,EACU,IAAIE,GAAJ,CAAQ,CACd,CACE,cADF,EACkB,mBADlB,CADc,EAKd;AACA,GACE,cADF,EACkB,IADlB,CANc,EAUd;AACA;AACA,GACE,aADF,EACiB,IADjB,CAZc,CAAR,CADV,CAnmBa,EAsnBb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,mBADlB,CADkB,EAKlB;AACA;AACA,GACE,cADF,EACkB,IADlB,CAPkB,EAWlB;AACA;AACA,GACE,aADF,EACiB,IADjB,CAbkB,CAAR,CADd,CAtnBa,EA0oBb,CACE,WADF,EACe,IAAIA,GAAJ,CAAQ,CACnB;AACA;AACA,GACE,aADF,EACiBF,qBADjB,CAHmB,CAAR,CADf,CA1oBa,EAopBb,CACE,QADF,EACY,IAAIE,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiBF,qBADjB,CAFgB,CAAR,CADZ,CAppBa,EA6pBb,CACE,UADF,EACc,IAAIE,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,sBADlB,CAFkB,EAMlB,CACE,cADF,EACkB,IADlB,CANkB,EAUlB,CACE,aADF,EACiB,KADjB,CAVkB,CAAR,CADd,CA7pBa,EA8qBb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA,GACE,aADF,EACiB,IADjB,CAFiB,CAAR,CADb,CA9qBa,EAsrBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CAtrBa,EA+rBb,CACE,KADF,EACS,IAAIA,GAAJ,CAAQ,CACb;AACA;AACA,GACE,cADF,EACkB,MADlB,CAHa,CAAR,CADT,CA/rBa,EAysBb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiBF,qBADjB,CAFgB,CAAR,CADZ,CAzsBa,EAktBb,CACE,UADF,EACc,IAAIE,GAAJ,CAAQ,CAClB,CACE,cADF,EACkB,CAACR,SADnB,CADkB,EAIlB,CACE,cADF,EACkBA,SADlB,CAJkB,CAAR,CADd,CAltBa,EA6tBb,CACE,UADF,EACc,IAAIQ,GAAJ,CAAQ,CAClB,CACE,cADF,EACkBT,OAAO,GAAG,MAAH,GAAY,sBADrC,CADkB,EAKlB;AACA;AACA;AACA,GACE,aADF,EACiBM,qBAAqB,IAAIH,YAD1C,CARkB,CAAR,CADd,CA7tBa,EA4uBb,CACE,MADF,EACU,IAAIM,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkBT,OAAO,GAAG,sBAAH,GAA4B,KADrD,CAHc,EAOd,CACE,cADF,EACkBM,qBADlB,CAPc,EAWd;AACA,GACE,oBADF,EACwBN,OADxB,CAZc,CAAR,CADV,CA5uBa,EA+vBb,CACE,QADF,EACY,IAAIS,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CA/vBa,EAwwBb,CACE,UADF,EACc,IAAIA,GAAJ,CAAQ,CAClB;AACA,GACE,cADF,EACkB,IADlB,CAFkB,EAMlB,CACE,aADF,EACiB,KADjB,CANkB,CAAR,CADd,CAxwBa,EAqxBb,CACE,MADF,EACU,IAAIA,GAAJ,CAAQ,CACd;AACA;AACA,GACE,cADF,EACkB,IADlB,CAHc,CAAR,CADV,CArxBa,EA+xBb,CACE,SADF,EACa,IAAIA,GAAJ,CAAQ,CACjB;AACA;AACA,GACE,cADF,EACkB,mBADlB,CAHiB,EAOjB;AACA;AACA;AACA,GACE,cADF,EACkBL,mBADlB,CAViB,EAcjB;AACA;AAEA;AACA,GACE,aADF,EACiB,IADjB,CAlBiB,EAsBjB;AACA;AACA,GACE,oBADF,EACwB,CAACF,YADzB,CAxBiB,CAAR,CADb,CA/xBa,EA8zBb,CACE,KADF,EACS,IAAIO,GAAJ,CAAQ,CACb;AACA,GACE,cADF,EACkB,mBADlB,CAFa,EAMb;AACA,GACE,aADF,EACiB,IADjB,CAPa,CAAR,CADT,CA9zBa,EA40Bb,CACE,QADF,EACY,IAAIA,GAAJ,CAAQ,CAChB;AACA,GACE,aADF,EACiB,IADjB,CAFgB,CAAR,CADZ,CA50Ba,EAo1Bb,CACE,OADF,EACW,IAAIA,GAAJ,CAAQ,CACf;AACA,GACE,aADF,EACiB,IADjB,CAFe,CAAR,CADX,CAp1Ba,CAAR,CAAP;AA61BD,CAv4BD;;eAy4BeX,6B","sourcesContent":["const getDefaultTagStructureForMode = (mode) => {\n  const isJsdoc = mode === 'jsdoc';\n  const isClosure = mode === 'closure';\n  const isTypescript = mode === 'typescript';\n  const isPermissive = mode === 'permissive';\n\n  const isJsdocOrPermissive = isJsdoc || isPermissive;\n  const isJsdocOrTypescript = isJsdoc || isTypescript;\n  const isTypescriptOrClosure = isTypescript || isClosure;\n  const isClosureOrPermissive = isClosure || isPermissive;\n  const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;\n\n  // Properties:\n  // `nameContents` - 'namepath-referencing'|'namepath-defining'|'text'|false\n  // `typeAllowed` - boolean\n  // `nameRequired` - boolean\n  // `typeRequired` - boolean\n  // `typeOrNameRequired` - boolean\n\n  // All of `typeAllowed` have a signature with \"type\" except for\n  //  `augments`/`extends` (\"namepath\")\n  //  `param`/`arg`/`argument` (no signature)\n  //  `property`/`prop` (no signature)\n  //  `modifies` (undocumented)\n\n  // None of the `nameContents: 'namepath-defining'` show as having curly\n  //  brackets for their name/namepath\n\n  // Among `namepath-defining` and `namepath-referencing`, these do not seem\n  //  to allow curly brackets in their doc signature or examples (`modifies`\n  //  references namepaths within its type brackets and `param` is\n  //  name-defining but not namepath-defining, so not part of these groups)\n\n  // Todo: Should support special processing for \"name\" as distinct from\n  //   \"namepath\" (e.g., param can't define a namepath)\n\n  // Once checking inline tags:\n  // Todo: Re: `typeOrNameRequired`, `@link` (or @linkcode/@linkplain) seems\n  //  to require a namepath OR URL and might be checked as such.\n  // Todo: Should support a `tutorialID` type (for `@tutorial` block and\n  //  inline)\n\n  return new Map([\n    [\n      'alias', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'arg', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `param`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'argument', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `param`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'augments', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // Does not show curly brackets in either the signature or examples\n        [\n          'typeAllowed', true,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'borrows', new Map([\n        // `borrows` has a different format, however, so needs special parsing;\n        //   seems to require both, and as \"namepath\"'s\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'callback', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //   counter-examples); TypeScript does not enforce but seems\n        //   problematic as not attached so presumably not useable without it\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"namepath\"\n        [\n          'nameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'class', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Not in use, but should be this value if using to power `empty-tags`\n        [\n          'nameAllowed', true,\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'const', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'constant', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'constructor', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'constructs', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'nameRequired', false,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'define', new Map([\n        [\n          'typeRequired', isClosure,\n        ],\n      ]),\n    ],\n\n    [\n      'emits', new Map([\n        // Signature seems to require a \"name\" (of an event) and no counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'enum', new Map([\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'event', new Map([\n        // The doc signature of `event` seems to require a \"name\"\n        [\n          'nameRequired', true,\n        ],\n\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n\n    [\n      'exception', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    // Closure\n    [\n      'export', new Map([\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'exports', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'nameRequired', isJsdoc,\n        ],\n\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'extends', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // Does not show curly brackets in either the signature or examples\n        [\n          'typeAllowed', isTypescriptOrClosure || isPermissive,\n        ],\n\n        [\n          'nameRequired', isJsdoc,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', isTypescriptOrClosure || isPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'external', new Map([\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"name\" (and a special syntax for the `external` name)\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'fires', new Map([\n        // Signature seems to require a \"name\" (of an event) and no\n        //  counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'function', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'nameRequired', false,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n    [\n      'func', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n\n    [\n      'host', new Map([\n        // Appears to require a \"name\" in its signature, albeit somewhat\n        //  different from other \"name\"'s (including as described\n        //  at https://jsdoc.app/about-namepaths.html )\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `external`\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'interface', new Map([\n        // Allows for \"name\" in signature, but indicates as optional\n        [\n          'nameContents',\n          isJsdocTypescriptOrPermissive ? 'namepath-defining' : false,\n        ],\n\n        // Not in use, but should be this value if using to power `empty-tags`\n        [\n          'nameAllowed', isClosure,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'implements', new Map([\n        // Shows curly brackets in the doc signature and examples\n        // \"typeExpression\"\n        [\n          'typeRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'lends', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'listens', new Map([\n        // Signature seems to require a \"name\" (of an event) and no\n        //  counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'member', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'memberof', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples),\n        //  though it allows an incomplete namepath ending with connecting symbol\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n    [\n      'memberof!', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples),\n        //  though it allows an incomplete namepath ending with connecting symbol\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'method', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n      ]),\n    ],\n    [\n      'mixes', new Map([\n        // Signature seems to require a \"OtherObjectPath\" with no\n        //   counter-examples\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        // \"OtherObjectPath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'mixin', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        [\n          'nameRequired', false,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'modifies', new Map([\n        // Has no documentation, but test example has curly brackets, and\n        //  \"name\" would be suggested rather than \"namepath\" based on example;\n        //  not sure if name is required\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'module', new Map([\n        // Optional \"name\" and no curly brackets\n        //  this block impacts `no-undefined-types` and `valid-types` (search for\n        //  \"isNamepathDefiningTag|tagMightHaveNamepath|tagMightHaveEitherTypeOrNamePosition\")\n        [\n          'nameContents', isJsdoc ? 'namepath-defining' : 'text',\n        ],\n\n        // Shows the signature with curly brackets but not in the example\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'name', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //   counter-examples)\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // \"namepath\"\n        [\n          'nameRequired', true,\n        ],\n\n        // \"namepath\"\n        [\n          'typeOrNameRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'namespace', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Shows the signature with curly brackets but not in the example\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'package', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'param', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Though no signature provided requiring, per\n        //  https://jsdoc.app/tags-param.html:\n        // \"The @param tag requires you to specify the name of the parameter you\n        //  are documenting.\"\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'private', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'prop', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // See `property`\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'property', new Map([\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // No docs indicate required, but since parallel to `param`, we treat as\n        //   such:\n        [\n          'nameRequired', true,\n        ],\n\n        // Has no formal signature in the docs but shows curly brackets\n        //   in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'protected', new Map([\n        // Shows the signature with curly brackets but not in the example\n        // \"typeExpression\"\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'public', new Map([\n        // Does not show a signature nor show curly brackets in the example\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'requires', new Map([\n        // <someModuleName>\n        [\n          'nameContents', 'namepath-referencing',\n        ],\n\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'returns', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'return', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'see', new Map([\n        // Signature allows for \"namepath\" or text, so user must configure to\n        //  'namepath-referencing' to enforce checks\n        [\n          'nameContents', 'text',\n        ],\n      ]),\n    ],\n\n    [\n      'static', new Map([\n        // Does not show a signature nor show curly brackets in the example\n        [\n          'typeAllowed', isClosureOrPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'suppress', new Map([\n        [\n          'nameContents', !isClosure,\n        ],\n        [\n          'typeRequired', isClosure,\n        ],\n      ]),\n    ],\n\n    [\n      'template', new Map([\n        [\n          'nameContents', isJsdoc ? 'text' : 'namepath-referencing',\n        ],\n\n        // Though defines `nameContents: 'namepath-defining'` in a sense, it is\n        //   not parseable in the same way for template (e.g., allowing commas),\n        //   so not adding\n        [\n          'typeAllowed', isTypescriptOrClosure || isPermissive,\n        ],\n      ]),\n    ],\n\n    [\n      'this', new Map([\n        // Signature seems to require a \"namepath\" (and no counter-examples)\n        // Not used with namepath in Closure/TypeScript, however\n        [\n          'nameContents', isJsdoc ? 'namepath-referencing' : false,\n        ],\n\n        [\n          'typeRequired', isTypescriptOrClosure,\n        ],\n\n        // namepath\n        [\n          'typeOrNameRequired', isJsdoc,\n        ],\n      ]),\n    ],\n\n    [\n      'throws', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'tutorial', new Map([\n        // (a tutorial ID)\n        [\n          'nameRequired', true,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ]),\n    ],\n\n    [\n      'type', new Map([\n        // Shows curly brackets in the doc signature and examples\n        // \"typeName\"\n        [\n          'typeRequired', true,\n        ],\n      ]),\n    ],\n\n    [\n      'typedef', new Map([\n        // Seems to require a \"namepath\" in the signature (with no\n        //  counter-examples)\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // TypeScript may allow it to be dropped if followed by @property or @member;\n        //   also shown as missing in Closure\n        // \"namepath\"\n        [\n          'nameRequired', isJsdocOrPermissive,\n        ],\n\n        // Is not `typeRequired` for TypeScript because it gives an error:\n        // JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n\n        // TypeScript may allow it to be dropped if followed by @property or @member\n        // \"namepath\"\n        [\n          'typeOrNameRequired', !isTypescript,\n        ],\n      ]),\n    ],\n\n    [\n      'var', new Map([\n        // Allows for \"name\"'s in signature, but indicated as optional\n        [\n          'nameContents', 'namepath-defining',\n        ],\n\n        // Has example showing curly brackets but not in doc signature\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n\n    [\n      'yields', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n    [\n      'yield', new Map([\n        // Shows curly brackets in the signature and in the examples\n        [\n          'typeAllowed', true,\n        ],\n      ]),\n    ],\n  ]);\n};\n\nexport default getDefaultTagStructureForMode;\n"],"file":"getDefaultTagStructureForMode.js"}

package/dist/iterateJsdoc.js

@@ -779,6 +779,8 @@ const makeReport = (context, commentNode) => {
 
   return report;
 };
+/* eslint-disable jsdoc/no-undefined-types -- Need to build this in; see https://www.typescriptlang.org/docs/handbook/utility-types.html */
+
 /**
  * @typedef {ReturnType<typeof getUtils>} Utils
  * @typedef {ReturnType<typeof getSettings>} Settings
@@ -797,6 +799,8 @@ const makeReport = (context, commentNode) => {
  * ) => any } JsdocVisitor
  */
 
+/* eslint-enable jsdoc/no-undefined-types -- Need to build this in */
+
 
 const iterate = (info, indent, jsdoc, ruleConfig, context, lines, jsdocNode, node, settings, sourceCode, iterator, state, iteratingAll) => {
   const report = makeReport(context, jsdocNode);