Skip to content

Rename "Integrated Console" to "Extension Terminal" #4090

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

Merged
merged 2 commits into from
Jul 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ to get more details on how to use the extension on these platforms.
- Run selected selection of PowerShell code using <kbd>F8</kbd>
- Launch online help for the symbol under the cursor using <kbd>Ctrl</kbd>+<kbd>F1</kbd>
- Local script debugging
- Integrated console support
- Extension Terminal support
- PowerShell ISE color theme

## Installing the Extension
Expand Down
2 changes: 1 addition & 1 deletion docs/azure_data_studio/README_FOR_MARKETPLACE.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ to get more details on how to use the extension on these platforms.
- Run selected selection of PowerShell code using <kbd>F8</kbd>
- Launch online help for the symbol under the cursor using <kbd>Ctrl</kbd>+<kbd>F1</kbd>
- Local script debugging
- Integrated console support
- Extension Terminal support
- PowerShell ISE color theme

## Installing the Extension
Expand Down
12 changes: 6 additions & 6 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ message starts with `[PSScriptAnalyzer]` or if you are getting faulty script dia
## Completions aren't appearing

First, please ensure that the extension itself has properly started. Do this by opening
the PowerShell Integrated Console and checking the value of the variable `$psEditor`,
the PowerShell Extension Terminal and checking the value of the variable `$psEditor`,
it should return a version and other fields. If it does not, you're probably in a
different "PowerShell" terminal in VS Code, and not the extension's integrated console.
different "PowerShell" terminal in VS Code, and not the PowerShell Extension Terminal.
So please open a bug about your extension failing to start instead.

If the extension _is_ started and the PSIC functional, completions should appear! Please
If the extension _is_ started and the Extension Terminal functional, completions should appear! Please
double-check that your `editor.suggest.showFunctions` VS Code setting is `true`, as
setting it to `false` _will_ disable completions (from all extensions). You may also want
to check other related settings under "Text Editor -> Suggestions" in VS Code.
Expand Down Expand Up @@ -308,7 +308,7 @@ these messages. To do this:

### Visual Studio Code version

[Your VS Code version][] can be obtained from the Integrated Console or any terminal:
[Your VS Code version][] can be obtained from the Extension Terminal or any terminal:

```powershell
code --version
Expand Down Expand Up @@ -353,7 +353,7 @@ Extensions` and list your extensions.

### Editor Services version

To get the [PowerShell Editor Services][] version, in the Integrated Console, enter:
To get the [PowerShell Editor Services][] version, in the Extension Terminal, enter:

