Remove any from terminal in server #276272
Draft
+50
−52
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances type safety across the terminal subsystem by replacing any types with more appropriate TypeScript types (unknown, proper generics, and specific type definitions). The changes enable the removal of several files from the eslint ignore list for the @typescript-eslint/no-explicit-any rule.
Key changes:
- Replaced
anywithunknownfor untyped data in IPC channels and command execution contexts - Added default type parameter to
IProcessProperty<T>interface to make it more ergonomic - Introduced
ITraceRpcArgsinterface and improvedtraceRpcdecorator type safety with proper generic constraints - Updated event emitter types throughout the terminal codebase to remove explicit
anytype parameters
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| eslint.config.js | Removed 6 terminal-related files from @typescript-eslint/no-explicit-any exception list |
| src/vs/platform/terminal/common/terminal.ts | Added default type parameter to IProcessProperty<T> and removed any from event types |
| src/vs/platform/terminal/node/ptyHostService.ts | Removed any from onDidChangeProperty event type |
| src/vs/platform/terminal/node/ptyService.ts | Introduced ITraceRpcArgs interface, improved traceRpc decorator signature, and updated event/map types |
| src/vs/platform/terminal/node/terminalProcess.ts | Removed any from event emitter type and updated eslint disable comment with GitHub issue reference |
| src/vs/platform/terminal/node/windowsShellHelper.ts | Changed traverseTree parameter from any to proper WindowsProcessTreeType.IProcessTreeNode | undefined |
| src/vs/server/node/remoteTerminalChannel.ts | Replaced any with unknown throughout, added generic type parameter to listen method with type casts |
| src/vs/workbench/contrib/terminal/browser/terminalProcessManager.ts | Added type assertion to properly type the property value access |
| case RemoteTerminalChannelEvent.OnPtyHostUnresponsiveEvent: return (this._ptyHostService.onPtyHostUnresponsive || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnPtyHostResponsiveEvent: return (this._ptyHostService.onPtyHostResponsive || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnPtyHostRequestResolveVariablesEvent: return (this._ptyHostService.onPtyHostRequestResolveVariables || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return (this._ptyHostService.onProcessData) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onProcessData as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return (this._ptyHostService.onProcessData) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return this._ptyHostService.onProcessData as Event<T>; |
| case RemoteTerminalChannelEvent.OnPtyHostResponsiveEvent: return (this._ptyHostService.onPtyHostResponsive || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnPtyHostRequestResolveVariablesEvent: return (this._ptyHostService.onPtyHostRequestResolveVariables || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return (this._ptyHostService.onProcessData) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return (this._ptyHostService.onProcessReady) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onProcessReady as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return (this._ptyHostService.onProcessReady) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return this._ptyHostService.onProcessReady as Event<T>; |
| case RemoteTerminalChannelEvent.OnPtyHostRequestResolveVariablesEvent: return (this._ptyHostService.onPtyHostRequestResolveVariables || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return (this._ptyHostService.onProcessData) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return (this._ptyHostService.onProcessReady) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return (this._ptyHostService.onProcessExit) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onProcessExit as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return (this._ptyHostService.onProcessExit) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return this._ptyHostService.onProcessExit as Event<T>; |
| case RemoteTerminalChannelEvent.OnProcessDataEvent: return (this._ptyHostService.onProcessData) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return (this._ptyHostService.onProcessReady) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return (this._ptyHostService.onProcessExit) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReplayEvent: return (this._ptyHostService.onProcessReplay) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onProcessReplay as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnProcessReplayEvent: return (this._ptyHostService.onProcessReplay) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnProcessReplayEvent: return this._ptyHostService.onProcessReplay as Event<T>; |
| case RemoteTerminalChannelEvent.OnProcessReadyEvent: return (this._ptyHostService.onProcessReady) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return (this._ptyHostService.onProcessExit) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReplayEvent: return (this._ptyHostService.onProcessReplay) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessOrphanQuestion: return (this._ptyHostService.onProcessOrphanQuestion) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onProcessOrphanQuestion as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnProcessOrphanQuestion: return (this._ptyHostService.onProcessOrphanQuestion) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnProcessOrphanQuestion: return this._ptyHostService.onProcessOrphanQuestion as Event<T>; |
| case RemoteTerminalChannelEvent.OnProcessExitEvent: return (this._ptyHostService.onProcessExit) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessReplayEvent: return (this._ptyHostService.onProcessReplay) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnProcessOrphanQuestion: return (this._ptyHostService.onProcessOrphanQuestion) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnExecuteCommand: return (this.onExecuteCommand) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this.onExecuteCommand as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnExecuteCommand: return (this.onExecuteCommand) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnExecuteCommand: return this.onExecuteCommand as Event<T>; |
| case RemoteTerminalChannelEvent.OnProcessOrphanQuestion: return (this._ptyHostService.onProcessOrphanQuestion) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnExecuteCommand: return (this.onExecuteCommand) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnDidRequestDetach: return (this._ptyHostService.onDidRequestDetach || Event.None) as Event<T>; | ||
| case RemoteTerminalChannelEvent.OnDidChangeProperty: return (this._ptyHostService.onDidChangeProperty) as Event<T>; |
There was a problem hiding this comment.
Unnecessary parentheses in the type cast. Since there's no || Event.None fallback here, the parentheses can be removed: this._ptyHostService.onDidChangeProperty as Event<T>
Suggested change
| case RemoteTerminalChannelEvent.OnDidChangeProperty: return (this._ptyHostService.onDidChangeProperty) as Event<T>; | |
| case RemoteTerminalChannelEvent.OnDidChangeProperty: return this._ptyHostService.onDidChangeProperty as Event<T>; |
| } | ||
|
|
||
| listen(_: any, event: RemoteTerminalChannelEvent, arg: any): Event<any> { | ||
| listen<T extends unknown>(_: unknown, event: RemoteTerminalChannelEvent, _arg: unknown): Event<T> { |
There was a problem hiding this comment.
The generic constraint T extends unknown is redundant since all types extend unknown by definition. This can be simplified to just <T>.
Suggested change
| listen<T extends unknown>(_: unknown, event: RemoteTerminalChannelEvent, _arg: unknown): Event<T> { | |
| listen<T>(_: unknown, event: RemoteTerminalChannelEvent, _arg: unknown): Event<T> { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Part of #274723
Merge first: