Provide a command to create a new untitled file with a specific language set

[karrtikr]

VSCode provides workbench.action.files.newUntitledFile using which we can create a new untitled file, which then instructs to set a particular language:

We're working on our walkthrough in Python extension which directly offers to create a new python file, it would be great if the command supports an argument which accepts the language to create the file for.

cc/ @lramos15

Unfortunately we cannot use VSCode APIs to accomplish this as extension is not guaranteed to be activated when the walkthrough is opened, so the command isn't available when the button is clicked, see:

[bpasero]

Can you not use this API?

vscode/src/vscode-dts/vscode.d.ts

Line 12290 in 96ca512

export function setTextDocumentLanguage(document: TextDocument, languageId: string): Thenable<TextDocument>;

[karrtikr]

Extension takes some while to activate, so any commands we register ourselves using the API aren't available at startup.

[bpasero]

I am a bit confused, how can there be a python specific welcome command without the python extension?

[bpasero]

I think such a change would be relatively easy, similar to the view type argument:

vscode/src/vs/workbench/contrib/files/browser/fileCommands.ts

Lines 620 to 656 in 96ca512

	KeybindingsRegistry.registerCommandAndKeybindingRule({
	weight: KeybindingWeight.WorkbenchContrib,
	when: null,
	primary: isWeb ? (isWindows ? KeyChord(KeyMod.CtrlCmd | KeyCode.KeyK, KeyCode.KeyN) : KeyMod.CtrlCmd | KeyMod.Alt | KeyCode.KeyN) : KeyMod.CtrlCmd | KeyCode.KeyN,
	secondary: isWeb ? [KeyMod.CtrlCmd | KeyCode.KeyN] : undefined,
	id: NEW_UNTITLED_FILE_COMMAND_ID,
	description: {
	description: NEW_UNTITLED_FILE_LABEL,
	args: [
	{
	isOptional: true,
	name: 'viewType',
	description: 'The editor view type',
	schema: {
	'type': 'object',
	'required': ['viewType'],
	'properties': {
	'viewType': {
	'type': 'string'
	}
	}
	}
	}
	]
	},
	handler: async (accessor, args?: { viewType: string }) => {
	const editorService = accessor.get(IEditorService);
	await editorService.openEditor({
	resource: undefined,
	options: {
	override: args?.viewType,
	pinned: true
	}
	});
	}
	});

I think this can come in as a PR, if it turns out to be working.

[karrtikr]

I am a bit confused, how can there be a python specific welcome command without the python extension?

Opening python specific getting started doesn't require a command, it uses package.json directly so extension doesn't need to finish activating.

[karrtikr]

I think such a change would be relatively easy, similar to the view type argument:

That's great. Just to doublecheck, is it possible to call workbench.action.files.newUntitledFile with arguments in package.json directly?

[bpasero]

Hm, I am not entirely sure, @sandy081 do you know? Or @jrieken?

[jrieken]

Just to doublecheck, is it possible to call workbench.action.files.newUntitledFile with arguments in package.json directly?

You mean define a keybinding for said command with arguments or how/where are the arguments defined? Technically you don't "call" a command from package.json, you can only reference them

[lramos15]

Just to doublecheck, is it possible to call workbench.action.files.newUntitledFile with arguments in package.json directly?

You mean define a keybinding for said command with arguments or how/where are the arguments defined? Technically you don't "call" a command from package.json, you can only reference them

I believe kartik is referring to a command link in the statically defined walkthroughs within the package.json

[karrtikr]

I believe kartik is referring to a command link in the statically defined walkthroughs within the package.json

Yes

Technically you don't "call" a command from package.json, you can only reference them

Right, can I reference such a command with arguments in walkthroughs within package.json? In this case it would be something like:

[Create Python File](command:toSide:workbench.action.files.newUntitledFile?<args>)

where <args> refers to args to command which instructs to open a python file.

[yume-chan]

can I reference such a command with arguments in walkthroughs

Yes, for example GitLens does this:

https://github.com/gitkraken/vscode-gitlens/blob/7b5205412dc333b7bc744ca00011f73e3304cfa2/walkthroughs/getting-started/1-setup.md?plain=1#L9

[GitLens: Welcome (Quick Setup)](command:gitlens.showWelcomePage?%22quick-setup%22)

---

where refers to args to command which instructs to open a python file.

No, workbench.action.files.newUntitledFile doesn't support specifying language in args.

vscode/src/vs/workbench/contrib/files/browser/fileCommands.ts

Lines 625 to 644 in c12c8c1

	id: NEW_UNTITLED_FILE_COMMAND_ID,
	description: {
	description: NEW_UNTITLED_FILE_LABEL,
	args: [
	{
	isOptional: true,
	name: 'viewType',
	description: 'The editor view type',
	schema: {
	'type': 'object',
	'required': ['viewType'],
	'properties': {
	'viewType': {
	'type': 'string'
	}
	}
	}
	}
	]
	},

---

as extension is not guaranteed to be activated when the walkthrough is opened

You can activate your extension when the command is invoked. GitLens also does this:

https://github.com/gitkraken/vscode-gitlens/blob/7b5205412dc333b7bc744ca00011f73e3304cfa2/package.json#L89

"activationEvents": [
    "...",
    "onCommand:gitlens.showWelcomePage",
    "..."
]

[karrtikr]

Yes, for example GitLens does this:

Gotcha, thanks. I assume it's URI encoded.

No, workbench.action.files.newUntitledFile doesn't support specifying language in args.

That is what this feature request is for :)

You can activate your extension when the command is invoked. GitLens also does this:

We don't have our own specific open walkthrough command, so our walkthrough is opened before commands finish registering, i.e our command may not be registered by the time Create Python File is clicked.

[bpasero]

Open for a contribution after validation it works from welcome 👍

[jrieken]

@karrtikr Just fyi that the "format" of such arguments is the following: JSON.stringify the arguments, then encodeURIComponent the result, and use that as URI query.