-
Notifications
You must be signed in to change notification settings - Fork 529
fix(node): make readline Interface and Readline classes no-op stubs #6016
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
petebacondarwin
wants to merge
2
commits into
main
Choose a base branch
from
pbacondarwin/readline-interface-no-throw
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,36 +24,35 @@ | |
| // USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
|
||
| import { EventEmitter } from 'node-internal:events'; | ||
| import { ERR_METHOD_NOT_IMPLEMENTED } from 'node-internal:internal_errors'; | ||
| import type { Abortable } from 'node:events'; | ||
| import type ReadlineType from 'node:readline/promises'; | ||
| import type { CursorPos } from 'node:readline'; | ||
| import type { Direction } from 'readline'; | ||
| import type { CursorPos, Direction } from 'node:readline'; | ||
|
|
||
| // This class provides a no-op stub implementation that matches unenv's behavior. | ||
| // See: https://github.com/unjs/unenv/blob/main/src/runtime/node/internal/readline/promises/interface.ts | ||
| // Methods are no-ops or return sensible defaults rather than throwing errors, | ||
| // which allows code that depends on readline to work without crashing. | ||
| export class Interface extends EventEmitter implements ReadlineType.Interface { | ||
| terminal: boolean; | ||
| line: string; | ||
| cursor: number; | ||
|
|
||
| constructor() { | ||
| super(); | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface'); | ||
| } | ||
| terminal = false; | ||
| line = ''; | ||
| cursor = 0; | ||
|
|
||
| getPrompt(): string { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.getPrompt'); | ||
| return ''; | ||
| } | ||
|
|
||
| setPrompt(_prompt: string): void { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.setPrompt'); | ||
| // No-op | ||
| } | ||
|
|
||
| prompt(_preserveCursor?: boolean): void { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.prompt'); | ||
| // No-op | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/require-await | ||
| async question(_query: unknown, _options?: unknown): Promise<string> { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.question'); | ||
| question(query: string): Promise<string>; | ||
| question(query: string, options: Abortable): Promise<string>; | ||
| question(_query: string, _options?: Abortable): Promise<string> { | ||
| return Promise.resolve(''); | ||
| } | ||
|
|
||
| pause(): this { | ||
|
|
@@ -65,15 +64,18 @@ export class Interface extends EventEmitter implements ReadlineType.Interface { | |
| } | ||
|
|
||
| close(): void { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.close'); | ||
| // No-op | ||
| } | ||
|
|
||
| write(_data: unknown, _key?: unknown): void { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.write'); | ||
| // No-op | ||
| } | ||
|
|
||
| getCursorPos(): CursorPos { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.getCursorPos'); | ||
| return { | ||
| rows: 0, | ||
| cols: 0, | ||
| }; | ||
| } | ||
|
|
||
| [Symbol.dispose](): void { | ||
|
|
@@ -85,17 +87,16 @@ export class Interface extends EventEmitter implements ReadlineType.Interface { | |
| this.close(); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| [Symbol.asyncIterator](): NodeJS.AsyncIterator<string, undefined, any> { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface[Symbol.asyncIterator]'); | ||
| // Yield a single empty string so that `for await...of` loops complete | ||
| // immediately without blocking, consistent with no-op stub behavior. | ||
| async *[Symbol.asyncIterator](): NodeJS.AsyncIterator<string> { | ||
| yield ''; | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add a small comment? |
||
| } | ||
| } | ||
|
|
||
| // This class provides a no-op stub implementation that matches unenv's behavior. | ||
| // See: https://github.com/unjs/unenv/blob/main/src/runtime/node/internal/readline/promises/readline.ts | ||
| export class Readline implements ReadlineType.Readline { | ||
| constructor() { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Readline'); | ||
| } | ||
|
|
||
| clearLine(_dir: Direction): this { | ||
| return this; | ||
| } | ||
|
|
@@ -104,9 +105,8 @@ export class Readline implements ReadlineType.Readline { | |
| return this; | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/require-await | ||
| async commit(): Promise<void> { | ||
| throw new ERR_METHOD_NOT_IMPLEMENTED('Interface.commit'); | ||
| commit(): Promise<void> { | ||
| return Promise.resolve(); | ||
| } | ||
|
|
||
| cursorTo(_x: number, _y?: number): this { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a comment to why we are returning this?