CODEWITHSUNDEEP
visual-studio-codevscode-extensions
James Mertz
James Mertz

Reputation: 8789

How do I create a file for a Visual Studio Code Extension?

I'm trying to create a file as a part of one of the commands in my extension and can't seem to get it right.

let wsedit = new vscode.WorkspaceEdit();
const file_path = vscode.Uri.file(value + '/' + value + '.md');
vscode.window.showInformationMessage(file_path.toString());
wsedit.createFile(file_path, {ignoreIfExists: true});
vscode.workspace.applyEdit(wsedit);
vscode.window.showInformationMessage('Created a new file: ' value + '/' + value + '.md);

value is a string input from the user. The code executes, but from what I can tell no file is being created. How do I properly create the file?

Upvotes: 5

Views: 8787

Answers (2)

Vedant Agarwala
Vedant Agarwala

Reputation: 18819

You can achieve the same with (writeFile)[https://code.visualstudio.com/api/references/vscode-api#workspace.fs.writeFile], with much lesser code.

vscode.workspace.fs.writeFile(filePath, Buffer.from(''))

It creates the file and directories as needed. Caution: it will replace the contents of the file if it exists.

Upvotes: 0

HaaLeo
HaaLeo

Reputation: 11762

It seems like the vscode.Uri does not support relative paths (here is the corresponding issue). With that said you have to use an absolute path. The following snippet should work (tested on windows with vscode v1.30.0)

const wsedit = new vscode.WorkspaceEdit();
const wsPath = vscode.workspace.workspaceFolders[0].uri.fsPath; // gets the path of the first workspace folder
const filePath = vscode.Uri.file(wsPath + '/hello/world.md');
vscode.window.showInformationMessage(filePath.toString());
wsedit.createFile(filePath, { ignoreIfExists: true });
vscode.workspace.applyEdit(wsedit);
vscode.window.showInformationMessage('Created a new file: hello/world.md');

Upvotes: 11

Related Questions