Add multi-module build configs (for new packages) (#1197)

.eslintignore

@@ -5,3 +5,4 @@ dist
 .nyc_output
 packages/*/node_modules
 packages/*/__snapshots__
+jest

.eslintrc.json

@@ -28,16 +28,17 @@
   },
   "overrides": [
     {
-      "files": ["*.ts"],
+      "files": ["*.ts", "*.mts"],
       "rules": {
         // Disabled per typescript-eslint recommendation: https://github.com/typescript-eslint/typescript-eslint/blob/e26e43ffba96f6d46198b22f1c8dd5c814db2652/docs/getting-started/linting/FAQ.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
         "no-undef": "off",
         "no-unused-vars": "off",
+        "n/no-missing-import": "off",
         "@typescript-eslint/no-unused-vars": "error"
       }
     },
     {
-      "files": ["test.js", "*.test.js", "**/test/**"],
+      "files": ["test.m?[tj]s", "*.test.m?[tj]s", "**/test/**"],
       "env": {
         "mocha": true,
         "jest": true

jest.config.ts

@@ -0,0 +1,25 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: 'ts-jest/presets/default-esm',
+  coverageDirectory: './coverage/',
+  collectCoverage: true,
+  resolver: '<rootDir>/jest/mjs-resolver.ts',
+  transform: {
+    '^.+\\.m?tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx|js|tsx|ts|mts)$',
+  moduleNameMapper: {
+    '#ansi-styles': 'ansi-styles',
+    '#supports-color': 'supports-color',
+  },
+  extensionsToTreatAsEsm: ['.ts', '.mts'],
+  moduleFileExtensions: ['js', 'jsx', 'mjs', 'mts'],
+};
+
+export default config;

jest/mjs-resolver.ts

@@ -0,0 +1,15 @@
+const mjsResolver = (path, options) => {
+  const mjsExtRegex = /\.mjs$/i;
+  const resolver = options.defaultResolver;
+  if (mjsExtRegex.test(path)) {
+    try {
+      return resolver(path.replace(mjsExtRegex, '.mts'), options);
+    } catch {
+      // Use default resolver
+    }
+  }
+
+  return resolver(path, options);
+};
+
+module.exports = mjsResolver;

package.json

@@ -76,10 +76,9 @@
   "scripts": {
     "bootstrap": "lerna bootstrap --no-ci",
     "publish": "lerna run tsc && lerna publish",
-    "pretest": "lerna run tsc && eslint . --ext .js --ext .ts",
+    "pretest": "lerna run tsc && eslint . --ext .js --ext .ts --ext .mts",
     "jest": "NODE_OPTIONS=--experimental-vm-modules jest",
-    "test": "yarn jest && lerna exec npm test --scope inquirer",
-    "ts-node": "lerna run tsc && ts-node"
+    "test": "yarn jest && lerna exec npm test --scope inquirer"
   },
   "repository": {
     "type": "git",
@@ -95,29 +94,9 @@
       "prettier --write",
       "git add"
     ],
-    "*.[jt]sx?": [
+    "*.m?[jt]sx?": [
       "eslint --fix",
       "git add"
     ]
-  },
-  "jest": {
-    "coverageDirectory": "./coverage/",
-    "collectCoverage": true,
-    "transform": {
-      "\\.[jt]sx?$": [
-        "ts-jest",
-        {
-          "useESM": true
-        }
-      ]
-    },
-    "moduleNameMapper": {
-      "(.+)\\.js": "$1",
-      "#ansi-styles": "ansi-styles",
-      "#supports-color": "supports-color"
-    },
-    "extensionsToTreatAsEsm": [
-      ".ts"
-    ]
   }
 }

packages/checkbox/demo.ts → packages/checkbox/demo.mts

@@ -1,4 +1,4 @@
-import checkbox from './src/index.js';
+import checkbox from './src/index.mjs';
 
 (async () => {
   let answer;

packages/checkbox/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@inquirer/checkbox",
   "version": "0.0.30-alpha.0",
-  "type": "module",
   "engines": {
     "node": ">=14.18.0"
   },
   "description": "Inquirer checkbox prompt",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "typings": "./dist/cjs/types/index.d.mts",
   "files": [
-    "dist/"
+    "dist/**/*"
   ],
   "repository": {
     "type": "git",
@@ -65,9 +64,25 @@
     "figures": "^5.0.0"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "yarn run clean && yarn run tsc:esm && yarn run tsc:cjs",
+    "clean": "rm -rf dist",
+    "tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "tsc:cjs": "tsc -p ./tsconfig.cjs.json && yarn run fix-ext",
+    "fix-ext": "ts-node ../../tools/rename-ext.ts"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/index.d.mts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
   }
 }

packages/checkbox/src/index.ts → packages/checkbox/src/index.mts

@@ -31,7 +31,10 @@ type Config<Value> = {
 };
 
 export default createPrompt(
-  <Value>(config: Config<Value>, done: (value: Array<Value>) => void): string => {
+  <Value extends unknown>(
+    config: Config<Value>,
+    done: (value: Array<Value>) => void
+  ): string => {
     const { prefix = usePrefix(), instructions } = config;
     const paginator = useRef(new Paginator()).current;
 

packages/checkbox/tsconfig.cjs.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./src"
+  ],
+  "compilerOptions": {
+    "lib": [
+      "ES6"
+    ],
+    "target": "es6",
+    "moduleResolution": "node",
+    "outDir": "dist/cjs",
+    "declarationDir": "dist/cjs/types"
+  }
+}

packages/checkbox/tsconfig.esm.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./src"
+  ],
+  "compilerOptions": {
+    "lib": [
+      "ESNext"
+    ],
+    "target": "es2022",
+    "moduleResolution": "nodenext",
+    "outDir": "dist/esm",
+    "declarationDir": "dist/esm/types"
+  }
+}

packages/confirm/demo.ts → packages/confirm/demo.mts

@@ -1,4 +1,4 @@
-import confirm from './src/index.js';
+import confirm from './src/index.mjs';
 
 (async () => {
   console.log(

packages/confirm/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@inquirer/confirm",
-  "type": "module",
   "version": "0.0.28-alpha.0",
   "description": "Inquirer confirm prompt",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "typings": "./dist/cjs/types/index.d.mts",
   "files": [
-    "dist/"
+    "dist/**/*"
   ],
   "repository": {
     "type": "git",
@@ -61,12 +60,28 @@
     "chalk": "^5.2.0"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "yarn run clean && yarn run tsc:esm && yarn run tsc:cjs",
+    "clean": "rm -rf dist",
+    "tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "tsc:cjs": "tsc -p ./tsconfig.cjs.json && yarn run fix-ext",
+    "fix-ext": "ts-node ../../tools/rename-ext.ts"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
     "node": ">=14.18.0"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/index.d.mts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
   }
 }

packages/confirm/tsconfig.cjs.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./src"
+  ],
+  "compilerOptions": {
+    "lib": [
+      "ES6"
+    ],
+    "target": "es6",
+    "moduleResolution": "node",
+    "outDir": "dist/cjs",
+    "declarationDir": "dist/cjs/types"
+  }
+}

packages/confirm/tsconfig.esm.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "./src"
+  ],
+  "compilerOptions": {
+    "lib": [
+      "ESNext"
+    ],
+    "target": "es2022",
+    "moduleResolution": "nodenext",
+    "outDir": "dist/esm",
+    "declarationDir": "dist/esm/types"
+  }
+}

packages/core/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@inquirer/core",
-  "type": "module",
   "version": "0.0.30-alpha.0",
   "engines": {
     "node": ">=14.18.0"
   },
   "description": "Core Inquirer prompt API",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "typings": "./dist/cjs/types/index.d.mts",
   "files": [
-    "dist/"
+    "dist/**/*"
   ],
   "repository": {
     "type": "git",
@@ -75,9 +74,25 @@
     "@jest/globals": "^29.5.0"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "yarn run clean && yarn run tsc:esm && yarn run tsc:cjs",
+    "clean": "rm -rf dist",
+    "tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "tsc:cjs": "tsc -p ./tsconfig.cjs.json && yarn run fix-ext",
+    "fix-ext": "ts-node ../../tools/rename-ext.ts"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/index.d.mts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
   }
-}
+}

packages/core/src/index.ts → packages/core/src/index.mts

@@ -1,12 +1,12 @@
 import readline from 'node:readline';
 import type { Prompt } from '@inquirer/type';
 import MuteStream from 'mute-stream';
-import ScreenManager from './lib/screen-manager.js';
-import { getPromptConfig } from './lib/options.js';
+import ScreenManager from './lib/screen-manager.mjs';
+import { getPromptConfig } from './lib/options.mjs';
 
-export { usePrefix } from './lib/prefix.js';
-export * from './lib/key.js';
-export * from './lib/Paginator.js';
+export { usePrefix } from './lib/prefix.mjs';
+export * from './lib/key.mjs';
+export * from './lib/Paginator.mjs';
 
 export type InquirerReadline = readline.ReadLine & {
   output: MuteStream;

packages/core/src/lib/Paginator.ts → packages/core/src/lib/Paginator.mts

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import cliWidth from 'cli-width';
-import { breakLines } from './utils.js';
+import { breakLines } from './utils.mjs';
 
 /**
  * The paginator keeps track of a pointer index in a list and returns

packages/core/src/lib/options.ts → packages/core/src/lib/options.mts

@@ -1,4 +1,4 @@
-import type { AsyncPromptConfig, ResolvedPromptConfig } from '../index.js';
+import type { AsyncPromptConfig, ResolvedPromptConfig } from '../index.mjs';
 
 export async function getPromptConfig<In extends AsyncPromptConfig>(
   option: In

packages/core/src/lib/prefix.ts → packages/core/src/lib/prefix.mts

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import spinners from 'cli-spinners';
-import { useState, useEffect } from '../index.js';
+import { useState, useEffect } from '../index.mjs';
 
 const spinner = spinners.dots;
 

packages/core/src/lib/readline.ts → packages/core/src/lib/readline.mts

@@ -1,5 +1,5 @@
 import ansiEscapes from 'ansi-escapes';
-import type { InquirerReadline } from '../index.js';
+import type { InquirerReadline } from '../index.mjs';
 
 /**
  * Move cursor left by `x`