@inquirer/core 11.0.0 → 11.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/package.json +11 -16
  2. package/dist/commonjs/index.d.ts +0 -13
  3. package/dist/commonjs/index.js +0 -46
  4. package/dist/commonjs/lib/Separator.d.ts +0 -10
  5. package/dist/commonjs/lib/Separator.js +0 -28
  6. package/dist/commonjs/lib/create-prompt.d.ts +0 -4
  7. package/dist/commonjs/lib/create-prompt.js +0 -156
  8. package/dist/commonjs/lib/errors.d.ts +0 -20
  9. package/dist/commonjs/lib/errors.js +0 -29
  10. package/dist/commonjs/lib/hook-engine.d.ts +0 -23
  11. package/dist/commonjs/lib/hook-engine.js +0 -118
  12. package/dist/commonjs/lib/key.d.ts +0 -12
  13. package/dist/commonjs/lib/key.js +0 -29
  14. package/dist/commonjs/lib/make-theme.d.ts +0 -3
  15. package/dist/commonjs/lib/make-theme.js +0 -33
  16. package/dist/commonjs/lib/pagination/use-pagination.d.ts +0 -16
  17. package/dist/commonjs/lib/pagination/use-pagination.js +0 -124
  18. package/dist/commonjs/lib/promise-polyfill.d.ts +0 -7
  19. package/dist/commonjs/lib/promise-polyfill.js +0 -18
  20. package/dist/commonjs/lib/screen-manager.d.ts +0 -14
  21. package/dist/commonjs/lib/screen-manager.js +0 -82
  22. package/dist/commonjs/lib/theme.d.ts +0 -155
  23. package/dist/commonjs/lib/theme.js +0 -27
  24. package/dist/commonjs/lib/use-effect.d.ts +0 -2
  25. package/dist/commonjs/lib/use-effect.js +0 -14
  26. package/dist/commonjs/lib/use-keypress.d.ts +0 -3
  27. package/dist/commonjs/lib/use-keypress.js +0 -23
  28. package/dist/commonjs/lib/use-memo.d.ts +0 -1
  29. package/dist/commonjs/lib/use-memo.js +0 -17
  30. package/dist/commonjs/lib/use-prefix.d.ts +0 -5
  31. package/dist/commonjs/lib/use-prefix.js +0 -38
  32. package/dist/commonjs/lib/use-ref.d.ts +0 -6
  33. package/dist/commonjs/lib/use-ref.js +0 -7
  34. package/dist/commonjs/lib/use-state.d.ts +0 -4
  35. package/dist/commonjs/lib/use-state.js +0 -23
  36. package/dist/commonjs/lib/utils.d.ts +0 -13
  37. package/dist/commonjs/lib/utils.js +0 -32
  38. package/dist/commonjs/package.json +0 -3
  39. package/dist/esm/index.d.ts +0 -13
  40. package/dist/esm/index.js +0 -12
  41. package/dist/esm/lib/Separator.d.ts +0 -10
  42. package/dist/esm/lib/Separator.js +0 -21
  43. package/dist/esm/lib/create-prompt.d.ts +0 -4
  44. package/dist/esm/lib/create-prompt.js +0 -117
  45. package/dist/esm/lib/errors.d.ts +0 -20
  46. package/dist/esm/lib/errors.js +0 -21
  47. package/dist/esm/lib/hook-engine.d.ts +0 -23
  48. package/dist/esm/lib/hook-engine.js +0 -110
  49. package/dist/esm/lib/key.d.ts +0 -12
  50. package/dist/esm/lib/key.js +0 -19
  51. package/dist/esm/lib/make-theme.d.ts +0 -3
  52. package/dist/esm/lib/make-theme.js +0 -30
  53. package/dist/esm/lib/pagination/use-pagination.d.ts +0 -16
  54. package/dist/esm/lib/pagination/use-pagination.js +0 -121
  55. package/dist/esm/lib/promise-polyfill.d.ts +0 -7
  56. package/dist/esm/lib/promise-polyfill.js +0 -14
  57. package/dist/esm/lib/screen-manager.d.ts +0 -14
  58. package/dist/esm/lib/screen-manager.js +0 -79
  59. package/dist/esm/lib/theme.d.ts +0 -155
  60. package/dist/esm/lib/theme.js +0 -21
  61. package/dist/esm/lib/use-effect.d.ts +0 -2
  62. package/dist/esm/lib/use-effect.js +0 -11
  63. package/dist/esm/lib/use-keypress.d.ts +0 -3
  64. package/dist/esm/lib/use-keypress.js +0 -20
  65. package/dist/esm/lib/use-memo.d.ts +0 -1
  66. package/dist/esm/lib/use-memo.js +0 -14
  67. package/dist/esm/lib/use-prefix.d.ts +0 -5
  68. package/dist/esm/lib/use-prefix.js +0 -35
  69. package/dist/esm/lib/use-ref.d.ts +0 -6
  70. package/dist/esm/lib/use-ref.js +0 -4
  71. package/dist/esm/lib/use-state.d.ts +0 -4
  72. package/dist/esm/lib/use-state.js +0 -20
  73. package/dist/esm/lib/utils.d.ts +0 -13
  74. package/dist/esm/lib/utils.js +0 -25
  75. package/dist/esm/package.json +0 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inquirer/core",
