eslint-plugin-jsdoc 57.1.1 → 57.2.1

package/dist/cjs/iterateJsdoc.d.ts

@@ -249,6 +249,7 @@ export type PreferredTypes = {
         message: string;
         replacement?: false | string;
         skipRootChecking?: boolean;
+        unifyParentAndChildTypeChecks?: boolean;
     };
 };
 export type StructuredTags = {
@@ -417,6 +418,7 @@ export type RuleConfig = {
  *     message: string,
  *     replacement?: false|string
  *     skipRootChecking?: boolean
+ *     unifyParentAndChildTypeChecks?: boolean
  *   }
  * }} PreferredTypes
  */

package/dist/generateRuleTypes.cjs

@@ -6,17 +6,15 @@ 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(_index.default.rules)) {
-  if (rule.meta?.schema?.[0]) {
-    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 += `  /** ${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);

package/dist/generateRuleTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"generateRuleTypes.cjs","names":["_index","_interopRequireDefault","require","_jsonSchemaToTypescript","_promises","e","__esModule","default","str","ruleName","rule","Object","entries","index","rules","meta","schema","docs","description","ts","compile","items","type","bannerComment","replace","replaceAll","trimEnd","writeFile","__dirname","console","log"],"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(index.rules)) {\n  if (rule.meta?.schema?.[0]) {\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}\n\nstr = str.replace(/\\n$/v, '') + '}\\n';\n\nawait writeFile(import.meta.dirname + '/../rules.d.ts', str);\n\n// eslint-disable-next-line no-console -- Todo\nconsole.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,CAACC,cAAK,CAACC,KAAK,CAAC,EAAE;EAChC,IAAIJ,IAAI,CAACK,IAAI,EAAEC,MAAM,GAAG,CAAC,CAAC,EAAE;IAC1BR,GAAG,IAAI,SAASE,IAAI,CAACK,IAAI,CAACE,IAAI,CAACC,WAAW,OAAO;IACjDV,GAAG,IAAI,YAAYC,QAAQ,KAAK;IAChC,MAAMU,EAAE,GAAG,MAAM,IAAAC,+BAAO,EAAC;MACvBC,KAAK,EAAEX,IAAI,CAACK,IAAI,CAACC,MAAM;MACvBM,IAAI,EAAE;IACR,CAAC,EAAE,MAAM,EAAE;MACTC,aAAa,EAAE;IACjB,CAAC,CAAC;IAEFf,GAAG,IAAIW,EAAE,CACNK,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;EACb;AACF;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;AACAqB,OAAO,CAACC,GAAG,CAAC,KAAK,EAAEtB,GAAG,CAAC","ignoreList":[]}
+{"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","console","log"],"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(index.rules)) {\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// eslint-disable-next-line no-console -- Todo\nconsole.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,CAACC,cAAK,CAACC,KAAK,CAAC,EAAE;EAChCN,GAAG,IAAI,SAASE,IAAI,CAACK,IAAI,CAACC,IAAI,CAACC,WAAW,OAAO;EACjDT,GAAG,IAAI,YAAYC,QAAQ,KAAK;EAChC,MAAMS,EAAE,GAAG,MAAM,IAAAC,+BAAO,EAAC;IACvBC,KAAK,EAAEV,IAAI,CAACK,IAAI,CAACM,MAAM,IAAI,EAAE;IAC7BC,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;AACAqB,OAAO,CAACC,GAAG,CAAC,KAAK,EAAEtB,GAAG,CAAC","ignoreList":[]}

package/dist/iterateJsdoc.cjs

@@ -1483,6 +1483,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
  *     message: string,
  *     replacement?: false|string
  *     skipRootChecking?: boolean
+ *     unifyParentAndChildTypeChecks?: boolean
  *   }
  * }} PreferredTypes
  */