Major(@inquirer/core): Move InquirerReadline type to the @inquirer/ty…

…pe package
SBoudrias · Jun 29, 2024 · 8ad0d1a · 8ad0d1a
1 parent 057cee7
commit 8ad0d1a
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 16 deletions.
diff --git a/packages/core/src/index.mts b/packages/core/src/index.mts
@@ -11,4 +11,3 @@ export type { Theme } from './lib/theme.mjs';
 export { usePagination } from './lib/pagination/use-pagination.mjs';
 export { createPrompt } from './lib/create-prompt.mjs';
 export { Separator } from './lib/Separator.mjs';
-export { type InquirerReadline } from './lib/read-line.type.mjs';
diff --git a/packages/core/src/lib/create-prompt.mts b/packages/core/src/lib/create-prompt.mts
@@ -3,7 +3,7 @@ import { CancelablePromise, type Prompt, type Prettify } from '@inquirer/type';
 import MuteStream from 'mute-stream';
 import { onExit as onSignalExit } from 'signal-exit';
 import ScreenManager from './screen-manager.mjs';
-import type { InquirerReadline } from './read-line.type.mjs';
+import type { InquirerReadline } from '@inquirer/type';
 import { withHooks, effectScheduler } from './hook-engine.mjs';
 import { CancelPromptError, ExitPromptError } from './errors.mjs';
 

diff --git a/packages/core/src/lib/hook-engine.mts b/packages/core/src/lib/hook-engine.mts
@@ -1,7 +1,7 @@
 /* eslint @typescript-eslint/no-explicit-any: ["off"] */
 
 import { AsyncLocalStorage, AsyncResource } from 'node:async_hooks';
-import type { InquirerReadline } from './read-line.type.mjs';
+import type { InquirerReadline } from '@inquirer/type';
 import { HookError, ValidationError } from './errors.mjs';
 
 type HookStore = {

diff --git a/packages/core/src/lib/read-line.type.mts b/packages/core/src/lib/read-line.type.mts
diff --git a/packages/core/src/lib/screen-manager.mts b/packages/core/src/lib/screen-manager.mts
@@ -2,7 +2,7 @@ import type { CursorPos } from 'node:readline';
 import stripAnsi from 'strip-ansi';
 import ansiEscapes from 'ansi-escapes';
 import { breakLines, readlineWidth } from './utils.mjs';
-import type { InquirerReadline } from './read-line.type.mjs';
+import type { InquirerReadline } from '@inquirer/type';
 
 const height = (content: string): number => content.split('\n').length;
 const lastLine = (content: string): string => content.split('\n').pop() ?? '';

diff --git a/packages/core/src/lib/use-effect.mts b/packages/core/src/lib/use-effect.mts
@@ -1,5 +1,5 @@
 import { withPointer, effectScheduler } from './hook-engine.mjs';
-import type { InquirerReadline } from './read-line.type.mjs';
+import type { InquirerReadline } from '@inquirer/type';
 
 export function useEffect(
   cb: (rl: InquirerReadline) => void | (() => void),

diff --git a/packages/core/src/lib/use-keypress.mts b/packages/core/src/lib/use-keypress.mts
@@ -1,4 +1,4 @@
-import { type InquirerReadline } from './read-line.type.mjs';
+import { type InquirerReadline } from '@inquirer/type';
 import { type KeypressEvent } from './key.mjs';
 import { useRef } from './use-ref.mjs';
 import { useEffect } from './use-effect.mjs';

diff --git a/packages/editor/src/index.mts b/packages/editor/src/index.mts
@@ -8,10 +8,9 @@ import {
   usePrefix,
   isEnterKey,
   makeTheme,
-  type InquirerReadline,
   type Theme,
 } from '@inquirer/core';
-import type { PartialDeep } from '@inquirer/type';
+import type { PartialDeep, InquirerReadline } from '@inquirer/type';
 
 type EditorConfig = {
   message: string;

diff --git a/packages/type/package.json b/packages/type/package.json
@@ -54,6 +54,9 @@
   ],
   "author": "Simon Boudrias <admin@simonboudrias.com>",
   "license": "MIT",
+  "dependencies": {
+    "mute-stream": "^1.0.0"
+  },
   "scripts": {
     "tsc": "yarn run tsc:esm && yarn run tsc:cjs",
     "tsc:esm": "rm -rf dist/esm && tsc -p ./tsconfig.json",

diff --git a/packages/type/src/index.mts b/packages/type/src/index.mts
@@ -1,3 +1,12 @@
+import * as readline from 'node:readline';
+import MuteStream from 'mute-stream';
+
+export type InquirerReadline = readline.ReadLine & {
+  output: MuteStream;
+  input: NodeJS.ReadableStream;
+  clearLine: (dir: 0 | 1 | -1) => void; // https://nodejs.org/api/readline.html#rlclearlinedir
+};
+
 export class CancelablePromise<T> extends Promise<T> {
   public cancel: () => void = () => {};
 }

diff --git a/yarn.lock b/yarn.lock
@@ -585,6 +585,8 @@ __metadata:
 "@inquirer/type@npm:^1.3.3, @inquirer/type@workspace:packages/type":
   version: 0.0.0-use.local
   resolution: "@inquirer/type@workspace:packages/type"
+  dependencies:
+    mute-stream: "npm:^1.0.0"
   languageName: unknown
   linkType: soft