3
- "version": "11.0.0",
3
+ "version": "11.0.1",
4
4
  "description": "Core Inquirer prompt API",
5
5
  "keywords": [
6
6
  "answer",
@@ -52,7 +52,10 @@
52
52
  "type": "module",
53
53
  "exports": {
54
54
  "./package.json": "./package.json",
55
- ".": "./src/index.ts"
55
+ ".": {
56
+ "types": "./dist/index.d.ts",
57
+ "default": "./dist/index.js"
58
+ }
56
59
  },
57
60
  "files": [
58
61
  "dist"
@@ -61,17 +64,16 @@
61
64
  "tsc": "tsc"
62
65
  },
63
66
  "dependencies": {
64
- "@inquirer/ansi": "^2.0.0",
65
- "@inquirer/figures": "^2.0.0",
66
- "@inquirer/type": "^4.0.0",
67
+ "@inquirer/ansi": "^2.0.1",
68
+ "@inquirer/figures": "^2.0.1",
69
+ "@inquirer/type": "^4.0.1",
67
70
  "cli-width": "^4.1.0",
68
71
  "mute-stream": "^3.0.0",
69
72
  "signal-exit": "^4.1.0",
70
73
  "wrap-ansi": "^9.0.2"
71
74
  },
72
75
  "devDependencies": {
73
- "@inquirer/testing": "^3.0.0",
74
- "@repo/tsconfig": "0.0.0",
76
+ "@inquirer/testing": "^3.0.1",
75
77
  "@types/mute-stream": "^0.0.4",
76
78
  "@types/node": "^24.10.1",
77
79
  "typescript": "^5.9.3"
@@ -88,14 +90,7 @@
88
90
  "node": ">=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0"
89
91
  },
90
92
  "publishConfig": {
91
- "access": "public",
92
- "exports": {
93
- "./package.json": "./package.json",
94
- ".": {
95
- "types": "./dist/index.d.ts",
96
- "default": "./dist/index.js"
97
- }
98
- }
93
+ "access": "public"
99
94
  },
100
- "gitHead": "676685d33374a30340c1b9f0831c7eae2b2357dd"
95
+ "gitHead": "cce79ce3b9bbdfb4dbb798078cf3b94b9adc7d1b"
101
96
  }
