vscode.workspace.fs 提供跨平台文件操作,支持异步读写、复制移动、目录创建与遍历、存在性检查及文件监听,适用于本地与远程开发场景。

在 VSCode 插件开发中,文件操作是核心功能之一。虽然 Node.js 的 fs 模块已经足够强大,但 VSCode 提供了更现代化、更安全的高级文件系统 API —— vscode.workspace.fs,它基于 Language Server Protocol(LSP)设计,支持跨工作区、远程开发(如 SSH、WSL、Containers)等复杂场景。
vscode.workspace.fs 简介
VSCode 从 1.36 版本开始引入 vscode.workspace.fs,作为对底层文件系统的统一抽象。相比传统的 fs 模块,它具备以下优势:
- 支持本地与远程环境的一致性操作
- 基于 Promise,异步操作更简洁
- 与 VSCode 编辑器状态同步,避免文件冲突
- 支持原子性写入、文件复制、批量操作等高级功能
常见文件操作实战示例
以下是一些常用文件操作的代码示例,展示如何在插件中使用该 API。
读取文件内容
使用 readFile 方法读取文件,返回的是 Uint8Array,需要手动转为字符串。
const uri = vscode.Uri.file('/path/to/file.txt');
try {
const data = await vscode.workspace.fs.readFile(uri);
const text = new TextDecoder('utf-8').decode(data);
console.log(text);
} catch (err) {
console.error('读取失败:', err);
}
写入文件内容
使用 writeFile 写入数据,同样接收 Uint8Array。
const uri = vscode.Uri.file('/path/to/hello.txt');
const text = 'Hello from VSCode API!';
const data = new TextEncoder().encode(text);
await vscode.workspace.fs.writeFile(uri, data);
注意:writeFile 会自动创建不存在的文件和目录。
方科网络ERP图文店II版为仿代码站独立研发的网络版ERP销售程序。本本版本为方科网络ERP图文店版的简化版,去除了部分不同用的功能,使得系统更加精炼实用。考虑到图文店的特殊情况,本系统并未制作出入库功能,而是将销售作为重头,使用本系统,可以有效解决大型图文店员工多,换班数量多,订单混杂不清的情况。下单、取件、结算分别记录操作人员,真正做到订单全程跟踪!无限用户级别,不同的用户级别可以设置不同的价
文件复制与移动
支持跨文件系统操作,比如从本地复制到 WSL 环境。
const source = vscode.Uri.file('/tmp/old.txt');
const destination = vscode.Uri.file('/tmp/new.txt');
// 复制文件
await vscode.workspace.fs.copy(source, destination);
// 移动(重命名)
await vscode.workspace.fs.rename(source, destination, { overwrite: true });
创建目录与遍历文件
创建目录使用 createDirectory,遍历用 readDirectory。
const dirUri = vscode.Uri.file('/tmp/my-folder');
await vscode.workspace.fs.createDirectory(dirUri);
// 遍历目录
const entries = await vscode.workspace.fs.readDirectory(dirUri);
for (const [name, type] of entries) {
if (type === vscode.FileType.File) {
console.log('文件:', name);
} else if (type === vscode.FileType.Directory) {
console.log('目录:', name);
}
}
检查文件是否存在
虽然没有 exists 方法,但可以通过 try/catch 调用 stat 实现。
async function fileExists(uri) {
try {
await vscode.workspace.fs.stat(uri);
return true;
} catch {
return false;
}
}
const uri = vscode.Uri.file('/tmp/test.txt');
if (await fileExists(uri)) {
console.log('文件存在');
}
监听文件变化(可选)
如果需要响应式处理文件变更,可以结合 vscode.workspace.createFileSystemWatcher。
const watcher = vscode.workspace.createFileSystemWatcher('**/*.txt');
watcher.onDidChange(uri => {
console.log('文件被修改:', uri.path);
});
基本上就这些。这套 API 更适合现代插件开发,尤其在多环境协同场景下表现稳定。









