fix(typescript): attempt to fix types export (#1483)

Author: brettz9

package.json

@@ -19,6 +19,7 @@
   },
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@babel/cli": "^7.28.3",
     "@babel/core": "^7.28.4",
     "@babel/eslint-parser": "^7.28.4",
@@ -83,19 +84,24 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./src/index.js",
-      "require": "./dist/index-cjs.cjs"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./src/index.js"
+      },
+      "require": {
+        "types": "./dist/index-cjs.d.ts",
+        "default": "./dist/index-cjs.cjs"
+      }
     },
     "./getJsdocProcessorPlugin.js": {
       "types": "./dist/getJsdocProcessorPlugin.d.ts",
-      "import": "./dist/getJsdocProcessorPlugin.cjs",
-      "require": "./src/getJsdocProcessorPlugin.js"
+      "import": "./src/getJsdocProcessorPlugin.js",
+      "require": "./dist/getJsdocProcessorPlugin.cjs"
     },
     "./iterateJsdoc.js": {
       "types": "./dist/iterateJsdoc.d.ts",
-      "import": "./dist/iterateJsdoc.cjs",
-      "require": "./src/iterateJsdoc.js"
+      "import": "./src/iterateJsdoc.js",
+      "require": "./dist/iterateJsdoc.cjs"
     }
   },
   "name": "eslint-plugin-jsdoc",
@@ -137,7 +143,8 @@
   "scripts": {
     "tsc": "tsc",
     "tsc-build": "tsc -p tsconfig-prod.json",
-    "build": "rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
+    "build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
+    "attw": "attw --pack .",
     "check-docs": "node ./src/bin/generateDocs.js --check",
     "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js",
     "create-rule": "node ./src/bin/generateRule.js",

pnpm-lock.yaml

@@ -0,0 +1,16 @@
+import {
+  readFile,
+  writeFile,
+} from 'node:fs/promises';
+
+const {
+  dirname,
+} = import.meta;
+const dataToEmbed = await readFile(dirname + '/../index-cjs.js', 'utf8');
+const templateContent = await readFile(dirname + '/../index-esm.js', 'utf8');
+
+const finalContent = '/* AUTO-GENERATED BY build SCRIPT */\n' + templateContent.replace(
+  /\/\/ BEGIN REPLACE[\s\S]*\/\/ END REPLACE\n/v,
+  `${dataToEmbed}`,
+);
+await writeFile(dirname + '/../index.js', finalContent);

src/bin/buildEntryFileForTS.js

@@ -0,0 +1,75 @@
+/* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
+import {
+  merge,
+} from 'object-deep-merge';
+
+// BEGIN REPLACE
+import index from './index-cjs.js';
+
+// eslint-disable-next-line unicorn/prefer-export-from --- Reusing `index`
+export default index;
+// END REPLACE
+
+/* eslint-disable jsdoc/valid-types -- Bug */
+/**
+ * @type {((
+ *   cfg?: {
+ *     mergeSettings?: boolean,
+ *     config?: `flat/${import('./index-cjs.js').ConfigGroups}${import('./index-cjs.js').ConfigVariants}${import('./index-cjs.js').ErrorLevelVariants}`,
+ *     settings?: Partial<import('./iterateJsdoc.js').Settings>
+ *   }
+ * ) => import('eslint').Linter.Config)}
+ */
+/* eslint-enable jsdoc/valid-types -- Bug */
+export const jsdoc = function (cfg) {
+  /** @type {import('eslint').Linter.Config} */
+  let outputConfig = {
+    plugins: {
+      jsdoc: index,
+    },
+  };
+  if (
+    cfg?.config
+  ) {
+    // @ts-expect-error Security check
+    if (cfg.config === '__proto__') {
+      throw new TypeError('Disallowed config value');
+    }
+
+    outputConfig = index.configs[cfg.config];
+  }
+
+  outputConfig.settings = {
+    jsdoc: cfg?.mergeSettings === false ?
+      cfg.settings :
+      merge(
+        {},
+        cfg?.settings ?? {},
+        cfg?.config?.includes('recommended') ?
+          {
+            // We may need to drop these for "typescript" (non-"flavor") configs,
+            //   if support is later added: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
+            structuredTags: {
+              next: {
+                required: [
+                  'type',
+                ],
+              },
+              throws: {
+                required: [
+                  'type',
+                ],
+              },
+              yields: {
+                required: [
+                  'type',
+                ],
+              },
+            },
+          } :
+          {},
+      ),
+  };
+
+  return outputConfig;
+};