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

package/dist/generateRule.cjs

@@ -0,0 +1,248 @@
+"use strict";
+
+var _camelcase = _interopRequireDefault(require("camelcase"));
+var _nodeFs = require("node:fs");
+var _promises = _interopRequireDefault(require("node:fs/promises"));
+var _nodePath = require("node:path");
+var _openEditor = _interopRequireDefault(require("open-editor"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); } /* eslint-disable no-console -- CLI */ /**
+ * @example
+ * ```shell
+ * pnpm run create-rule my-new-rule -- --recommended
+ * ```
+ */
+// Todo: Would ideally have prompts, e.g., to ask for whether
+//   type was problem/layout, etc.
+
+const [,, ruleName, ...options] = process.argv;
+const recommended = options.includes('--recommended');
+(async () => {
+  if (!ruleName) {
+    console.error('Please supply a rule name');
+    return;
+  }
+  if (/[A-Z]/v.test(ruleName)) {
+    console.error('Please ensure the rule has no capital letters');
+    return;
+  }
+  const ruleNamesPath = './test/rules/ruleNames.json';
+  const ruleNames = JSON.parse(await _promises.default.readFile(
+  // eslint-disable-next-line unicorn/prefer-json-parse-buffer -- TypeScript
+  ruleNamesPath, 'utf8'));
+  if (!ruleNames.includes(ruleName)) {
+    ruleNames.push(ruleName);
+    ruleNames.sort();
+  }
+  await _promises.default.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\n');
+  console.log('ruleNames', ruleNames);
+  const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc.js';
+
+export default iterateJsdoc(({
+  context,
+  utils,
+}) => {
+  // Rule here
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: '',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',
+    },
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          // Option properties here (or remove the object)
+        },
+        type: 'object',
+      },
+    ],
+    type: 'suggestion',
+  },
+});
+`;
+  const camelCasedRuleName = (0, _camelcase.default)(ruleName);
+  const rulePath = `./src/rules/${camelCasedRuleName}.js`;
+  if (!(0, _nodeFs.existsSync)(rulePath)) {
+    await _promises.default.writeFile(rulePath, ruleTemplate);
+  }
+  const ruleTestTemplate = `export default {
+  invalid: [
+    {
+      code: \`
+      \`,
+      errors: [
+        {
+          line: 2,
+          message: '',
+        },
+      ],
+    },
+  ],
+  valid: [
+    {
+      code: \`
+      \`,
+    },
+  ],
+};
+`;
+  const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;
+  if (!(0, _nodeFs.existsSync)(ruleTestPath)) {
+    await _promises.default.writeFile(ruleTestPath, ruleTestTemplate);
+  }
+  const ruleReadmeTemplate = `# \`${ruleName}\`
+
+## Options
+
+{"gitdown": "options"}
+
+|||
+|---|---|
+|Context|everywhere|
+|Tags|\`\`|
+|Recommended|${recommended ? 'true' : 'false'}|
+|Settings||
+|Options||
+
+## Failing examples
+
+<!-- assertions-failing ${camelCasedRuleName} -->
+
+## Passing examples
+
+<!-- assertions-passing ${camelCasedRuleName} -->
+`;
+  const ruleReadmePath = `./.README/rules/${ruleName}.md`;
+  if (!(0, _nodeFs.existsSync)(ruleReadmePath)) {
+    await _promises.default.writeFile(ruleReadmePath, ruleReadmeTemplate);
+  }
+
+  /**
+   * @param {object} cfg
+   * @param {string} cfg.path
+   * @param {RegExp} cfg.oldRegex
+   * @param {string} cfg.checkName
+   * @param {string} cfg.newLine
+   * @param {boolean} [cfg.oldIsCamel]
+   * @returns {Promise<void>}
+   */
+  const replaceInOrder = async ({
+    checkName,
+    newLine,
+    oldIsCamel,
+    oldRegex,
+    path
+  }) => {
+    /**
+     * @typedef {number} Integer
+     */
+    /**
+     * @typedef {{
+     *   matchedLine: string,
+     *   offset: Integer,
+     *   oldRule: string,
+     * }} OffsetInfo
+     */
+    /**
+     * @type {OffsetInfo[]}
+     */
+    const offsets = [];
+    let readme = await _promises.default.readFile(path, 'utf8');
+    readme.replace(oldRegex,
+    /**
+     * @param {string} matchedLine
+     * @param {string} n1
+     * @param {Integer} offset
+     * @param {string} str
+     * @param {object} groups
+     * @param {string} groups.oldRule
+     * @returns {string}
+     */
+    (matchedLine, n1, offset, str, {
+      oldRule
+    }) => {
+      offsets.push({
+        matchedLine,
+        offset,
+        oldRule
+      });
+      return matchedLine;
+    });
+    offsets.sort(({
+      oldRule
+    }, {
+      oldRule: oldRuleB
+    }) => {
+      return oldRule < oldRuleB ? -1 : oldRule > oldRuleB ? 1 : 0;
+    });
+    let alreadyIncluded = false;
+    const itemIndex = offsets.findIndex(({
+      oldRule
+    }) => {
+      alreadyIncluded ||= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;
+      return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;
+    });
+    let item = itemIndex !== undefined && offsets[itemIndex];
+    if (item && itemIndex === 0 &&
+    // This property would not always be sufficient but in this case it is.
+    oldIsCamel) {
+      item.offset = 0;
+    }
+    if (!item) {
+      item = /** @type {OffsetInfo} */offsets.pop();
+      item.offset += item.matchedLine.length;
+    }
+    if (alreadyIncluded) {
+      console.log(`Rule name is already present in ${checkName}.`);
+    } else {
+      readme = readme.slice(0, item.offset) + (item.offset ? '\n' : '') + newLine + (item.offset ? '' : '\n') + readme.slice(item.offset);
+      await _promises.default.writeFile(path, readme);
+    }
+  };
+
+  // await replaceInOrder({
+  //   checkName: 'README',
+  //   newLine: `{"gitdown": "include", "file": "./rules/${ruleName}.md"}`,
+  //   oldRegex: /\n\{"gitdown": "include", "file": ".\/rules\/(?<oldRule>[^.]*).md"\}/gv,
+  //   path: './.README/README.md',
+  // });
+
+  await replaceInOrder({
+    checkName: 'index import',
+    newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}.js';`,
+    oldIsCamel: true,
+    oldRegex: /\nimport (?<oldRule>[^ ]*) from '.\/rules\/\1\.js';/gv,
+    path: './src/index-cjs.js'
+  });
+  await replaceInOrder({
+    checkName: 'index recommended',
+    newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\'off\''},`,
+    oldRegex: /\n\s{6}'jsdoc\/(?<oldRule>[^']*)': .*?,/gv,
+    path: './src/index-cjs.js'
+  });
+  await replaceInOrder({
+    checkName: 'index rules',
+    newLine: `${' '.repeat(2)}'${ruleName}': ${camelCasedRuleName},`,
+    oldRegex: /\n\s{2}'(?<oldRule>[^']*)': [^,]*,/gv,
+    path: './src/index-cjs.js'
+  });
+  await Promise.resolve().then(() => _interopRequireWildcard(require('./buildEntryFileForTS.js')));
+  await Promise.resolve().then(() => _interopRequireWildcard(require('./generateDocs.js')));
+
+  /*
+  console.log('Paths to open for further editing\n');
+  console.log(`open ${ruleReadmePath}`);
+  console.log(`open ${rulePath}`);
+  console.log(`open ${ruleTestPath}\n`);
+  */
+
+  // Set chdir as somehow still in operation from other test
+  process.chdir((0, _nodePath.resolve)(__dirname, '../../'));
+  await (0, _openEditor.default)([
+  // Could even add editor line column numbers like `${rulePath}:1:1`
+  ruleReadmePath, ruleTestPath, rulePath]);
+})();
+//# sourceMappingURL=generateRule.cjs.map

package/dist/generateRule.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRule.cjs","names":["_camelcase","_interopRequireDefault","require","_nodeFs","_promises","_nodePath","_openEditor","e","__esModule","default","_interopRequireWildcard","t","WeakMap","r","n","o","i","f","__proto__","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","ruleName","options","process","argv","recommended","includes","console","error","test","ruleNamesPath","ruleNames","JSON","parse","fs","readFile","push","sort","writeFile","stringify","log","ruleTemplate","camelCasedRuleName","camelCase","rulePath","existsSync","ruleTestTemplate","ruleTestPath","ruleReadmeTemplate","ruleReadmePath","replaceInOrder","checkName","newLine","oldIsCamel","oldRegex","path","offsets","readme","replace","matchedLine","n1","offset","str","oldRule","oldRuleB","alreadyIncluded","itemIndex","findIndex","item","undefined","pop","length","slice","repeat","Promise","resolve","then","chdir","__dirname","open"],"sources":["../src/bin/generateRule.js"],"sourcesContent":["/* eslint-disable no-console -- CLI */\n/**\n * @example\n * ```shell\n * pnpm run create-rule my-new-rule -- --recommended\n * ```\n */\n\nimport camelCase from 'camelcase';\nimport {\n  existsSync,\n} from 'node:fs';\nimport fs from 'node:fs/promises';\nimport {\n  resolve,\n} from 'node:path';\nimport open from 'open-editor';\n\n// Todo: Would ideally have prompts, e.g., to ask for whether\n//   type was problem/layout, etc.\n\nconst [\n  , , ruleName,\n  ...options\n] = process.argv;\n\nconst recommended = options.includes('--recommended');\n\n(async () => {\n  if (!ruleName) {\n    console.error('Please supply a rule name');\n\n    return;\n  }\n\n  if ((/[A-Z]/v).test(ruleName)) {\n    console.error('Please ensure the rule has no capital letters');\n\n    return;\n  }\n\n  const ruleNamesPath = './test/rules/ruleNames.json';\n  const ruleNames = JSON.parse(await fs.readFile(\n    // eslint-disable-next-line unicorn/prefer-json-parse-buffer -- TypeScript\n    ruleNamesPath, 'utf8',\n  ));\n  if (!ruleNames.includes(ruleName)) {\n    ruleNames.push(ruleName);\n    ruleNames.sort();\n  }\n\n  await fs.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\\n');\n  console.log('ruleNames', ruleNames);\n\n  const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  context,\n  utils,\n}) => {\n  // Rule here\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: '',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          // Option properties here (or remove the object)\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n`;\n\n  const camelCasedRuleName = camelCase(ruleName);\n\n  const rulePath = `./src/rules/${camelCasedRuleName}.js`;\n\n  if (!existsSync(rulePath)) {\n    await fs.writeFile(rulePath, ruleTemplate);\n  }\n\n  const ruleTestTemplate = `export default {\n  invalid: [\n    {\n      code: \\`\n      \\`,\n      errors: [\n        {\n          line: 2,\n          message: '',\n        },\n      ],\n    },\n  ],\n  valid: [\n    {\n      code: \\`\n      \\`,\n    },\n  ],\n};\n`;\n\n  const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;\n  if (!existsSync(ruleTestPath)) {\n    await fs.writeFile(ruleTestPath, ruleTestTemplate);\n  }\n\n  const ruleReadmeTemplate = `# \\`${ruleName}\\`\n\n## Options\n\n{\"gitdown\": \"options\"}\n\n|||\n|---|---|\n|Context|everywhere|\n|Tags|\\`\\`|\n|Recommended|${recommended ? 'true' : 'false'}|\n|Settings||\n|Options||\n\n## Failing examples\n\n<!-- assertions-failing ${camelCasedRuleName} -->\n\n## Passing examples\n\n<!-- assertions-passing ${camelCasedRuleName} -->\n`;\n\n  const ruleReadmePath = `./.README/rules/${ruleName}.md`;\n  if (!existsSync(ruleReadmePath)) {\n    await fs.writeFile(ruleReadmePath, ruleReadmeTemplate);\n  }\n\n  /**\n   * @param {object} cfg\n   * @param {string} cfg.path\n   * @param {RegExp} cfg.oldRegex\n   * @param {string} cfg.checkName\n   * @param {string} cfg.newLine\n   * @param {boolean} [cfg.oldIsCamel]\n   * @returns {Promise<void>}\n   */\n  const replaceInOrder = async ({\n    checkName,\n    newLine,\n    oldIsCamel,\n    oldRegex,\n    path,\n  }) => {\n    /**\n     * @typedef {number} Integer\n     */\n    /**\n     * @typedef {{\n     *   matchedLine: string,\n     *   offset: Integer,\n     *   oldRule: string,\n     * }} OffsetInfo\n     */\n    /**\n     * @type {OffsetInfo[]}\n     */\n    const offsets = [];\n\n    let readme = await fs.readFile(path, 'utf8');\n    readme.replace(\n      oldRegex,\n      /**\n       * @param {string} matchedLine\n       * @param {string} n1\n       * @param {Integer} offset\n       * @param {string} str\n       * @param {object} groups\n       * @param {string} groups.oldRule\n       * @returns {string}\n       */\n      (matchedLine, n1, offset, str, {\n        oldRule,\n      }) => {\n        offsets.push({\n          matchedLine,\n          offset,\n          oldRule,\n        });\n\n        return matchedLine;\n      },\n    );\n\n    offsets.sort(({\n      oldRule,\n    }, {\n      oldRule: oldRuleB,\n    }) => {\n      return oldRule < oldRuleB ? -1 : (oldRule > oldRuleB ? 1 : 0);\n    });\n\n    let alreadyIncluded = false;\n    const itemIndex = offsets.findIndex(({\n      oldRule,\n    }) => {\n      alreadyIncluded ||= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;\n\n      return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;\n    });\n    let item = itemIndex !== undefined && offsets[itemIndex];\n    if (item && itemIndex === 0 &&\n\n      // This property would not always be sufficient but in this case it is.\n      oldIsCamel\n    ) {\n      item.offset = 0;\n    }\n\n    if (!item) {\n      item = /** @type {OffsetInfo} */ (offsets.pop());\n      item.offset += item.matchedLine.length;\n    }\n\n    if (alreadyIncluded) {\n      console.log(`Rule name is already present in ${checkName}.`);\n    } else {\n      readme = readme.slice(0, item.offset) +\n                (item.offset ? '\\n' : '') +\n                newLine +\n                (item.offset ? '' : '\\n') +\n                readme.slice(item.offset);\n\n      await fs.writeFile(path, readme);\n    }\n  };\n\n  // await replaceInOrder({\n  //   checkName: 'README',\n  //   newLine: `{\"gitdown\": \"include\", \"file\": \"./rules/${ruleName}.md\"}`,\n  //   oldRegex: /\\n\\{\"gitdown\": \"include\", \"file\": \".\\/rules\\/(?<oldRule>[^.]*).md\"\\}/gv,\n  //   path: './.README/README.md',\n  // });\n\n  await replaceInOrder({\n    checkName: 'index import',\n    newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}.js';`,\n    oldIsCamel: true,\n    oldRegex: /\\nimport (?<oldRule>[^ ]*) from '.\\/rules\\/\\1\\.js';/gv,\n    path: './src/index-cjs.js',\n  });\n\n  await replaceInOrder({\n    checkName: 'index recommended',\n    newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\\'off\\''},`,\n    oldRegex: /\\n\\s{6}'jsdoc\\/(?<oldRule>[^']*)': .*?,/gv,\n    path: './src/index-cjs.js',\n  });\n\n  await replaceInOrder({\n    checkName: 'index rules',\n    newLine: `${' '.repeat(2)}'${ruleName}': ${camelCasedRuleName},`,\n    oldRegex: /\\n\\s{2}'(?<oldRule>[^']*)': [^,]*,/gv,\n    path: './src/index-cjs.js',\n  });\n\n  await import('./buildEntryFileForTS.js');\n\n  await import('./generateDocs.js');\n\n  /*\n  console.log('Paths to open for further editing\\n');\n  console.log(`open ${ruleReadmePath}`);\n  console.log(`open ${rulePath}`);\n  console.log(`open ${ruleTestPath}\\n`);\n  */\n\n  // Set chdir as somehow still in operation from other test\n  process.chdir(resolve(import.meta.dirname, '../../'));\n  await open([\n    // Could even add editor line column numbers like `${rulePath}:1:1`\n    ruleReadmePath,\n    ruleTestPath,\n    rulePath,\n  ]);\n})();\n"],"mappings":";;AAQA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,SAAA,GAAAH,OAAA;AAGA,IAAAI,WAAA,GAAAL,sBAAA,CAAAC,OAAA;AAA+B,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,wBAAAH,CAAA,EAAAI,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,uBAAA,YAAAA,CAAAH,CAAA,EAAAI,CAAA,SAAAA,CAAA,IAAAJ,CAAA,IAAAA,CAAA,CAAAC,UAAA,SAAAD,CAAA,MAAAQ,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAT,OAAA,EAAAF,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAU,CAAA,MAAAF,CAAA,GAAAJ,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAE,CAAA,CAAAI,GAAA,CAAAZ,CAAA,UAAAQ,CAAA,CAAAK,GAAA,CAAAb,CAAA,GAAAQ,CAAA,CAAAM,GAAA,CAAAd,CAAA,EAAAU,CAAA,gBAAAN,CAAA,IAAAJ,CAAA,gBAAAI,CAAA,OAAAW,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAI,CAAA,OAAAK,CAAA,IAAAD,CAAA,GAAAS,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAnB,CAAA,EAAAI,CAAA,OAAAK,CAAA,CAAAI,GAAA,IAAAJ,CAAA,CAAAK,GAAA,IAAAN,CAAA,CAAAE,CAAA,EAAAN,CAAA,EAAAK,CAAA,IAAAC,CAAA,CAAAN,CAAA,IAAAJ,CAAA,CAAAI,CAAA,WAAAM,CAAA,KAAAV,CAAA,EAAAI,CAAA,KAhB/B,uCACA;AACA;AACA;AACA;AACA;AACA;AAYA;AACA;;AAEA,MAAM,IACAgB,QAAQ,EACZ,GAAGC,OAAO,CACX,GAAGC,OAAO,CAACC,IAAI;AAEhB,MAAMC,WAAW,GAAGH,OAAO,CAACI,QAAQ,CAAC,eAAe,CAAC;AAErD,CAAC,YAAY;EACX,IAAI,CAACL,QAAQ,EAAE;IACbM,OAAO,CAACC,KAAK,CAAC,2BAA2B,CAAC;IAE1C;EACF;EAEA,IAAK,QAAQ,CAAEC,IAAI,CAACR,QAAQ,CAAC,EAAE;IAC7BM,OAAO,CAACC,KAAK,CAAC,+CAA+C,CAAC;IAE9D;EACF;EAEA,MAAME,aAAa,GAAG,6BAA6B;EACnD,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAC,MAAMC,iBAAE,CAACC,QAAQ;EAC5C;EACAL,aAAa,EAAE,MACjB,CAAC,CAAC;EACF,IAAI,CAACC,SAAS,CAACL,QAAQ,CAACL,QAAQ,CAAC,EAAE;IACjCU,SAAS,CAACK,IAAI,CAACf,QAAQ,CAAC;IACxBU,SAAS,CAACM,IAAI,CAAC,CAAC;EAClB;EAEA,MAAMH,iBAAE,CAACI,SAAS,CAACR,aAAa,EAAEE,IAAI,CAACO,SAAS,CAACR,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;EAC5EJ,OAAO,CAACa,GAAG,CAAC,WAAW,EAAET,SAAS,CAAC;EAEnC,MAAMU,YAAY,GAAG;AACvB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,gFAAgFpB,QAAQ;AACxF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMqB,kBAAkB,GAAG,IAAAC,kBAAS,EAACtB,QAAQ,CAAC;EAE9C,MAAMuB,QAAQ,GAAG,eAAeF,kBAAkB,KAAK;EAEvD,IAAI,CAAC,IAAAG,kBAAU,EAACD,QAAQ,CAAC,EAAE;IACzB,MAAMV,iBAAE,CAACI,SAAS,CAACM,QAAQ,EAAEH,YAAY,CAAC;EAC5C;EAEA,MAAMK,gBAAgB,GAAG;AAC3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMC,YAAY,GAAG,2BAA2BL,kBAAkB,KAAK;EACvE,IAAI,CAAC,IAAAG,kBAAU,EAACE,YAAY,CAAC,EAAE;IAC7B,MAAMb,iBAAE,CAACI,SAAS,CAACS,YAAY,EAAED,gBAAgB,CAAC;EACpD;EAEA,MAAME,kBAAkB,GAAG,OAAO3B,QAAQ;AAC5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeI,WAAW,GAAG,MAAM,GAAG,OAAO;AAC7C;AACA;AACA;AACA;AACA;AACA,0BAA0BiB,kBAAkB;AAC5C;AACA;AACA;AACA,0BAA0BA,kBAAkB;AAC5C,CAAC;EAEC,MAAMO,cAAc,GAAG,mBAAmB5B,QAAQ,KAAK;EACvD,IAAI,CAAC,IAAAwB,kBAAU,EAACI,cAAc,CAAC,EAAE;IAC/B,MAAMf,iBAAE,CAACI,SAAS,CAACW,cAAc,EAAED,kBAAkB,CAAC;EACxD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAME,cAAc,GAAG,MAAAA,CAAO;IAC5BC,SAAS;IACTC,OAAO;IACPC,UAAU;IACVC,QAAQ;IACRC;EACF,CAAC,KAAK;IACJ;AACJ;AACA;IACI;AACJ;AACA;AACA;AACA;AACA;AACA;IACI;AACJ;AACA;IACI,MAAMC,OAAO,GAAG,EAAE;IAElB,IAAIC,MAAM,GAAG,MAAMvB,iBAAE,CAACC,QAAQ,CAACoB,IAAI,EAAE,MAAM,CAAC;IAC5CE,MAAM,CAACC,OAAO,CACZJ,QAAQ;IACR;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,CAACK,WAAW,EAAEC,EAAE,EAAEC,MAAM,EAAEC,GAAG,EAAE;MAC7BC;IACF,CAAC,KAAK;MACJP,OAAO,CAACpB,IAAI,CAAC;QACXuB,WAAW;QACXE,MAAM;QACNE;MACF,CAAC,CAAC;MAEF,OAAOJ,WAAW;IACpB,CACF,CAAC;IAEDH,OAAO,CAACnB,IAAI,CAAC,CAAC;MACZ0B;IACF,CAAC,EAAE;MACDA,OAAO,EAAEC;IACX,CAAC,KAAK;MACJ,OAAOD,OAAO,GAAGC,QAAQ,GAAG,CAAC,CAAC,GAAID,OAAO,GAAGC,QAAQ,GAAG,CAAC,GAAG,CAAE;IAC/D,CAAC,CAAC;IAEF,IAAIC,eAAe,GAAG,KAAK;IAC3B,MAAMC,SAAS,GAAGV,OAAO,CAACW,SAAS,CAAC,CAAC;MACnCJ;IACF,CAAC,KAAK;MACJE,eAAe,KAAKZ,UAAU,GAAGX,kBAAkB,KAAKqB,OAAO,GAAG1C,QAAQ,KAAK0C,OAAO;MAEtF,OAAOV,UAAU,GAAGX,kBAAkB,GAAGqB,OAAO,GAAG1C,QAAQ,GAAG0C,OAAO;IACvE,CAAC,CAAC;IACF,IAAIK,IAAI,GAAGF,SAAS,KAAKG,SAAS,IAAIb,OAAO,CAACU,SAAS,CAAC;IACxD,IAAIE,IAAI,IAAIF,SAAS,KAAK,CAAC;IAEzB;IACAb,UAAU,EACV;MACAe,IAAI,CAACP,MAAM,GAAG,CAAC;IACjB;IAEA,IAAI,CAACO,IAAI,EAAE;MACTA,IAAI,GAAG,yBAA2BZ,OAAO,CAACc,GAAG,CAAC,CAAE;MAChDF,IAAI,CAACP,MAAM,IAAIO,IAAI,CAACT,WAAW,CAACY,MAAM;IACxC;IAEA,IAAIN,eAAe,EAAE;MACnBtC,OAAO,CAACa,GAAG,CAAC,mCAAmCW,SAAS,GAAG,CAAC;IAC9D,CAAC,MAAM;MACLM,MAAM,GAAGA,MAAM,CAACe,KAAK,CAAC,CAAC,EAAEJ,IAAI,CAACP,MAAM,CAAC,IAC1BO,IAAI,CAACP,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC,GACzBT,OAAO,IACNgB,IAAI,CAACP,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,GACzBJ,MAAM,CAACe,KAAK,CAACJ,IAAI,CAACP,MAAM,CAAC;MAEnC,MAAM3B,iBAAE,CAACI,SAAS,CAACiB,IAAI,EAAEE,MAAM,CAAC;IAClC;EACF,CAAC;;EAED;EACA;EACA;EACA;EACA;EACA;;EAEA,MAAMP,cAAc,CAAC;IACnBC,SAAS,EAAE,cAAc;IACzBC,OAAO,EAAE,UAAUV,kBAAkB,kBAAkBA,kBAAkB,OAAO;IAChFW,UAAU,EAAE,IAAI;IAChBC,QAAQ,EAAE,uDAAuD;IACjEC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,mBAAmB;IAC9BC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,UAAUpD,QAAQ,MAAMI,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG;IAC3F6B,QAAQ,EAAE,2CAA2C;IACrDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAML,cAAc,CAAC;IACnBC,SAAS,EAAE,aAAa;IACxBC,OAAO,EAAE,GAAG,GAAG,CAACqB,MAAM,CAAC,CAAC,CAAC,IAAIpD,QAAQ,MAAMqB,kBAAkB,GAAG;IAChEY,QAAQ,EAAE,sCAAsC;IAChDC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAAmB,OAAA,CAAAC,OAAA,GAAAC,IAAA,OAAAxE,uBAAA,CAAAR,OAAA,CAAa,0BAA0B,GAAC;EAExC,MAAA8E,OAAA,CAAAC,OAAA,GAAAC,IAAA,OAAAxE,uBAAA,CAAAR,OAAA,CAAa,mBAAmB,GAAC;;EAEjC;AACF;AACA;AACA;AACA;AACA;;EAEE;EACA2B,OAAO,CAACsD,KAAK,CAAC,IAAAF,iBAAO,EAAAG,SAAA,EAAsB,QAAQ,CAAC,CAAC;EACrD,MAAM,IAAAC,mBAAI,EAAC;EACT;EACA9B,cAAc,EACdF,YAAY,EACZH,QAAQ,CACT,CAAC;AACJ,CAAC,EAAE,CAAC","ignoreList":[]}

package/dist/generateRuleTypes.cjs

@@ -0,0 +1,24 @@
+"use strict";
+
+var _index = _interopRequireDefault(require("../index.cjs"));
+var _jsonSchemaToTypescript = require("json-schema-to-typescript");
+var _promises = require("node:fs/promises");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+let str = 'export interface Rules {\n';
+for (const [ruleName, rule] of Object.entries(/** @type {Record<string, import('@eslint/core').RuleDefinition<import('@eslint/core').RuleDefinitionTypeOptions>>} */
+_index.default.rules)) {
+  str += `  /** ${rule.meta?.docs?.description ?? ''} */\n`;
+  str += `  "jsdoc/${ruleName}": `;
+  const ts = await (0, _jsonSchemaToTypescript.compile)({
+    items: rule?.meta?.schema || [],
+    type: 'array'
+  }, 'Test', {
+    bannerComment: ''
+  });
+  str += ts.replace(/^export type Test = ?/v, '').replace(/^export interface Test /v, '').replaceAll('\n', '\n  ').trimEnd().replace(/;$/v, '') + ';\n\n';
+}
+str = str.replace(/\n$/v, '') + '}\n';
+await (0, _promises.writeFile)(__dirname + '/../rules.d.ts', str);
+
+// console.log('str', str);
+//# sourceMappingURL=generateRuleTypes.cjs.map

package/dist/generateRuleTypes.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateRuleTypes.cjs","names":["_index","_interopRequireDefault","require","_jsonSchemaToTypescript","_promises","e","__esModule","default","str","ruleName","rule","Object","entries","index","rules","meta","docs","description","ts","compile","items","schema","type","bannerComment","replace","replaceAll","trimEnd","writeFile","__dirname"],"sources":["../src/bin/generateRuleTypes.js"],"sourcesContent":["import index from '../index.js';\nimport {\n  compile,\n} from 'json-schema-to-typescript';\nimport {\n  writeFile,\n} from 'node:fs/promises';\n\nlet str = 'export interface Rules {\\n';\n\nfor (const [\n  ruleName,\n  rule,\n] of Object.entries(\n  /** @type {Record<string, import('@eslint/core').RuleDefinition<import('@eslint/core').RuleDefinitionTypeOptions>>} */ (\n      index.rules\n    ),\n  )\n) {\n  str += `  /** ${rule.meta?.docs?.description ?? ''} */\\n`;\n  str += `  \"jsdoc/${ruleName}\": `;\n  const ts = await compile({\n    items: rule?.meta?.schema || [],\n    type: 'array',\n  }, 'Test', {\n    bannerComment: '',\n  });\n\n  str += ts\n    .replace(/^export type Test = ?/v, '')\n    .replace(/^export interface Test /v, '')\n    .replaceAll('\\n', '\\n  ').trimEnd().replace(/;$/v, '') +\n      ';\\n\\n';\n}\n\nstr = str.replace(/\\n$/v, '') + '}\\n';\n\nawait writeFile(import.meta.dirname + '/../rules.d.ts', str);\n\n// console.log('str', str);\n"],"mappings":";;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,uBAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAF,OAAA;AAE0B,SAAAD,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE1B,IAAIG,GAAG,GAAG,4BAA4B;AAEtC,KAAK,MAAM,CACTC,QAAQ,EACRC,IAAI,CACL,IAAIC,MAAM,CAACC,OAAO,CACjB;AACIC,cAAK,CAACC,KAEV,CAAC,EACD;EACAN,GAAG,IAAI,SAASE,IAAI,CAACK,IAAI,EAAEC,IAAI,EAAEC,WAAW,IAAI,EAAE,OAAO;EACzDT,GAAG,IAAI,YAAYC,QAAQ,KAAK;EAChC,MAAMS,EAAE,GAAG,MAAM,IAAAC,+BAAO,EAAC;IACvBC,KAAK,EAAEV,IAAI,EAAEK,IAAI,EAAEM,MAAM,IAAI,EAAE;IAC/BC,IAAI,EAAE;EACR,CAAC,EAAE,MAAM,EAAE;IACTC,aAAa,EAAE;EACjB,CAAC,CAAC;EAEFf,GAAG,IAAIU,EAAE,CACNM,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,CACrCA,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CACvCC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAACC,OAAO,CAAC,CAAC,CAACF,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GACpD,OAAO;AACb;AAEAhB,GAAG,GAAGA,GAAG,CAACgB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,KAAK;AAErC,MAAM,IAAAG,mBAAS,EAACC,SAAA,GAAsB,gBAAgB,EAAEpB,GAAG,CAAC;;AAE5D","ignoreList":[]}

package/dist/getDefaultTagStructureForMode.cjs

@@ -0,0 +1,289 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
+ */
+/**
+ * @param {import('./jsdocUtils.js').ParserMode} mode
+ * @returns {TagStructure}
+ */
+const getDefaultTagStructureForMode = mode => {
+  const isJsdoc = mode === 'jsdoc';
+  const isClosure = mode === 'closure';
+  const isTypescript = mode === 'typescript';
+  const isPermissive = mode === 'permissive';
+  const isJsdocOrPermissive = isJsdoc || isPermissive;
+  const isJsdocOrTypescript = isJsdoc || isTypescript;
+  const isTypescriptOrClosure = isTypescript || isClosure;
+  const isClosureOrPermissive = isClosure || isPermissive;
+  const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;
+
+  // Properties:
+  // `namepathRole` - 'namepath-referencing'|'name-defining'|'namepath-defining'|'namepath-or-url-referencing'|'text'|false
+  // `typeAllowed` - boolean
+  // `nameRequired` - boolean
+  // `typeRequired` - boolean
+  // `typeOrNameRequired` - boolean
+
+  // All of `typeAllowed` have a signature with "type" except for
+  //  `augments`/`extends` ("namepath")
+  //  `param`/`arg`/`argument` (no signature)
+  //  `property`/`prop` (no signature)
+  //  `modifies` (undocumented)
+
+  // None of the `namepathRole: 'namepath-defining'` show as having curly
+  //  brackets for their name/namepath
+
+  // Among `namepath-defining` and `namepath-referencing`, these do not seem
+  //  to allow curly brackets in their doc signature or examples (`modifies`
+  //  references namepaths within its type brackets)
+
+  // Todo: Should support a `tutorialID` type (for `@tutorial` block and
+  //  inline)
+
+  /**
+   * @type {TagStructure}
+   */
+  return new Map([['alias', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples)
+  ['namepathRole', 'namepath-defining'],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['arg', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
+  // See `param`
+  ['nameRequired', true],
+  // Has no formal signature in the docs but shows curly brackets
+  //   in the examples
+  ['typeAllowed', true]])], ['argument', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
+  // See `param`
+  ['nameRequired', true],
+  // Has no formal signature in the docs but shows curly brackets
+  //   in the examples
+  ['typeAllowed', true]])], ['augments', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples)
+  ['namepathRole', 'namepath-referencing'],
+  // Does not show curly brackets in either the signature or examples
+  ['typeAllowed', true],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['borrows', new Map(/** @type {[string, string|boolean][]} */[
+  // `borrows` has a different format, however, so needs special parsing;
+  //   seems to require both, and as "namepath"'s
+  ['namepathRole', 'namepath-referencing'],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['callback', new Map(/** @type {[string, string|boolean][]} */[
+  // Seems to require a "namepath" in the signature (with no
+  //   counter-examples); TypeScript does not enforce but seems
+  //   problematic as not attached so presumably not useable without it
+  ['namepathRole', 'namepath-defining'],
+  // "namepath"
+  ['nameRequired', true]])], ['class', new Map(/** @type {[string, string|boolean][]} */[
+  // Not in use, but should be this value if using to power `empty-tags`
+  ['nameAllowed', true],
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['const', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constant', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constructor', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constructs', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['define', new Map(/** @type {[string, string|boolean][]} */[['typeRequired', isClosure]])], ['emits', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "name" (of an event) and no counter-examples
+  ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['enum', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'name-defining'],
+  // Has example showing curly brackets but not in doc signature
+  ['typeAllowed', true]])], ['event', new Map(/** @type {[string, string|boolean][]} */[
+  // 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 )
+  ['namepathRole', 'namepath-defining'],
+  // The doc signature of `event` seems to require a "name"
+  ['nameRequired', true]])], ['exception', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])],
+  // Closure
+  ['export', new Map(/** @type {[string, string|boolean][]} */[['typeAllowed', isClosureOrPermissive]])], ['exports', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'], ['nameRequired', isJsdoc], ['typeAllowed', isClosureOrPermissive]])], ['extends', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples)
+  ['namepathRole', 'namepath-referencing'], ['nameRequired', isJsdoc],
+  // Does not show curly brackets in either the signature or examples
+  ['typeAllowed', isTypescriptOrClosure || isPermissive],
+  // "namepath"
+  ['typeOrNameRequired', isTypescriptOrClosure || isPermissive]])], ['external', new Map(/** @type {[string, string|boolean][]} */[
+  // 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 )
+  ['namepathRole', 'namepath-defining'],
+  // "name" (and a special syntax for the `external` name)
+  ['nameRequired', true], ['typeAllowed', false]])], ['fires', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "name" (of an event) and no
+  //  counter-examples
+  ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['func', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining']])], ['function', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['host', new Map(/** @type {[string, string|boolean][]} */[
+  // 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 )
+  ['namepathRole', 'namepath-defining'],
+  // See `external`
+  ['nameRequired', true], ['typeAllowed', false]])], ['implements', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the doc signature and examples
+  // "typeExpression"
+  ['typeRequired', true]])], ['interface', new Map(/** @type {[string, string|boolean][]} */[
+  // Not in use, but should be this value if using to power `empty-tags`
+  ['nameAllowed', isClosure],
+  // Allows for "name" in signature, but indicates as optional
+  ['namepathRole', isJsdocTypescriptOrPermissive ? 'namepath-defining' : false], ['typeAllowed', false]])], ['internal', new Map(/** @type {[string, string|boolean][]} */[
+  // Not in use, but should be this value if using to power `empty-tags`
+  ['nameAllowed', false],
+  // https://www.typescriptlang.org/tsconfig/#stripInternal
+  ['namepathRole', false]])], ['lends', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples)
+  ['namepathRole', 'namepath-referencing'],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['link', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a namepath OR URL and might be checked as such.
+  ['namepathRole', 'namepath-or-url-referencing']])], ['linkcode', new Map(/** @type {[string, string|boolean][]} */[
+  // Synonym for "link"
+  // Signature seems to require a namepath OR URL and might be checked as such.
+  ['namepathRole', 'namepath-or-url-referencing']])], ['linkplain', new Map(/** @type {[string, string|boolean][]} */[
+  // Synonym for "link"
+  // Signature seems to require a namepath OR URL and might be checked as such.
+  ['namepathRole', 'namepath-or-url-referencing']])], ['listens', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "name" (of an event) and no
+  //  counter-examples
+  ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['member', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'],
+  // Has example showing curly brackets but not in doc signature
+  ['typeAllowed', true]])], ['memberof!', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples),
+  //  though it allows an incomplete namepath ending with connecting symbol
+  ['namepathRole', 'namepath-referencing'],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['memberof', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples),
+  //  though it allows an incomplete namepath ending with connecting symbol
+  ['namepathRole', 'namepath-referencing'],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['method', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining']])], ['mixes', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "OtherObjectPath" with no
+  //   counter-examples
+  ['namepathRole', 'namepath-referencing'],
+  // "OtherObjectPath"
+  ['typeOrNameRequired', true]])], ['mixin', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['modifies', new Map(/** @type {[string, string|boolean][]} */[
+  // 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(/** @type {[string, string|boolean][]} */[
+  // Optional "name" and no curly brackets
+  //  this block impacts `no-undefined-types` and `valid-types` (search for
+  //  "isNameOrNamepathDefiningTag|tagMightHaveNameOrNamepath|tagMightHaveEitherTypeOrNamePosition")
+  ['namepathRole', isJsdoc ? 'namepath-defining' : 'text'],
+  // Shows the signature with curly brackets but not in the example
+  ['typeAllowed', true]])], ['name', new Map(/** @type {[string, string|boolean][]} */[
+  // Seems to require a "namepath" in the signature (with no
+  //   counter-examples)
+  ['namepathRole', 'namepath-defining'],
+  // "namepath"
+  ['nameRequired', true],
+  // "namepath"
+  ['typeOrNameRequired', true]])], ['namespace', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'],
+  // Shows the signature with curly brackets but not in the example
+  ['typeAllowed', true]])], ['package', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows the signature with curly brackets but not in the example
+  // "typeExpression"
+  ['typeAllowed', isClosureOrPermissive]])], ['param', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
+  // Though no signature provided requiring, per
+  //  https://jsdoc.app/tags-param.html:
+  // "The @param tag requires you to specify the name of the parameter you
+  //  are documenting."
+  ['nameRequired', true],
+  // Has no formal signature in the docs but shows curly brackets
+  //   in the examples
+  ['typeAllowed', true]])], ['private', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows the signature with curly brackets but not in the example
+  // "typeExpression"
+  ['typeAllowed', isClosureOrPermissive]])], ['prop', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
+  // See `property`
+  ['nameRequired', true],
+  // Has no formal signature in the docs but shows curly brackets
+  //   in the examples
+  ['typeAllowed', true]])], ['property', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
+  // No docs indicate required, but since parallel to `param`, we treat as
+  //   such:
+  ['nameRequired', true],
+  // Has no formal signature in the docs but shows curly brackets
+  //   in the examples
+  ['typeAllowed', true]])], ['protected', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows the signature with curly brackets but not in the example
+  // "typeExpression"
+  ['typeAllowed', isClosureOrPermissive]])], ['public', new Map(/** @type {[string, string|boolean][]} */[
+  // Does not show a signature nor show curly brackets in the example
+  ['typeAllowed', isClosureOrPermissive]])], ['requires', new Map(/** @type {[string, string|boolean][]} */[
+  // <someModuleName>
+  ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['return', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])], ['returns', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])], ['satisfies', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the doc signature and examples
+  ['typeRequired', true]])], ['see', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature allows for "namepath" or text, so user must configure to
+  //  'namepath-referencing' to enforce checks
+  ['namepathRole', 'text']])], ['static', new Map(/** @type {[string, string|boolean][]} */[
+  // Does not show a signature nor show curly brackets in the example
+  ['typeAllowed', isClosureOrPermissive]])], ['suppress', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', !isClosure], ['typeRequired', isClosure]])], ['template', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', isJsdoc ? 'text' : 'namepath-referencing'], ['nameRequired', !isJsdoc],
+  // Though defines `namepathRole: 'namepath-defining'` in a sense, it is
+  //   not parseable in the same way for template (e.g., allowing commas),
+  //   so not adding
+  ['typeAllowed', isTypescriptOrClosure || isPermissive]])], ['this', new Map(/** @type {[string, string|boolean][]} */[
+  // Signature seems to require a "namepath" (and no counter-examples)
+  // Not used with namepath in Closure/TypeScript, however
+  ['namepathRole', isJsdoc ? 'namepath-referencing' : false],
+  // namepath
+  ['typeOrNameRequired', isJsdoc], ['typeRequired', isTypescriptOrClosure]])], ['throws', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])], ['tutorial', new Map(/** @type {[string, string|boolean][]} */[
+  // (a tutorial ID)
+  ['nameRequired', true], ['typeAllowed', false]])], ['type', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the doc signature and examples
+  // "typeName"
+  ['typeRequired', true]])], ['typedef', new Map(/** @type {[string, string|boolean][]} */[
+  // Seems to require a "namepath" in the signature (with no
+  //  counter-examples)
+  ['namepathRole', 'name-defining'],
+  // TypeScript may allow it to be dropped if followed by @property or @member;
+  //   also shown as missing in Closure
+  // "namepath"
+  ['nameRequired', isJsdocOrPermissive],
+  // Is not `typeRequired` for TypeScript because it gives an error:
+  // JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.
+
+  // Has example showing curly brackets but not in doc signature
+  ['typeAllowed', true],
+  // TypeScript may allow it to be dropped if followed by @property or @member
+  // "namepath"
+  ['typeOrNameRequired', !isTypescript]])], ['var', new Map(/** @type {[string, string|boolean][]} */[
+  // Allows for "name"'s in signature, but indicated as optional
+  ['namepathRole', 'namepath-defining'],
+  // Has example showing curly brackets but not in doc signature
+  ['typeAllowed', true]])], ['yield', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])], ['yields', new Map(/** @type {[string, string|boolean][]} */[
+  // Shows curly brackets in the signature and in the examples
+  ['typeAllowed', true]])]]);
+};
+var _default = exports.default = getDefaultTagStructureForMode;
+module.exports = exports.default;
+//# sourceMappingURL=getDefaultTagStructureForMode.cjs.map