Major(inquirer): Migrate to Typescript and dual module package

integration/cjs/integration.test.cjs

@@ -4,6 +4,8 @@ const assert = require('node:assert');
 const { input } = require('@inquirer/prompts');
 const { createPrompt } = require('@inquirer/core');
 const defaultInput = require('@inquirer/input').default;
+const inquirer = require('inquirer').default;
+const { createPromptModule } = require('inquirer');
 
 describe('CommonJS Integration', () => {
   it('@inquirer/prompts should be exported', () => {
@@ -17,4 +19,10 @@ describe('CommonJS Integration', () => {
   it('@inquirer/core should export createPrompt', () => {
     assert(createPrompt instanceof Function);
   });
+
+  it('inquirer should be exported', () => {
+    assert(inquirer.prompt instanceof Function);
+    assert(inquirer.createPromptModule instanceof Function);
+    assert(createPromptModule instanceof Function);
+  });
 });

integration/esm/integration.test.mjs

@@ -1,17 +1,10 @@
 /* eslint-disable n/no-unsupported-features/node-builtins */
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
 import { input } from '@inquirer/prompts';
 import defaultInput from '@inquirer/input';
 import { createPrompt } from '@inquirer/core';
 import inquirer, { createPromptModule } from 'inquirer';
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-
-import Base from 'inquirer/lib/prompts/base.js';
-import Choices from 'inquirer/lib/objects/choices.js';
-import Separator from 'inquirer/lib/objects/separator.js';
-import observe from 'inquirer/lib/utils/events.js';
-import * as utils from 'inquirer/lib/utils/readline.js';
-import Paginator from 'inquirer/lib/utils/paginator.js';
 
 describe('ESM Integration', () => {
   it('@inquirer/prompts should be exported', () => {
@@ -31,13 +24,4 @@ describe('ESM Integration', () => {
     assert(inquirer.createPromptModule instanceof Function);
     assert(createPromptModule instanceof Function);
   });
-
-  it('inquirer custom prompts util paths are stable', () => {
-    assert(Base != null);
-    assert(Choices != null);
-    assert(Separator != null);
-    assert(observe != null);
-    assert(utils != null);
-    assert(Paginator != null);
-  });
 });

packages/inquirer/README.md

@@ -94,20 +94,7 @@ inquirer
   });
 ```
 
-> [!WARNING]
-> Inquirer v9 and higher are native esm modules, this mean you cannot use the commonjs syntax `require('inquirer')` anymore. If you want to learn more about using native esm in Node, I'd recommend reading [the following guide](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
-
-Alternatively, if you require a commonjs module, you should rely on an older version until you're ready to upgrade your environment:
-
-```sh
-npm install --save inquirer@^8.0.0
-```
-
-This will then allow import inquirer with the commonjs `require`:
-
-```js
-const inquirer = require('inquirer');
-```
+If you're using Typescript, you'll also want to [add `@types/inquirer`](https://www.npmjs.com/package/@types/inquirer).
 
 <a name="examples"></a>
 

packages/inquirer/examples/bottom-bar.js → packages/inquirer/examples/bottom-bar.mts

@@ -1,5 +1,5 @@
 import { spawn } from 'node:child_process';
-import BottomBar from '../lib/ui/bottom-bar.js';
+import BottomBar from '../src/ui/bottom-bar.mjs';
 
 const loader = ['/ Installing', '| Installing', String.raw`\ Installing`, '- Installing'];
 let i = 4;

packages/inquirer/examples/checkbox.js → packages/inquirer/examples/checkbox.mts

@@ -2,7 +2,7 @@
  * Checkbox list examples
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt([

packages/inquirer/examples/editor.js → packages/inquirer/examples/editor.mts

@@ -2,7 +2,7 @@
  * Editor prompt example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {

packages/inquirer/examples/expand.js → packages/inquirer/examples/expand.mts

@@ -2,7 +2,7 @@
  * Expand list examples
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt([

packages/inquirer/examples/filter-validate-progress.js → packages/inquirer/examples/filter-validate-progress.mts

@@ -2,7 +2,7 @@
  * Filter and validate progress example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {

packages/inquirer/examples/hierarchical.js → packages/inquirer/examples/hierarchical.mts

@@ -2,7 +2,7 @@
  * Heirarchical conversation example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const directionsPrompt = {
   type: 'list',

packages/inquirer/examples/input.js → packages/inquirer/examples/input.mts

@@ -2,7 +2,7 @@
  * Input prompt example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {

packages/inquirer/examples/list.js → packages/inquirer/examples/list.mts

@@ -2,7 +2,7 @@
  * List prompt example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt([

packages/inquirer/examples/long-list.js → packages/inquirer/examples/long-list.mts

@@ -2,7 +2,7 @@
  * Paginated list
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const choices = Array.apply(0, Array.from({ length: 26 })).map((x, y) =>
   String.fromCodePoint(y + 65),

packages/inquirer/examples/nested-call.js → packages/inquirer/examples/nested-call.mts

@@ -2,7 +2,7 @@
  * Nested Inquirer call
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt({

packages/inquirer/examples/password.js → packages/inquirer/examples/password.mts

@@ -2,7 +2,7 @@
  * Password prompt example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const requireLetterAndNumber = (value) => {
   if (/\w/.test(value) && /\d/.test(value)) {

packages/inquirer/examples/pizza.js → packages/inquirer/examples/pizza.mts

@@ -1,9 +1,9 @@
 /**
  * Pizza delivery prompt example
- * run example by writing `node pizza.js` in your console
+ * run example by writing `node pizza.mjs` in your console
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 console.log('Hi, welcome to Node Pizza');
 

packages/inquirer/examples/rawlist.js → packages/inquirer/examples/rawlist.mts

@@ -2,7 +2,7 @@
  * Raw List prompt example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt([

packages/inquirer/examples/recursive.js → packages/inquirer/examples/recursive.mts

@@ -3,8 +3,7 @@
  * Allows user to choose when to exit prompt
  */
 
-import inquirer from '../lib/index.js';
-const output = [];
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {
@@ -21,6 +20,8 @@ const questions = [
 ];
 
 function ask() {
+  const output: string[] = [];
+
   inquirer.prompt(questions).then((answers) => {
     output.push(answers.tvShow);
     if (answers.askAgain) {

packages/inquirer/examples/regex-validate-input.js → packages/inquirer/examples/regex-validate-input.mts

@@ -2,7 +2,7 @@
  * Filter and validate progress example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {

packages/inquirer/examples/rx-observable-array.js → packages/inquirer/examples/rx-observable-array.mts

@@ -1,5 +1,5 @@
 import { from } from 'rxjs';
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {

packages/inquirer/examples/rx-observable-create.js → packages/inquirer/examples/rx-observable-create.mts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const observe = new Observable((subscriber) => {
   subscriber.next({

packages/inquirer/examples/spawn.js → packages/inquirer/examples/spawn.mts

@@ -1,6 +1,6 @@
 import { spawn } from 'node:child_process';
 
-spawn('node', ['input.js'], {
+spawn('node', ['input.mjs'], {
   cwd: import.meta.dirname,
   stdio: 'inherit',
 });

packages/inquirer/examples/terminal-link.js → packages/inquirer/examples/terminal-link.mts

@@ -5,7 +5,7 @@
  */
 
 import terminalLink from 'terminal-link';
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 inquirer
   .prompt([

packages/inquirer/examples/when.js → packages/inquirer/examples/when.mts

@@ -2,7 +2,7 @@
  * When example
  */
 
-import inquirer from '../lib/index.js';
+import inquirer from '../src/index.mjs';
 
 const questions = [
   {