Build script to setup ESM/CJS module exports

SBoudrias · Jan 15, 2023 · b99b1d7 · b99b1d7
1 parent 898ad75
commit b99b1d7
Show file tree

Hide file tree

Showing 21 changed files with 163 additions and 46 deletions.
diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
     "lerna": "^6.0.3",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
+    "tsconfig-to-dual-package": "^1.1.0",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"

diff --git a/packages/inquirer/.gitignore b/packages/inquirer/.gitignore
@@ -0,0 +1,2 @@
+README.md
+lib-*
diff --git a/packages/inquirer/lib-cjs/inquirer-default.js b/packages/inquirer/lib-cjs/inquirer-default.js
@@ -0,0 +1,3 @@
+const inquirer = require("./inquirer.js").default;
+
+module.exports = inquirer;
diff --git a/packages/inquirer/lib/objects/separator.js b/packages/inquirer/lib/objects/separator.js
@@ -1,5 +1,5 @@
-import chalk from 'chalk';
-import figures from 'figures';
+import chalk from '#chalk';
+import figures from '#figures';
 
 /**
  * Separator object

diff --git a/packages/inquirer/lib/prompts/base.js b/packages/inquirer/lib/prompts/base.js
@@ -9,7 +9,7 @@ const _ = {
   clone,
 };
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import runAsync from 'run-async';
 import { filter, flatMap, share, take, takeUntil } from 'rxjs';
 import Choices from '../objects/choices.js';

diff --git a/packages/inquirer/lib/prompts/checkbox.js b/packages/inquirer/lib/prompts/checkbox.js
@@ -2,9 +2,9 @@
  * `list` type prompt
  */
 
-import chalk from 'chalk';
-import cliCursor from 'cli-cursor';
-import figures from 'figures';
+import chalk from '#chalk';
+import cliCursor from '#cli-cursor';
+import figures from '#figures';
 import { map, takeUntil } from 'rxjs';
 import Base from './base.js';
 import observe from '../utils/events.js';

diff --git a/packages/inquirer/lib/prompts/confirm.js b/packages/inquirer/lib/prompts/confirm.js
@@ -2,7 +2,7 @@
  * `confirm` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { take, takeUntil } from 'rxjs';
 import Base from './base.js';
 import observe from '../utils/events.js';

diff --git a/packages/inquirer/lib/prompts/editor.js b/packages/inquirer/lib/prompts/editor.js
@@ -2,7 +2,7 @@
  * `editor` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { editAsync } from 'external-editor';
 import Base from './base.js';
 import observe from '../utils/events.js';

diff --git a/packages/inquirer/lib/prompts/expand.js b/packages/inquirer/lib/prompts/expand.js
@@ -2,7 +2,7 @@
  * `rawlist` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { map, takeUntil } from 'rxjs';
 import Base from './base.js';
 import Separator from '../objects/separator.js';

diff --git a/packages/inquirer/lib/prompts/input.js b/packages/inquirer/lib/prompts/input.js
@@ -2,7 +2,7 @@
  * `input` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { map, takeUntil } from 'rxjs';
 import Base from './base.js';
 import observe from '../utils/events.js';

diff --git a/packages/inquirer/lib/prompts/list.js b/packages/inquirer/lib/prompts/list.js
@@ -2,9 +2,9 @@
  * `list` type prompt
  */
 
-import chalk from 'chalk';
-import figures from 'figures';
-import cliCursor from 'cli-cursor';
+import chalk from '#chalk';
+import figures from '#figures';
+import cliCursor from '#cli-cursor';
 import runAsync from 'run-async';
 import { flatMap, map, take, takeUntil } from 'rxjs';
 import Base from './base.js';

diff --git a/packages/inquirer/lib/prompts/password.js b/packages/inquirer/lib/prompts/password.js
@@ -2,7 +2,7 @@
  * `password` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { map, takeUntil } from 'rxjs';
 import Base from './base.js';
 import observe from '../utils/events.js';

diff --git a/packages/inquirer/lib/prompts/rawlist.js b/packages/inquirer/lib/prompts/rawlist.js
@@ -2,7 +2,7 @@
  * `rawlist` type prompt
  */
 
-import chalk from 'chalk';
+import chalk from '#chalk';
 import { map, takeUntil } from 'rxjs';
 import Base from './base.js';
 import Separator from '../objects/separator.js';