@@ -1,13 +0,0 @@
1
- export { isUpKey, isDownKey, isSpaceKey, isBackspaceKey, isTabKey, isNumberKey, isEnterKey, type KeypressEvent, type Keybinding, } from './lib/key.ts';
2
- export * from './lib/errors.ts';
3
- export { usePrefix } from './lib/use-prefix.ts';
4
- export { useState } from './lib/use-state.ts';
5
- export { useEffect } from './lib/use-effect.ts';
6
- export { useMemo } from './lib/use-memo.ts';
7
- export { useRef } from './lib/use-ref.ts';
8
- export { useKeypress } from './lib/use-keypress.ts';
9
- export { makeTheme } from './lib/make-theme.ts';
10
- export type { Theme, Status } from './lib/theme.ts';
11
- export { usePagination } from './lib/pagination/use-pagination.ts';
12
- export { createPrompt } from './lib/create-prompt.ts';
13
- export { Separator } from './lib/Separator.ts';
@@ -1,46 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.Separator = exports.createPrompt = exports.usePagination = exports.makeTheme = exports.useKeypress = exports.useRef = exports.useMemo = exports.useEffect = exports.useState = exports.usePrefix = exports.isEnterKey = exports.isNumberKey = exports.isTabKey = exports.isBackspaceKey = exports.isSpaceKey = exports.isDownKey = exports.isUpKey = void 0;
18
- var key_ts_1 = require("./lib/key.js");
19
- Object.defineProperty(exports, "isUpKey", { enumerable: true, get: function () { return key_ts_1.isUpKey; } });
20
- Object.defineProperty(exports, "isDownKey", { enumerable: true, get: function () { return key_ts_1.isDownKey; } });
21
- Object.defineProperty(exports, "isSpaceKey", { enumerable: true, get: function () { return key_ts_1.isSpaceKey; } });
22
- Object.defineProperty(exports, "isBackspaceKey", { enumerable: true, get: function () { return key_ts_1.isBackspaceKey; } });
23
- Object.defineProperty(exports, "isTabKey", { enumerable: true, get: function () { return key_ts_1.isTabKey; } });
24
- Object.defineProperty(exports, "isNumberKey", { enumerable: true, get: function () { return key_ts_1.isNumberKey; } });
25
- Object.defineProperty(exports, "isEnterKey", { enumerable: true, get: function () { return key_ts_1.isEnterKey; } });
26
- __exportStar(require("./lib/errors.js"), exports);
27
- var use_prefix_ts_1 = require("./lib/use-prefix.js");
28
- Object.defineProperty(exports, "usePrefix", { enumerable: true, get: function () { return use_prefix_ts_1.usePrefix; } });
29
- var use_state_ts_1 = require("./lib/use-state.js");
30
- Object.defineProperty(exports, "useState", { enumerable: true, get: function () { return use_state_ts_1.useState; } });
31
- var use_effect_ts_1 = require("./lib/use-effect.js");
32
- Object.defineProperty(exports, "useEffect", { enumerable: true, get: function () { return use_effect_ts_1.useEffect; } });
33
- var use_memo_ts_1 = require("./lib/use-memo.js");
34
- Object.defineProperty(exports, "useMemo", { enumerable: true, get: function () { return use_memo_ts_1.useMemo; } });
35
- var use_ref_ts_1 = require("./lib/use-ref.js");
36
- Object.defineProperty(exports, "useRef", { enumerable: true, get: function () { return use_ref_ts_1.useRef; } });
37
- var use_keypress_ts_1 = require("./lib/use-keypress.js");
38
- Object.defineProperty(exports, "useKeypress", { enumerable: true, get: function () { return use_keypress_ts_1.useKeypress; } });
39
- var make_theme_ts_1 = require("./lib/make-theme.js");
40
- Object.defineProperty(exports, "makeTheme", { enumerable: true, get: function () { return make_theme_ts_1.makeTheme; } });
41
- var use_pagination_ts_1 = require("./lib/pagination/use-pagination.js");
42
- Object.defineProperty(exports, "usePagination", { enumerable: true, get: function () { return use_pagination_ts_1.usePagination; } });
43
- var create_prompt_ts_1 = require("./lib/create-prompt.js");
44
- Object.defineProperty(exports, "createPrompt", { enumerable: true, get: function () { return create_prompt_ts_1.createPrompt; } });
45
- var Separator_ts_1 = require("./lib/Separator.js");
46
- Object.defineProperty(exports, "Separator", { enumerable: true, get: function () { return Separator_ts_1.Separator; } });
@@ -1,10 +0,0 @@
1
- /**
2
- * Separator object
3
- * Used to space/separate choices group
4
- */
5
- export declare class Separator {
6
- readonly separator: string;
7
- readonly type: string;
8
- constructor(separator?: string);
9
- static isSeparator(choice: unknown): choice is Separator;
10
- }
@@ -1,28 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.Separator = void 0;
7
- const yoctocolors_cjs_1 = __importDefault(require("yoctocolors-cjs"));
8
- const figures_1 = __importDefault(require("@inquirer/figures"));
9
- /**
10
- * Separator object
11
- * Used to space/separate choices group
12
- */
13
- class Separator {
14
- separator = yoctocolors_cjs_1.default.dim(Array.from({ length: 15 }).join(figures_1.default.line));
15
- type = 'separator';
16
- constructor(separator) {
17
- if (separator) {
18
- this.separator = separator;
19
- }
20
- }
21
- static isSeparator(choice) {
22
- return Boolean(choice &&
23
- typeof choice === 'object' &&
24
- 'type' in choice &&
25
- choice.type === 'separator');
26
- }
27
- }
28
- exports.Separator = Separator;
@@ -1,4 +0,0 @@
1
- import { type Prompt, type Prettify } from '@inquirer/type';
2
- type ViewFunction<Value, Config> = (config: Prettify<Config>, done: (value: Value) => void) => string | [string, string | undefined];
3
- export declare function createPrompt<Value, Config>(view: ViewFunction<Value, Config>): Prompt<Value, Config>;
4
- export {};
@@ -1,156 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || (function () {
19
- var ownKeys = function(o) {
20
- ownKeys = Object.getOwnPropertyNames || function (o) {
21
- var ar = [];
22
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
- return ar;
24
- };
25
- return ownKeys(o);
26
- };
27
- return function (mod) {
28
- if (mod && mod.__esModule) return mod;
29
- var result = {};
30
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
- __setModuleDefault(result, mod);
32
- return result;
33
- };
34
- })();
35
- var __importDefault = (this && this.__importDefault) || function (mod) {
36
- return (mod && mod.__esModule) ? mod : { "default": mod };
37
- };
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.createPrompt = createPrompt;
40
- const readline = __importStar(require("node:readline"));
41
- const node_async_hooks_1 = require("node:async_hooks");
42
- const mute_stream_1 = __importDefault(require("mute-stream"));
43
- const signal_exit_1 = require("signal-exit");
44
- const screen_manager_ts_1 = __importDefault(require("./screen-manager.js"));
45
- const promise_polyfill_ts_1 = require("./promise-polyfill.js");
46
- const hook_engine_ts_1 = require("./hook-engine.js");
47
- const errors_ts_1 = require("./errors.js");
48
- function getCallSites() {
49
- // eslint-disable-next-line @typescript-eslint/unbound-method
50
- const _prepareStackTrace = Error.prepareStackTrace;
51
- let result = [];
52
- try {
53
- Error.prepareStackTrace = (_, callSites) => {
54
- const callSitesWithoutCurrent = callSites.slice(1);
55
- result = callSitesWithoutCurrent;
56
- return callSitesWithoutCurrent;
57
- };
58
- // eslint-disable-next-line @typescript-eslint/no-unused-expressions
59
- new Error().stack;
60
- }
61
- catch {
62
- // An error will occur if the Node flag --frozen-intrinsics is used.
63
- // https://nodejs.org/api/cli.html#--frozen-intrinsics
64
- return result;
65
- }
66
- Error.prepareStackTrace = _prepareStackTrace;
67
- return result;
68
- }
69
- function createPrompt(view) {
70
- const callSites = getCallSites();
71
- const prompt = (config, context = {}) => {
72
- // Default `input` to stdin
73
- const { input = process.stdin, signal } = context;
74
- const cleanups = new Set();
75
- // Add mute capabilities to the output
76
- const output = new mute_stream_1.default();
77
- output.pipe(context.output ?? process.stdout);
78
- const rl = readline.createInterface({
79
- terminal: true,
80
- input,
81
- output,
82
- });
83
- const screen = new screen_manager_ts_1.default(rl);
84
- const { promise, resolve, reject } = promise_polyfill_ts_1.PromisePolyfill.withResolver();
85
- const cancel = () => reject(new errors_ts_1.CancelPromptError());
86
- if (signal) {
87
- const abort = () => reject(new errors_ts_1.AbortPromptError({ cause: signal.reason }));
88
- if (signal.aborted) {
89
- abort();
90
- return Object.assign(promise, { cancel });
91
- }
92
- signal.addEventListener('abort', abort);
93
- cleanups.add(() => signal.removeEventListener('abort', abort));
94
- }
95
- cleanups.add((0, signal_exit_1.onExit)((code, signal) => {
96
- reject(new errors_ts_1.ExitPromptError(`User force closed the prompt with ${code} ${signal}`));
97
- }));
98
- // SIGINT must be explicitly handled by the prompt so the ExitPromptError can be handled.
99
- // Otherwise, the prompt will stop and in some scenarios never resolve.
100
- // Ref issue #1741
101
- const sigint = () => reject(new errors_ts_1.ExitPromptError(`User force closed the prompt with SIGINT`));
102
- rl.on('SIGINT', sigint);
103
- cleanups.add(() => rl.removeListener('SIGINT', sigint));
104
- // Re-renders only happen when the state change; but the readline cursor could change position
105
- // and that also requires a re-render (and a manual one because we mute the streams).
106
- // We set the listener after the initial workLoop to avoid a double render if render triggered
107
- // by a state change sets the cursor to the right position.
108
- const checkCursorPos = () => screen.checkCursorPos();
109
- rl.input.on('keypress', checkCursorPos);
110
- cleanups.add(() => rl.input.removeListener('keypress', checkCursorPos));
111
- return (0, hook_engine_ts_1.withHooks)(rl, (cycle) => {
112
- // The close event triggers immediately when the user press ctrl+c. SignalExit on the other hand
113
- // triggers after the process is done (which happens after timeouts are done triggering.)
114
- // We triggers the hooks cleanup phase on rl `close` so active timeouts can be cleared.
115
- const hooksCleanup = node_async_hooks_1.AsyncResource.bind(() => hook_engine_ts_1.effectScheduler.clearAll());
116
- rl.on('close', hooksCleanup);
117
- cleanups.add(() => rl.removeListener('close', hooksCleanup));
118
- cycle(() => {
119
- try {
120
- const nextView = view(config, (value) => {
121
- setImmediate(() => resolve(value));
122
- });
123
- // Typescript won't allow this, but not all users rely on typescript.
124
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
125
- if (nextView === undefined) {
126
- const callerFilename = callSites[1]?.getFileName();
127
- throw new Error(`Prompt functions must return a string.\n at ${callerFilename}`);
128
- }
129
- const [content, bottomContent] = typeof nextView === 'string' ? [nextView] : nextView;
130
- screen.render(content, bottomContent);
131
- hook_engine_ts_1.effectScheduler.run();
132
- }
133
- catch (error) {
134
- reject(error);
135
- }
136
- });
137
- return Object.assign(promise
138
- .then((answer) => {
139
- hook_engine_ts_1.effectScheduler.clearAll();
140
- return answer;
141
- }, (error) => {
142
- hook_engine_ts_1.effectScheduler.clearAll();
143
- throw error;
144
- })
145
- // Wait for the promise to settle, then cleanup.
146
- .finally(() => {
147
- cleanups.forEach((cleanup) => cleanup());
148
- screen.done({ clearContent: Boolean(context.clearPromptOnDone) });
149
- output.end();
150
- })
151
- // Once cleanup is done, let the expose promise resolve/reject to the internal one.
152
- .then(() => promise), { cancel });
153
- });
154
- };
155
- return prompt;
156
- }
@@ -1,20 +0,0 @@
1
- export declare class AbortPromptError extends Error {
2
- name: string;
3
- message: string;
4
- constructor(options?: {
5
- cause?: unknown;
6
- });
7
- }
8
- export declare class CancelPromptError extends Error {
9
- name: string;
10
- message: string;
11
- }
12
- export declare class ExitPromptError extends Error {
13
- name: string;
14
- }
15
- export declare class HookError extends Error {
16
- name: string;
17
- }
18
- export declare class ValidationError extends Error {
19
- name: string;
20
- }
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ValidationError = exports.HookError = exports.ExitPromptError = exports.CancelPromptError = exports.AbortPromptError = void 0;
4
- class AbortPromptError extends Error {
5
- name = 'AbortPromptError';
6
- message = 'Prompt was aborted';
7
- constructor(options) {
8
- super();
9
- this.cause = options?.cause;
10
- }
11
- }
12
- exports.AbortPromptError = AbortPromptError;
13
- class CancelPromptError extends Error {
14
- name = 'CancelPromptError';
15
- message = 'Prompt was canceled';
16
- }
17
- exports.CancelPromptError = CancelPromptError;
18
- class ExitPromptError extends Error {
19
- name = 'ExitPromptError';
20
- }
21
- exports.ExitPromptError = ExitPromptError;
22
- class HookError extends Error {
23
- name = 'HookError';
24
- }
25
- exports.HookError = HookError;
26
- class ValidationError extends Error {
27
- name = 'ValidationError';
28
- }
29
- exports.ValidationError = ValidationError;
@@ -1,23 +0,0 @@
1
- import type { InquirerReadline } from '@inquirer/type';
2
- export declare function withHooks<T>(rl: InquirerReadline, cb: (cycle: (render: () => void) => void) => T): T;
3
- export declare function readline(): InquirerReadline;
4
- export declare function withUpdates<Args extends unknown[], R>(fn: (...args: Args) => R): (...args: Args) => R;
5
- type SetPointer<Value> = {
6
- get(): Value;
7
- set(value: Value): void;
8
- initialized: true;
9
- };
10
- type UnsetPointer<Value> = {
11
- get(): void;
12
- set(value: Value): void;
13
- initialized: false;
14
- };
15
- type Pointer<Value> = SetPointer<Value> | UnsetPointer<Value>;
16
- export declare function withPointer<Value, ReturnValue>(cb: (pointer: Pointer<Value>) => ReturnValue): ReturnValue;
17
- export declare function handleChange(): void;
18
- export declare const effectScheduler: {
19
- queue(cb: (readline: InquirerReadline) => void | (() => void)): void;
20
- run(): void;
21
- clearAll(): void;
22
- };
23
- export {};
@@ -1,118 +0,0 @@
1
- "use strict";
2
- /* eslint @typescript-eslint/no-explicit-any: ["off"] */
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.effectScheduler = void 0;
5
- exports.withHooks = withHooks;
6
- exports.readline = readline;
7
- exports.withUpdates = withUpdates;
8
- exports.withPointer = withPointer;
9
- exports.handleChange = handleChange;
10
- const node_async_hooks_1 = require("node:async_hooks");
11
- const errors_ts_1 = require("./errors.js");
12
- const hookStorage = new node_async_hooks_1.AsyncLocalStorage();
13
- function createStore(rl) {
14
- const store = {
15
- rl,
16
- hooks: [],
17
- hooksCleanup: [],
18
- hooksEffect: [],
19
- index: 0,
20
- handleChange() { },
21
- };
22
- return store;
23
- }
24
- // Run callback in with the hook engine setup.
25
- function withHooks(rl, cb) {
26
- const store = createStore(rl);
27
- return hookStorage.run(store, () => {
28
- function cycle(render) {
29
- store.handleChange = () => {
30
- store.index = 0;
31
- render();
32
- };
33
- store.handleChange();
34
- }
35
- return cb(cycle);
36
- });
37
- }
38
- // Safe getStore utility that'll return the store or throw if undefined.
39
- function getStore() {
40
- const store = hookStorage.getStore();
41
- if (!store) {
42
- throw new errors_ts_1.HookError('[Inquirer] Hook functions can only be called from within a prompt');
43
- }
44
- return store;
45
- }
46
- function readline() {
47
- return getStore().rl;
48
- }
49
- // Merge state updates happening within the callback function to avoid multiple renders.
50
- function withUpdates(fn) {
51
- const wrapped = (...args) => {
52
- const store = getStore();
53
- let shouldUpdate = false;
54
- const oldHandleChange = store.handleChange;
55
- store.handleChange = () => {
56
- shouldUpdate = true;
57
- };
58
- const returnValue = fn(...args);
59
- if (shouldUpdate) {
60
- oldHandleChange();
61
- }
62
- store.handleChange = oldHandleChange;
63
- return returnValue;
64
- };
65
- return node_async_hooks_1.AsyncResource.bind(wrapped);
66
- }
67
- function withPointer(cb) {
68
- const store = getStore();
69
- const { index } = store;
70
- const pointer = {
71
- get() {
72
- return store.hooks[index];
73
- },
74
- set(value) {
75
- store.hooks[index] = value;
76
- },
77
- initialized: index in store.hooks,
78
- };
79
- const returnValue = cb(pointer);
80
- store.index++;
81
- return returnValue;
82
- }
83
- function handleChange() {
84
- getStore().handleChange();
85
- }
86
- exports.effectScheduler = {
87
- queue(cb) {
88
- const store = getStore();
89
- const { index } = store;
90
- store.hooksEffect.push(() => {
91
- store.hooksCleanup[index]?.();
92
- const cleanFn = cb(readline());
93
- if (cleanFn != null && typeof cleanFn !== 'function') {
94
- throw new errors_ts_1.ValidationError('useEffect return value must be a cleanup function or nothing.');
95
- }
96
- store.hooksCleanup[index] = cleanFn;
97
- });
98
- },
99
- run() {
100
- const store = getStore();
101
- withUpdates(() => {
102
- store.hooksEffect.forEach((effect) => {
103
- effect();
104
- });
105
- // Warning: Clean the hooks before exiting the `withUpdates` block.
106
- // Failure to do so means an updates would hit the same effects again.
107
- store.hooksEffect.length = 0;
108
- })();
109
- },
110
- clearAll() {
111
- const store = getStore();
112
- store.hooksCleanup.forEach((cleanFn) => {
113
- cleanFn?.();
114
- });
115
- store.hooksEffect.length = 0;
116
- store.hooksCleanup.length = 0;
117
- },
118
- };
@@ -1,12 +0,0 @@
1
- export type KeypressEvent = {
2
- name: string;
3
- ctrl: boolean;
4
- };
5
- export type Keybinding = 'emacs' | 'vim';
6
- export declare const isUpKey: (key: KeypressEvent, keybindings?: ReadonlyArray<Keybinding>) => boolean;
7
- export declare const isDownKey: (key: KeypressEvent, keybindings?: ReadonlyArray<Keybinding>) => boolean;
8
- export declare const isSpaceKey: (key: KeypressEvent) => boolean;
9
- export declare const isBackspaceKey: (key: KeypressEvent) => boolean;
10
- export declare const isTabKey: (key: KeypressEvent) => boolean;
11
- export declare const isNumberKey: (key: KeypressEvent) => boolean;
12
- export declare const isEnterKey: (key: KeypressEvent) => boolean;
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isEnterKey = exports.isNumberKey = exports.isTabKey = exports.isBackspaceKey = exports.isSpaceKey = exports.isDownKey = exports.isUpKey = void 0;
4
- const isUpKey = (key, keybindings = []) =>
5
- // The up key
6
- key.name === 'up' ||
7
- // Vim keybinding: hjkl keys map to left/down/up/right
8
- (keybindings.includes('vim') && key.name === 'k') ||
9
- // Emacs keybinding: Ctrl+P means "previous" in Emacs navigation conventions
10
- (keybindings.includes('emacs') && key.ctrl && key.name === 'p');
11
- exports.isUpKey = isUpKey;
12
- const isDownKey = (key, keybindings = []) =>
13
- // The down key
14
- key.name === 'down' ||
15
- // Vim keybinding: hjkl keys map to left/down/up/right
16
- (keybindings.includes('vim') && key.name === 'j') ||
17
- // Emacs keybinding: Ctrl+N means "next" in Emacs navigation conventions
18
- (keybindings.includes('emacs') && key.ctrl && key.name === 'n');
19
- exports.isDownKey = isDownKey;
20
- const isSpaceKey = (key) => key.name === 'space';
21
- exports.isSpaceKey = isSpaceKey;
22
- const isBackspaceKey = (key) => key.name === 'backspace';
23
- exports.isBackspaceKey = isBackspaceKey;
24
- const isTabKey = (key) => key.name === 'tab';
25
- exports.isTabKey = isTabKey;
26
- const isNumberKey = (key) => '1234567890'.includes(key.name);
27
- exports.isNumberKey = isNumberKey;
28
- const isEnterKey = (key) => key.name === 'enter' || key.name === 'return';
29
- exports.isEnterKey = isEnterKey;
@@ -1,3 +0,0 @@
1
- import type { Prettify, PartialDeep } from '@inquirer/type';
2
- import { type Theme } from './theme.ts';
3
- export declare function makeTheme<SpecificTheme extends object>(...themes: ReadonlyArray<undefined | PartialDeep<Theme<SpecificTheme>>>): Prettify<Theme<SpecificTheme>>;
@@ -1,33 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.makeTheme = makeTheme;
4
- const theme_ts_1 = require("./theme.js");
5
- function isPlainObject(value) {
6
- if (typeof value !== 'object' || value === null)
7
- return false;
8
- let proto = value;
9
- while (Object.getPrototypeOf(proto) !== null) {
10
- proto = Object.getPrototypeOf(proto);
11
- }
12
- return Object.getPrototypeOf(value) === proto;
13
- }
14
- function deepMerge(...objects) {
15
- const output = {};
16
- for (const obj of objects) {
17
- for (const [key, value] of Object.entries(obj)) {
18
- const prevValue = output[key];
19
- output[key] =
20
- isPlainObject(prevValue) && isPlainObject(value)
21
- ? deepMerge(prevValue, value)
22
- : value;
23
- }
24
- }
25
- return output;
26
- }
27
- function makeTheme(...themes) {
28
- const themesToMerge = [
29
- theme_ts_1.defaultTheme,
30
- ...themes.filter((theme) => theme != null),
31
- ];
32
- return deepMerge(...themesToMerge);
33
- }
@@ -1,16 +0,0 @@
1
- import type { Prettify } from '@inquirer/type';
2
- export declare function usePagination<T>({ items, active, renderItem, pageSize, loop, }: {
3
- items: ReadonlyArray<T>;
4
- /** The index of the active item. */
5
- active: number;
6
- /** Renders an item as part of a page. */
7
- renderItem: (layout: Prettify<{
8
- item: T;
9
- index: number;
10
- isActive: boolean;
11
- }>) => string;
12
- /** The size of the page. */
13
- pageSize: number;
14
- /** Allows creating an infinitely looping list. `true` if unspecified. */
15
- loop?: boolean;
16
- }): string;