workbench.action.terminal.rename should accept name as an argument

[vintprox]

Currently, workbench.action.terminal.rename command doesn't accept any argument. I wanted to make macros that renames current terminal after performing some other actions.

At the moment, it requires user prompt interaction.

vscode/src/vs/workbench/contrib/terminal/browser/terminalActions.ts

Lines 1053 to 1066 in f0faef0

	public run(entry?: TerminalEntry): Promise<any> {
	const terminalInstance = entry ? entry.instance : this.terminalService.getActiveInstance();
	if (!terminalInstance) {
	return Promise.resolve(undefined);
	}
	return this.quickInputService.input({
	value: terminalInstance.title,
	prompt: nls.localize('workbench.action.terminal.rename.prompt', "Enter terminal name"),
	}).then(name => {
	if (name) {
	terminalInstance.setTitle(name, TitleEventSource.Api);
	}
	});
	}

[vscodebot]

(Experimental duplicate detection)
Thanks for submitting this issue. Please also check if it is already covered by an existing one, like:

• workbench.action.terminal.rename does not return focus to element that was focused when command was issued (#53294)

[Tyriar]

Have you considered using an extension like https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-terminals for this?

[vintprox]

@Tyriar no, I am using custom fork of macros, which is addressed here. I needed some delays between sending terminal sequences, as provided in this example: geddski/macros#9 (comment)

Fortunatelly, it solves issues with providing some dynamic input at right time like passphrase (because I couldn't establish SSH without passphrase prompt, unluckily, so I have to use bad technique atm), running console program on remote computer after SSH login, REPL commands to 3DX MQL.

Thank you for advising fabiospampinato.vscode-terminals extension! I will try it tomorrow on the subject of having right delay between sequences (to replicate macros I've made).

[vintprox]

I think I know how to make rename command have simple title argument, but it takes a time to contribute here, hehe.

[vijayksingh]

@vintprox @Tyriar I would like to help you guys out, can you explain me a little bit, what changes exactly needs to be done.

[Tyriar]

@perceptron007 right now the rename command is defined here:

vscode/src/vs/workbench/contrib/terminal/browser/terminalActions.ts

Lines 1039 to 1067 in 8a80677

	export class RenameTerminalAction extends Action {
	public static readonly ID = TERMINAL_COMMAND_ID.RENAME;
	public static readonly LABEL = nls.localize('workbench.action.terminal.rename', "Rename");
	constructor(
	id: string, label: string,
	@IQuickOpenService protected quickOpenService: IQuickOpenService,
	@IQuickInputService protected quickInputService: IQuickInputService,
	@ITerminalService protected terminalService: ITerminalService
	) {
	super(id, label);
	}
	public run(entry?: TerminalEntry): Promise<any> {
	const terminalInstance = entry ? entry.instance : this.terminalService.getActiveInstance();
	if (!terminalInstance) {
	return Promise.resolve(undefined);
	}
	return this.quickInputService.input({
	value: terminalInstance.title,
	prompt: nls.localize('workbench.action.terminal.rename.prompt', "Enter terminal name"),
	}).then(name => {
	if (name) {
	terminalInstance.setTitle(name, TitleEventSource.Api);
	}
	});
	}
	}

I think we need to convert it into a Command to accept an arg like this one:

vscode/src/vs/workbench/contrib/terminal/browser/terminalActions.ts

Lines 301 to 325 in 8a80677

	export class CreateNewWithCwdTerminalCommand extends Command {
	public static readonly ID = TERMINAL_COMMAND_ID.NEW_WITH_CWD;
	public static readonly LABEL = nls.localize('workbench.action.terminal.newWithCwd', "Create New Integrated Terminal Starting in a Custom Working Directory");
	public static readonly CWD_ARG_LABEL = nls.localize('workbench.action.terminal.newWithCwd.cwd', "The directory to start the terminal at");
	public runCommand(accessor: ServicesAccessor, args: { cwd: string } | undefined): Promise<void> {
	const terminalService = accessor.get(ITerminalService);
	const configurationResolverService = accessor.get(IConfigurationResolverService);
	const workspaceContextService = accessor.get(IWorkspaceContextService);
	const historyService = accessor.get(IHistoryService);
	const activeWorkspaceRootUri = historyService.getLastActiveWorkspaceRoot(Schemas.file);
	const lastActiveWorkspaceRoot = activeWorkspaceRootUri ? withNullAsUndefined(workspaceContextService.getWorkspaceFolder(activeWorkspaceRootUri)) : undefined;
	let cwd: string | undefined;
	if (args && args.cwd) {
	cwd = configurationResolverService.resolve(lastActiveWorkspaceRoot, args.cwd);
	}
	const instance = terminalService.createTerminal({ cwd });
	if (!instance) {
	return Promise.resolve(undefined);
	}
	terminalService.setActiveInstance(instance);
	return terminalService.showPanel(true);
	}
	}

[vintprox]

@perceptron007 Sorry for late response. I made some changes to code, please review it and cover with some test if needed. I'm not ready to make pull request yet, so I derive it to you, guys.

[Tyriar]

@vintprox I would have thought you'd need to convert it to a Command, does passing in the arg in a keybinding work there?

We want this keybinding to be able to rename the terminal by executing it:

{
  "key": "cmd+shift+h",
  "command": "workbench.action.terminal.rename",
  "args": {
    "title": "My term"
  }
}

Also you can get intellisense for title, see the workbench.action.terminal.newWithCwd command for how to do this:

[vintprox]

@Tyriar
Oh, didn't think about that. How do I deal with entry?: TerminalEntry though?
Made another commit for review that excludes possibly ambiguous argument entry.

[Tyriar]

@vintprox hmm, we may just need to make a new command just like newWithCwd I guess renameActiveTerminal? You're pretty close, you can put a PR out as it will be easier to give feedback there.

[vintprox]

You are right! I completely forgot what pull requests are for here.

[sksaifuddin]

Hello @vintprox did you create the PR ? is this issue resolved ?

[vintprox]

Uh-oh, I'm kind of busy right now and cannot find a right time. You can make it, if you want to solve the issue!

[petevdp]

Hey, if this issue is open I'd like to pick it up!

[vintprox]

Of course, why not, proceed! @petevdp
You can look into my diffs for clues.