From b56e43eee5be867541a9248e3eec6f8cc87f9f29 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Fri, 16 Dec 2022 11:51:10 -0500 Subject: [PATCH 1/5] Create emote-ssh-stable-commands.md Closes https://github.com/microsoft/vscode-remote-release/issues/7549 We got this request from an extension developer, in addition to just writing this doc we would have to commit to maintaining these functions. I think this is reasonable given how vital they are to the core functionality of the Remote-SSH extension. If this is carried through, comments should be added alongside the functions and the interface to alert future developers. --- emote-ssh-stable-commands.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 emote-ssh-stable-commands.md diff --git a/emote-ssh-stable-commands.md b/emote-ssh-stable-commands.md new file mode 100644 index 0000000..f948cba --- /dev/null +++ b/emote-ssh-stable-commands.md @@ -0,0 +1,34 @@ +The Remote-SSH extenions is a private repos that other extensions rely on for varying functionality. Below is a list of commands that we will do our best to keep stable similar to an API. These commands, now published externally here, will be maintained and changes will not be made without sufficent warning to allow for other dependent extensions to function correctly. + + +## Remote-SSH Stable Commands: + +#### `opensshremotes.openEmptyWindow` +- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_ +- this command is called with the command palette command `Connect to Host..` + +#### `opensshremotes.openEmptyWindowInCurrentWindow` +- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_ +- this command is called with the command palette command "Connect Current Window to Host..." + + +#### `opensshremotes.cleanRemoteServer` +- parameters: none +- this command is called with the command palette command "Kill VS Code Server on Host..." + +#### `opensshremotes.cleanDevBox` +- parameters: none +- this command is called with the command palette command "Uninstall VS Code Server from Host..." + +## Interface Definitions + +##### IOpenWindowsArgs Definition +``` +interface IOpenWindowsArgs { + host: string; + userName?: string; + port?: number; +} +``` + + From 67523e0064b9c987ecc01f3d6e647d8d0d969999 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 15 Feb 2023 15:05:34 -0800 Subject: [PATCH 2/5] Update emote-ssh-stable-commands.md --- emote-ssh-stable-commands.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/emote-ssh-stable-commands.md b/emote-ssh-stable-commands.md index f948cba..958a212 100644 --- a/emote-ssh-stable-commands.md +++ b/emote-ssh-stable-commands.md @@ -1,4 +1,5 @@ -The Remote-SSH extenions is a private repos that other extensions rely on for varying functionality. Below is a list of commands that we will do our best to keep stable similar to an API. These commands, now published externally here, will be maintained and changes will not be made without sufficent warning to allow for other dependent extensions to function correctly. +The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will do our best to keep stable like an API. These commands, now published externally here, will be maintained and changes will not be made without sufficient warning to allow for other dependent extensions to function correctly. + ## Remote-SSH Stable Commands: From b73087fbf55f05e531fecb3ae01bee8aa028f8c7 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Thu, 16 Feb 2023 16:17:01 -0800 Subject: [PATCH 3/5] add extra info --- emote-ssh-stable-commands.md | 35 --------------------------- remote-ssh-stable-commands.md | 45 +++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 35 deletions(-) delete mode 100644 emote-ssh-stable-commands.md create mode 100644 remote-ssh-stable-commands.md diff --git a/emote-ssh-stable-commands.md b/emote-ssh-stable-commands.md deleted file mode 100644 index 958a212..0000000 --- a/emote-ssh-stable-commands.md +++ /dev/null @@ -1,35 +0,0 @@ -The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will do our best to keep stable like an API. These commands, now published externally here, will be maintained and changes will not be made without sufficient warning to allow for other dependent extensions to function correctly. - - - -## Remote-SSH Stable Commands: - -#### `opensshremotes.openEmptyWindow` -- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_ -- this command is called with the command palette command `Connect to Host..` - -#### `opensshremotes.openEmptyWindowInCurrentWindow` -- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_ -- this command is called with the command palette command "Connect Current Window to Host..." - - -#### `opensshremotes.cleanRemoteServer` -- parameters: none -- this command is called with the command palette command "Kill VS Code Server on Host..." - -#### `opensshremotes.cleanDevBox` -- parameters: none -- this command is called with the command palette command "Uninstall VS Code Server from Host..." - -## Interface Definitions - -##### IOpenWindowsArgs Definition -``` -interface IOpenWindowsArgs { - host: string; - userName?: string; - port?: number; -} -``` - - diff --git a/remote-ssh-stable-commands.md b/remote-ssh-stable-commands.md new file mode 100644 index 0000000..f9641a3 --- /dev/null +++ b/remote-ssh-stable-commands.md @@ -0,0 +1,45 @@ +The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained and changes will not be made without sufficient warning to allow for other dependent extensions to function correctly. + + + +## Remote-SSH Stable Commands: + +`opensshremotes.openEmptyWindow` - Opens a new window and attempts to connect to the remote provided through the `args` +- parameters: [`(args?: IOpenWindowsArgs)`](#IOpenWindowsArgs-Definition) + +### My Multi Word Header +- returns: none +- this command is called with the command palette command "Connect to Host.." + +`opensshremotes.openEmptyWindowInCurrentWindow` - Attempts to connect to the remote provided through the `args` argument but in the current VS Code window +- parameters: [`(args?: IOpenWindowsArgs)`](#IOpenWindowsArgs-Definition) +- returns: none +- this command is called with the command palette command "Connect Current Window to Host..." + + +`opensshremotes.cleanRemoteServer` - This command shuts down and uninstall the VS Code server on the remote. A complete uninstall includes removing the entire folder with the server data. This server data includes logs, the server data needed for future reconnection, any unsaved progress of files on the remote machine, and ... This command causes the [`interactivelyPickSshHost`](#Interactively-Pick-Ssh-Host) to engage, see below for details on how this picker works. +- parameters: none +- returns: none +- this command is called with the command palette command "Kill VS Code Server on Host..." + +`opensshremotes.cleanDevBox` - This command uninstalls the Vs Code server on the remote. This command causes the [`interactivelyPickSshHost`](#Interactively-Pick-Ssh-Host) to engage, see below for details on how this picker works. +- parameters: none +- returns: none +- this command is called with the command palette command "Uninstall VS Code Server from Host..." + + + +## Interface Definitions + +##### IOpenWindowsArgs Definition +``` +interface IOpenWindowsArgs { + host: string; + userName?: string; + port?: number; +} +``` +##### Interactively Pick Ssh Host + +`interactivelyPickSshHost` This is an additional function which is called by both `opensshremotes.cleanRemoteServer` and `opensshremotes.cleanDevBox`. This command causes an interactive popup to appear where the user will then select from their list of remotes which one they want to kill the server on. The remotes displayed in the interactive popup are collected from parsing the ssh config file and therefore all remotes listed in the ssh config will be displayed as options. + From 77407e2860e30539315ee7659f6622e44fb87309 Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Wed, 15 Mar 2023 08:09:11 -0700 Subject: [PATCH 4/5] remove unnecessary line --- remote-ssh-stable-commands.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/remote-ssh-stable-commands.md b/remote-ssh-stable-commands.md index f9641a3..9b5d5c1 100644 --- a/remote-ssh-stable-commands.md +++ b/remote-ssh-stable-commands.md @@ -6,8 +6,6 @@ The Remote-SSH extension is a private repo that other extensions rely on for var `opensshremotes.openEmptyWindow` - Opens a new window and attempts to connect to the remote provided through the `args` - parameters: [`(args?: IOpenWindowsArgs)`](#IOpenWindowsArgs-Definition) - -### My Multi Word Header - returns: none - this command is called with the command palette command "Connect to Host.." From e00872d3aeaee0bdb5ccd09b3cfaf2b830b90dda Mon Sep 17 00:00:00 2001 From: Eleanor Boyd Date: Fri, 28 Apr 2023 11:01:02 -0700 Subject: [PATCH 5/5] Update remote-ssh-stable-commands.md --- remote-ssh-stable-commands.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/remote-ssh-stable-commands.md b/remote-ssh-stable-commands.md index 9b5d5c1..7be68a6 100644 --- a/remote-ssh-stable-commands.md +++ b/remote-ssh-stable-commands.md @@ -1,4 +1,4 @@ -The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained and changes will not be made without sufficient warning to allow for other dependent extensions to function correctly. +The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained. @@ -14,19 +14,6 @@ The Remote-SSH extension is a private repo that other extensions rely on for var - returns: none - this command is called with the command palette command "Connect Current Window to Host..." - -`opensshremotes.cleanRemoteServer` - This command shuts down and uninstall the VS Code server on the remote. A complete uninstall includes removing the entire folder with the server data. This server data includes logs, the server data needed for future reconnection, any unsaved progress of files on the remote machine, and ... This command causes the [`interactivelyPickSshHost`](#Interactively-Pick-Ssh-Host) to engage, see below for details on how this picker works. -- parameters: none -- returns: none -- this command is called with the command palette command "Kill VS Code Server on Host..." - -`opensshremotes.cleanDevBox` - This command uninstalls the Vs Code server on the remote. This command causes the [`interactivelyPickSshHost`](#Interactively-Pick-Ssh-Host) to engage, see below for details on how this picker works. -- parameters: none -- returns: none -- this command is called with the command palette command "Uninstall VS Code Server from Host..." - - - ## Interface Definitions ##### IOpenWindowsArgs Definition @@ -37,7 +24,4 @@ interface IOpenWindowsArgs { port?: number; } ``` -##### Interactively Pick Ssh Host - -`interactivelyPickSshHost` This is an additional function which is called by both `opensshremotes.cleanRemoteServer` and `opensshremotes.cleanDevBox`. This command causes an interactive popup to appear where the user will then select from their list of remotes which one they want to kill the server on. The remotes displayed in the interactive popup are collected from parsing the ssh config file and therefore all remotes listed in the ssh config will be displayed as options.