eslint-plugin-jsdoc 52.0.2 → 52.0.3

package/dist/generateRule.cjs

@@ -1,242 +0,0 @@
-"use strict";
-
-var _camelcase = _interopRequireDefault(require("camelcase"));
-var _fs = require("fs");
-var _promises = _interopRequireDefault(require("fs/promises"));
-var _openEditor = _interopRequireDefault(require("open-editor"));
-var _path = require("path");
-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';
-  // @ts-expect-error Older types?
-  const ruleNames = JSON.parse(await _promises.default.readFile(ruleNamesPath));
-  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, _fs.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, _fs.existsSync)(ruleTestPath)) {
-    await _promises.default.writeFile(ruleTestPath, ruleTestTemplate);
-  }
-  const ruleReadmeTemplate = `# \`${ruleName}\`
-
-|||
-|---|---|
-|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, _fs.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.js'
-  });
-  await replaceInOrder({
-    checkName: 'index recommended',
-    newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\'off\''},`,
-    oldRegex: /\n\s{6}'jsdoc\/(?<oldRule>[^']*)': .*?,/gv,
-    path: './src/index.js'
-  });
-  await replaceInOrder({
-    checkName: 'index rules',
-    newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,
-    oldRegex: /\n\s{4}'(?<oldRule>[^']*)': [^,]*,/gv,
-    path: './src/index.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, _path.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

@@ -1 +0,0 @@
-{"version":3,"file":"generateRule.cjs","names":["_camelcase","_interopRequireDefault","require","_fs","_promises","_openEditor","_path","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\nimport camelCase from 'camelcase';\nimport {\n  existsSync,\n} from 'fs';\nimport fs from 'fs/promises';\n/**\n * @example\n * ```shell\n * pnpm run create-rule my-new-rule -- --recommended\n * ```\n */\nimport open from 'open-editor';\nimport {\n  resolve,\n} from 'path';\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  // @ts-expect-error Older types?\n  const ruleNames = JSON.parse(await fs.readFile(\n    ruleNamesPath,\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|||\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.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.js',\n  });\n\n  await replaceInOrder({\n    checkName: 'index rules',\n    newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,\n    oldRegex: /\\n\\s{4}'(?<oldRule>[^']*)': [^,]*,/gv,\n    path: './src/index.js',\n  });\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":";;AAEA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,GAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAH,sBAAA,CAAAC,OAAA;AAOA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,KAAA,GAAAJ,OAAA;AAEc,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,KAhBd,uCAOA;AACA;AACA;AACA;AACA;AACA;AAMA;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;EACA,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAC,MAAMC,iBAAE,CAACC,QAAQ,CAC5CL,aACF,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,cAAU,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,cAAU,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,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,cAAU,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,mBAAmB,GAAC;;EAEjC;AACF;AACA;AACA;AACA;AACA;;EAEE;EACA2B,OAAO,CAACsD,KAAK,CAAC,IAAAF,aAAO,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/src/WarnSettings.js

@@ -1,34 +0,0 @@
-const WarnSettings = function () {
-  /** @type {WeakMap<object, Set<string>>} */
-  const warnedSettings = new WeakMap();
-
-  return {
-    /**
-     * Warn only once for each context and setting
-     * @param {{}} context
-     * @param {string} setting
-     * @returns {boolean}
-     */
-    hasBeenWarned (context, setting) {
-      return warnedSettings.has(context) && /** @type {Set<string>} */ (
-        warnedSettings.get(context)
-      ).has(setting);
-    },
-
-    /**
-     * @param {{}} context
-     * @param {string} setting
-     * @returns {void}
-     */
-    markSettingAsWarned (context, setting) {
-      // c8 ignore else
-      if (!warnedSettings.has(context)) {
-        warnedSettings.set(context, new Set());
-      }
-
-      /** @type {Set<string>} */ (warnedSettings.get(context)).add(setting);
-    },
-  };
-};
-
-export default WarnSettings;

package/src/alignTransform.js

@@ -1,358 +0,0 @@
-/**
- * Transform based on https://github.com/syavorsky/comment-parser/blob/master/src/transforms/align.ts
- *
- * It contains some customizations to align based on the tags, and some custom options.
- */
-
-import {
-  // `comment-parser/primitives` export
-  util,
-} from 'comment-parser';
-
-/**
- * @typedef {{
- *   hasNoTypes: boolean,
- *   maxNamedTagLength: import('./iterateJsdoc.js').Integer,
- *   maxUnnamedTagLength: import('./iterateJsdoc.js').Integer
- * }} TypelessInfo
- */
-
-const {
-  rewireSource,
-} = util;
-
-/**
- * @typedef {{
- *   name: import('./iterateJsdoc.js').Integer,
- *   start: import('./iterateJsdoc.js').Integer,
- *   tag: import('./iterateJsdoc.js').Integer,
- *   type: import('./iterateJsdoc.js').Integer
- * }} Width
- */
-
-/** @type {Width} */
-const zeroWidth = {
-  name: 0,
-  start: 0,
-  tag: 0,
-  type: 0,
-};
-
-/**
- * @param {string[]} tags
- * @param {import('./iterateJsdoc.js').Integer} index
- * @param {import('comment-parser').Line[]} source
- * @returns {boolean}
- */
-const shouldAlign = (tags, index, source) => {
-  const tag = source[index].tokens.tag.replace('@', '');
-  const includesTag = tags.includes(tag);
-
-  if (includesTag) {
-    return true;
-  }
-
-  if (tag !== '') {
-    return false;
-  }
-
-  for (let iterator = index; iterator >= 0; iterator--) {
-    const previousTag = source[iterator].tokens.tag.replace('@', '');
-
-    if (previousTag !== '') {
-      if (tags.includes(previousTag)) {
-        return true;
-      }
-
-      return false;
-    }
-  }
-
-  return true;
-};
-
-/**
- * @param {string[]} tags
- * @returns {(
- *   width: Width,
- *   line: {
- *     tokens: import('comment-parser').Tokens
- *   },
- *   index: import('./iterateJsdoc.js').Integer,
- *   source: import('comment-parser').Line[]
- * ) => Width}
- */
-const getWidth = (tags) => {
-  return (width, {
-    tokens,
-  }, index, source) => {
-    if (!shouldAlign(tags, index, source)) {
-      return width;
-    }
-
-    return {
-      name: Math.max(width.name, tokens.name.length),
-      start: tokens.delimiter === '/**' ? tokens.start.length : width.start,
-      tag: Math.max(width.tag, tokens.tag.length),
-      type: Math.max(width.type, tokens.type.length),
-    };
-  };
-};
-
-/**
- * @param {{
- *   description: string;
- *   tags: import('comment-parser').Spec[];
- *   problems: import('comment-parser').Problem[];
- * }} fields
- * @returns {TypelessInfo}
- */
-const getTypelessInfo = (fields) => {
-  const hasNoTypes = fields.tags.every(({
-    type,
-  }) => {
-    return !type;
-  });
-  const maxNamedTagLength = Math.max(...fields.tags.map(({
-    name,
-    tag,
-  }) => {
-    return name.length === 0 ? -1 : tag.length;
-  }).filter((length) => {
-    return length !== -1;
-  })) + 1;
-  const maxUnnamedTagLength = Math.max(...fields.tags.map(({
-    name,
-    tag,
-  }) => {
-    return name.length === 0 ? tag.length : -1;
-  }).filter((length) => {
-    return length !== -1;
-  })) + 1;
-  return {
-    hasNoTypes,
-    maxNamedTagLength,
-    maxUnnamedTagLength,
-  };
-};
-
-/**
- * @param {import('./iterateJsdoc.js').Integer} len
- * @returns {string}
- */
-const space = (len) => {
-  return ''.padStart(len, ' ');
-};
-
-/**
- * @param {{
- *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,
- *   tags: string[],
- *   indent: string,
- *   preserveMainDescriptionPostDelimiter: boolean,
- *   wrapIndent: string,
- *   disableWrapIndent: boolean,
- * }} cfg
- * @returns {(
- *   block: import('comment-parser').Block
- * ) => import('comment-parser').Block}
- */
-const alignTransform = ({
-  customSpacings,
-  disableWrapIndent,
-  indent,
-  preserveMainDescriptionPostDelimiter,
-  tags,
-  wrapIndent,
-}) => {
-  let intoTags = false;
-  /** @type {Width} */
-  let width;
-
-  /**
-   * @param {import('comment-parser').Tokens} tokens
-   * @param {TypelessInfo} typelessInfo
-   * @returns {import('comment-parser').Tokens}
-   */
-  const alignTokens = (tokens, typelessInfo) => {
-    const nothingAfter = {
-      delim: false,
-      name: false,
-      tag: false,
-      type: false,
-    };
-
-    if (tokens.description === '') {
-      nothingAfter.name = true;
-      tokens.postName = '';
-
-      if (tokens.name === '') {
-        nothingAfter.type = true;
-        tokens.postType = '';
-
-        if (tokens.type === '') {
-          nothingAfter.tag = true;
-          tokens.postTag = '';
-
-          /* c8 ignore next: Never happens because the !intoTags return. But it's here for consistency with the original align transform */
-          if (tokens.tag === '') {
-            nothingAfter.delim = true;
-          }
-        }
-      }
-    }
-
-    let untypedNameAdjustment = 0;
-    let untypedTypeAdjustment = 0;
-    if (typelessInfo.hasNoTypes) {
-      nothingAfter.tag = true;
-      tokens.postTag = '';
-      if (tokens.name === '') {
-        untypedNameAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;
-      } else {
-        untypedNameAdjustment = typelessInfo.maxNamedTagLength > typelessInfo.maxUnnamedTagLength ? 0 :
-          Math.max(0, typelessInfo.maxUnnamedTagLength - (tokens.tag.length + tokens.name.length + 1));
-        untypedTypeAdjustment = typelessInfo.maxNamedTagLength - tokens.tag.length;
-      }
-    }
-
-    // Todo: Avoid fixing alignment of blocks with multiline wrapping of type
-    if (tokens.tag === '' && tokens.type) {
-      return tokens;
-    }
-
-    const spacings = {
-      postDelimiter: customSpacings?.postDelimiter || 1,
-      postName: customSpacings?.postName || 1,
-      postTag: customSpacings?.postTag || 1,
-      postType: customSpacings?.postType || 1,
-    };
-
-    tokens.postDelimiter = nothingAfter.delim ? '' : space(spacings.postDelimiter);
-
-    if (!nothingAfter.tag) {
-      tokens.postTag = space(width.tag - tokens.tag.length + spacings.postTag);
-    }
-
-    if (!nothingAfter.type) {
-      tokens.postType = space(width.type - tokens.type.length + spacings.postType + untypedTypeAdjustment);
-    }
-
-    if (!nothingAfter.name) {
-      // If post name is empty for all lines (name width 0), don't add post name spacing.
-      tokens.postName = width.name === 0 ? '' : space(width.name - tokens.name.length + spacings.postName + untypedNameAdjustment);
-    }
-
-    return tokens;
-  };
-
-  /**
-   * @param {import('comment-parser').Line} line
-   * @param {import('./iterateJsdoc.js').Integer} index
-   * @param {import('comment-parser').Line[]} source
-   * @param {TypelessInfo} typelessInfo
-   * @param {string|false} indentTag
-   * @returns {import('comment-parser').Line}
-   */
-  const update = (line, index, source, typelessInfo, indentTag) => {
-    /** @type {import('comment-parser').Tokens} */
-    const tokens = {
-      ...line.tokens,
-    };
-
-    if (tokens.tag !== '') {
-      intoTags = true;
-    }
-
-    const isEmpty =
-      tokens.tag === '' &&
-      tokens.name === '' &&
-      tokens.type === '' &&
-      tokens.description === '';
-
-    // dangling '*/'
-    if (tokens.end === '*/' && isEmpty) {
-      tokens.start = indent + ' ';
-
-      return {
-        ...line,
-        tokens,
-      };
-    }
-
-    switch (tokens.delimiter) {
-      case '*':
-        tokens.start = indent + ' ';
-        break;
-      case '/**':
-        tokens.start = indent;
-        break;
-      default:
-        tokens.delimiter = '';
-
-        // compensate delimiter
-        tokens.start = indent + '  ';
-    }
-
-    if (!intoTags) {
-      if (tokens.description === '') {
-        tokens.postDelimiter = '';
-      } else if (!preserveMainDescriptionPostDelimiter) {
-        tokens.postDelimiter = ' ';
-      }
-
-      return {
-        ...line,
-        tokens,
-      };
-    }
-
-    const postHyphenSpacing = customSpacings?.postHyphen ?? 1;
-    const hyphenSpacing = /^\s*-\s+/v;
-    tokens.description = tokens.description.replace(
-      hyphenSpacing, '-' + ''.padStart(postHyphenSpacing, ' '),
-    );
-
-    // Not align.
-    if (shouldAlign(tags, index, source)) {
-      alignTokens(tokens, typelessInfo);
-      if (!disableWrapIndent && indentTag) {
-        tokens.postDelimiter += wrapIndent;
-      }
-    }
-
-    return {
-      ...line,
-      tokens,
-    };
-  };
-
-  return ({
-    source,
-    ...fields
-  }) => {
-    width = source.reduce(getWidth(tags), {
-      ...zeroWidth,
-    });
-
-    const typelessInfo = getTypelessInfo(fields);
-
-    let tagIndentMode = false;
-
-    return rewireSource({
-      ...fields,
-      source: source.map((line, index) => {
-        const indentTag = !disableWrapIndent && tagIndentMode && !line.tokens.tag && line.tokens.description;
-        const ret = update(line, index, source, typelessInfo, indentTag);
-
-        if (!disableWrapIndent && line.tokens.tag) {
-          tagIndentMode = true;
-        }
-
-        return ret;
-      }),
-    });
-  };
-};
-
-export default alignTransform;