```powershell
> $psEditor.EditorServicesVersion
Expand All @@ -364,7 +364,7 @@ Major Minor Build Revision

### PowerShell version table

You can get [your PowerShell version table][] from the Integrated Console through the
You can get [your PowerShell version table][] from the Extension Terminal through the
variable `$PSVersionTable`:

```powershell
Expand Down
18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@
},
{
"command": "PowerShell.ShowSessionConsole",
"title": "Show Integrated Console",
"title": "Show Extension Terminal",
"category": "PowerShell"
},
{
Expand Down Expand Up @@ -447,7 +447,7 @@
},
{
"label": "PowerShell: Interactive Session",
"description": "Debug commands executed from the Integrated Console",
"description": "Debug commands executed from the Extension Terminal",
"body": {
"name": "PowerShell Interactive Session",
"type": "PowerShell",
Expand Down Expand Up @@ -498,7 +498,7 @@
},
"createTemporaryIntegratedConsole": {
"type": "boolean",
"description": "Determines whether a temporary PowerShell Integrated Console is created for each debugging session, useful for debugging PowerShell classes and binary modules. Overrides the user setting 'powershell.debugging.createTemporaryIntegratedConsole'.",
"description": "Determines whether a temporary PowerShell Extension Terminal is created for each debugging session, useful for debugging PowerShell classes and binary modules. Overrides the user setting 'powershell.debugging.createTemporaryIntegratedConsole'.",
"default": false
}
}
Expand Down Expand Up @@ -597,7 +597,7 @@
"powershell.startAutomatically": {
"type": "boolean",
"default": true,
"description": "Starts PowerShell extension features automatically when a PowerShell file opens. If false, to start the extension, use the 'PowerShell: Restart Current Session' command. IntelliSense, code navigation, integrated console, code formatting, and other features are not enabled until the extension starts."
"description": "Starts PowerShell extension features automatically when a PowerShell file opens. If false, to start the extension, use the 'PowerShell: Restart Current Session' command. IntelliSense, code navigation, Extension Terminal, code formatting, and other features are not enabled until the extension starts."
},
"powershell.useX86Host": {
"type": "boolean",
Expand Down Expand Up @@ -628,7 +628,7 @@
"powershell.cwd": {
"type": "string",
"default": null,
"description": "An explicit start path where the Powershell Integrated Console will be launched. Both the PowerShell process and the shell's location will be set to this directory. Predefined variables can be used (i.e. ${fileDirname} to use the current opened file's directory)."
"description": "An explicit start path where the PowerShell Extension Terminal will be launched. Both the PowerShell process and the shell's location will be set to this directory. Predefined variables can be used (i.e. ${fileDirname} to use the current opened file's directory)."
},
"powershell.scriptAnalysis.enable": {
"type": "boolean",
Expand Down Expand Up @@ -761,7 +761,7 @@
"powershell.integratedConsole.showOnStartup": {
"type": "boolean",
"default": true,
"description": "Shows the integrated console when the PowerShell extension is initialized."
"description": "Shows the Extension Terminal when the PowerShell extension is initialized."
},
"powershell.integratedConsole.focusConsoleOnExecute": {
"type": "boolean",
Expand All @@ -771,7 +771,7 @@
"powershell.integratedConsole.useLegacyReadLine": {
"type": "boolean",
"default": false,
"description": "Falls back to the legacy (lightweight) ReadLine experience. This will disable the use of PSReadLine in the PowerShell Integrated Console."
"description": "Falls back to the legacy ReadLine experience. This will disable the use of PSReadLine in the PowerShell Extension Terminal."
},
"powershell.integratedConsole.forceClearScrollbackBuffer": {
"type": "boolean",
Expand All @@ -780,12 +780,12 @@
"powershell.integratedConsole.suppressStartupBanner": {
"type": "boolean",
"default": false,
"description": "Do not show the Powershell Integrated Console banner on launch"
"description": "Do not show the Powershell Extension Terminal banner on launch"
},
"powershell.debugging.createTemporaryIntegratedConsole": {
"type": "boolean",
"default": false,
"description": "Determines whether a temporary PowerShell Integrated Console is created for each debugging session, useful for debugging PowerShell classes and binary modules."
"description": "Determines whether a temporary PowerShell Extension Terminal is created for each debugging session. Useful for debugging PowerShell classes and binary modules."
},
"powershell.developer.bundledModulesPath": {
"type": "string",
Expand Down
6 changes: 3 additions & 3 deletions src/features/Console.ts
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ export class ConsoleFeature extends LanguageClientConsumer {
vscode.commands.registerCommand("PowerShell.RunSelection", async () => {

if (vscode.window.activeTerminal &&
vscode.window.activeTerminal.name !== "PowerShell Integrated Console") {
this.log.write("PSIC is not active terminal. Running in active terminal using 'runSelectedText'");
vscode.window.activeTerminal.name !== "PowerShell Extension") {
this.log.write("PowerShell Extension Terminal is not active! Running in current terminal using 'runSelectedText'");
await vscode.commands.executeCommand("workbench.action.terminal.runSelectedText");

// We need to honor the focusConsoleOnExecute setting here too. However, the boolean that `show`
Expand Down Expand Up @@ -236,7 +236,7 @@ export class ConsoleFeature extends LanguageClientConsumer {
expression: editor.document.getText(selectionRange),
});

// Show the integrated console if it isn't already visible and
// Show the Extension Terminal if it isn't already visible and
// scroll terminal to bottom so new output is visible
await vscode.commands.executeCommand("PowerShell.ShowSessionConsole", true);
await vscode.commands.executeCommand("workbench.action.terminal.scrollToBottom");
Expand Down
6 changes: 3 additions & 3 deletions src/features/DebugSession.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
{
id: DebugConfig.InteractiveSession,
label: "Interactive Session",
description: "Debug commands executed from the Integrated Console",
description: "Debug commands executed from the PowerShell Extension Terminal",
},
{
id: DebugConfig.AttachHostProcess,
Expand Down Expand Up @@ -230,7 +230,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
: currentDocument.fileName;

} else {
// If the non-temp integrated console is being used, default to the current working dir.
// If the non-temp Extension Terminal is being used, default to the current working dir.
config.cwd = "";
}
}
Expand Down Expand Up @@ -450,7 +450,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
// Start with the current PowerShell process in the list.
const items: IProcessItem[] = [{
label: "Current",
description: "The current PowerShell Integrated Console process.",
description: "The current PowerShell Extension process.",
pid: "current",
}];
for (const p in hostProcesses) {
Expand Down
4 changes: 2 additions & 2 deletions src/features/UpdatePowerShell.ts
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ export async function InvokePowerShellUpdateCheck(
await streamPipeline(res.body, fs.createWriteStream(msiDownloadPath));
});

// Stop the Integrated Console session because Windows likes to hold on to files.
// Stop the session because Windows likes to hold on to files.
sessionManager.stop();

// Close all terminals with the name "pwsh" in the current VS Code session.
Expand All @@ -165,7 +165,7 @@ export async function InvokePowerShellUpdateCheck(
const msi = spawn("msiexec", ["/i", msiDownloadPath]);

msi.on("close", async () => {
// Now that the MSI is finished, start the Integrated Console session.
// Now that the MSI is finished, restart the session.
await sessionManager.start();
fs.unlinkSync(msiDownloadPath);
});
Expand Down
2 changes: 1 addition & 1 deletion src/process.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export class PowerShellProcess {
this.log.write(`${pwshName} started.`);

if (this.sessionSettings.integratedConsole.showOnStartup) {
// We still need to run this to set the active terminal to the Integrated Console.
// We still need to run this to set the active terminal to the extension terminal.
this.consoleTerminal.show(true);
}

Expand Down
20 changes: 12 additions & 8 deletions src/session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,13 @@ export class SessionManager implements Middleware {
if (this.sessionSettings.integratedConsole.suppressStartupBanner) {
this.editorServicesArgs += "-StartupBanner '' ";
} else {
const startupBanner = `=====> ${this.HostName} Integrated Console v${this.HostVersion} <=====
const startupBanner = `${this.HostName} Extension v${this.HostVersion}
Copyright (c) Microsoft Corporation.

https://aka.ms/vscode-powershell
Type 'help' to get help.
`;
this.editorServicesArgs += `-StartupBanner '${startupBanner}' `;
this.editorServicesArgs += `-StartupBanner "${startupBanner}" `;
}

if (this.sessionSettings.developer.editorServicesWaitForDebugger) {
Expand Down Expand Up @@ -291,7 +295,7 @@ export class SessionManager implements Middleware {

public createDebugSessionProcess(sessionSettings: Settings.ISettings): PowerShellProcess {

// NOTE: We only support one temporary integrated console at a time. To
// NOTE: We only support one temporary Extension Terminal at a time. To
// support more, we need to track each separately, and tie the session
// for the event handler to the right process (and dispose of the event
// handler when the process is disposed).
Expand All @@ -304,14 +308,14 @@ export class SessionManager implements Middleware {
new PowerShellProcess(
this.PowerShellExeDetails.exePath,
this.bundledModulesPath,
"[TEMP] PowerShell Integrated Console",
"[TEMP] PowerShell Extension",
this.log,
this.editorServicesArgs + "-DebugServiceOnly ",
this.getNewSessionFilePath(),
sessionSettings);

// Similar to the regular integrated console, we need to send a key
// press to the process spawned for temporary integrated consoles when
// Similar to the regular Extension Terminal, we need to send a key
// press to the process spawned for temporary Extension Terminals when
// the server requests a cancellation os Console.ReadKey.
this.debugEventHandler = vscode.debug.onDidReceiveDebugSessionCustomEvent(
e => {
Expand Down Expand Up @@ -477,7 +481,7 @@ export class SessionManager implements Middleware {
new PowerShellProcess(
this.PowerShellExeDetails.exePath,
this.bundledModulesPath,
"PowerShell Integrated Console",
"PowerShell Extension",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explicitly no "Terminal" addendum because this is what's displayed in the list of terminals.

this.log,
this.editorServicesArgs,
this.getNewSessionFilePath(),
Expand Down Expand Up @@ -532,7 +536,7 @@ export class SessionManager implements Middleware {

private async promptForRestart() {
const response: string = await vscode.window.showErrorMessage(
"The PowerShell Integrated Console (PSIC) has stopped, would you like to restart it? (IntelliSense will not work unless the PSIC is active and unblocked.)",
"The PowerShell Extension Terminal has stopped, would you like to restart it? IntelliSense and other features will not work without it!",
"Yes", "No");

if (response === "Yes") {
Expand Down
2 changes: 1 addition & 1 deletion tools/ReleaseTools.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function Get-Bullets {
'Area-Documentation' = '📖'
'Area-Engine' = '🚂'
'Area-Folding' = '📚'
'Area-Integrated Console' = '📟'
'Area-Extension Terminal' = '📟'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renamed the labels on GitHub too.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You think of everything!

'Area-IntelliSense' = '🧠'
'Area-Logging' = '💭'
'Area-Pester' = '🐢'
Expand Down