diff --git a/packages/inquirer/lib/utils/paginator.js b/packages/inquirer/lib/utils/paginator.js
@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import chalk from '#chalk';
 
 /**
  * The paginator returns a subset of the choices if the list is too long.

diff --git a/packages/inquirer/lib/utils/readline.js b/packages/inquirer/lib/utils/readline.js
@@ -1,4 +1,4 @@
-import ansiEscapes from 'ansi-escapes';
+import ansiEscapes from '#ansi-escapes';
 
 /**
  * Move cursor left by `x`

diff --git a/packages/inquirer/lib/utils/screen-manager.js b/packages/inquirer/lib/utils/screen-manager.js
@@ -1,9 +1,9 @@
 import * as util from './readline.js';
 import cliWidth from 'cli-width';
-import wrapAnsi from 'wrap-ansi';
-import stripAnsi from 'strip-ansi';
-import stringWidth from 'string-width';
-import ora from 'ora';
+import wrapAnsi from '#wrap-ansi';
+import stripAnsi from '#strip-ansi';
+import stringWidth from '#string-width';
+import ora from '#ora';
 
 function height(content) {
   return content.split('\n').length;

diff --git a/packages/inquirer/package.json b/packages/inquirer/package.json
@@ -6,9 +6,67 @@
   "author": "Simon Boudrias <admin@simonboudrias.com>",
   "files": [
     "lib",
+    "lib-cjs",
     "README.md"
   ],
   "main": "lib/inquirer.js",
+  "exports": {
+    ".": {
+      "require": "./lib-cjs/inquirer-default.js",
+      "default": "./lib/inquirer.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "imports": {
+    "#ansi-escapes": {
+      "node": {
+        "require": "ansi-escapes-4",
+        "default": "ansi-escapes"
+      }
+    },
+    "#chalk": {
+      "node": {
+        "require": "chalk-4",
+        "default": "chalk"
+      }
+    },
+    "#cli-cursor": {
+      "node": {
+        "require": "cli-cursor-3",
+        "default": "cli-cursor"
+      }
+    },
+    "#figures": {
+      "node": {
+        "require": "figures-3",
+        "default": "figures"
+      }
+    },
+    "#ora": {
+      "node": {
+        "require": "ora-5",
+        "default": "ora"
+      }
+    },
+    "#string-width": {
+      "node": {
+        "require": "string-width-4",
+        "default": "string-width"
+      }
+    },
+    "#strip-ansi": {
+      "node": {
+        "require": "strip-ansi-6",
+        "default": "strip-ansi"
+      }
+    },
+    "#wrap-ansi": {
+      "node": {
+        "require": "wrap-ansi-7",
+        "default": "wrap-ansi"
+      }
+    }
+  },
   "keywords": [
     "answer",
     "answers",
@@ -50,7 +108,7 @@
     "zsh"
   ],
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.18.0"
   },
   "devDependencies": {
     "chai": "^4.3.7",
@@ -66,26 +124,36 @@
   "scripts": {
     "test": "nyc mocha --es-module-specifier-resolution=node test/**/* -r ./test/before",
     "posttest": "mkdir -p ../../coverage/ && nyc report --reporter=text-lcov > ../../coverage/nyc-report.lcov",
-    "prepublishOnly": "cp ../../README.md .",
+    "prebuild": "find ./lib-cjs/* ! -name 'inquirer-default.js' -exec rm -rf {} +",
+    "build": "tsc -p ./tsconfig.cjs.json && tsconfig-to-dual-package ./tsconfig.cjs.json",
+    "prepublishOnly": "cp ../../README.md . && npm run build",
     "postpublish": "rm -f README.md"
   },
   "repository": "SBoudrias/Inquirer.js",
   "license": "MIT",
   "dependencies": {
     "ansi-escapes": "^6.0.0",
+    "ansi-escapes-4": "npm:ansi-escapes@^4.3.2",
     "chalk": "^5.1.2",
+    "chalk-4": "npm:chalk@^4.1.2",
     "cli-cursor": "^4.0.0",
+    "cli-cursor-3": "npm:cli-cursor@^3.1.0",
     "cli-width": "^4.0.0",
     "external-editor": "^3.0.3",
     "figures": "^5.0.0",
+    "figures-3": "npm:figures@^3.2.0",
     "lodash": "^4.17.21",
     "mute-stream": "0.0.8",
     "ora": "^6.1.2",
+    "ora-5": "npm:ora@^5.4.1",
     "run-async": "^2.4.0",
     "rxjs": "^7.5.7",
     "string-width": "^5.1.2",
+    "string-width-4": "npm:string-width@^4.2.3",
     "strip-ansi": "^7.0.1",
+    "strip-ansi-6": "npm:strip-ansi@^6.0.1",
     "through": "^2.3.6",
-    "wrap-ansi": "^8.0.1"
+    "wrap-ansi": "^8.0.1",
+    "wrap-ansi-7": "npm:wrap-ansi@^7.0.0"
   }
 }
diff --git a/packages/inquirer/tsconfig.base.json b/packages/inquirer/tsconfig.base.json
@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "allowJs": true,
+        "checkJs": false,
+        "skipLibCheck": true,
+        "esModuleInterop": true
+    },
+    "include": [
+        "./lib/**/*.js"
+    ]
+}
diff --git a/packages/inquirer/tsconfig.cjs.json b/packages/inquirer/tsconfig.cjs.json
@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.base",
+    "compilerOptions": {
+        "lib": ["ES6"],
+        "target": "ES6",
+        "module": "CommonJS",
+        "moduleResolution": "Node",
+        "outDir": "./lib-cjs"
+    }
+}
diff --git a/packages/inquirer/tsconfig.esm.json b/packages/inquirer/tsconfig.esm.json
@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.base",
+    "compilerOptions": {
+        "lib": ["ES2022"],
+        "target": "ES2022",
+        "module": "ESNext",
+        "moduleResolution": "NodeNext",
+        "outDir": "./lib"
+    }
+}