VSCode扩展开发：如何通过内置API高效监听项目依赖变更

直接弃用 Node.js 原生的fs.watchFile，VSCode 提供了两层内部API，完全覆盖你遇到的两类问题，性能和触发时机都远优于原生fs模块：

解决文件保存后响应延迟问题 #

用VSCode内置的文件系统监听器vscode.workspace.createFileSystemWatcher，它直接复用VSCode主进程全局维护的文件系统事件句柄，对接操作系统原生的文件变更通知，没有fs.watchFile默认的轮询开销，响应延迟通常在100ms以内，不会有1-2秒的等待。
基础用法示例：

import * as vscode from 'vscode';
import * as path from 'path';

// 监听工作区下所有层级的package.json
const pkgWatcher = vscode.workspace.createFileSystemWatcher(
  new vscode.RelativePattern(vscode.workspace.workspaceFolders?.[0], '**/package.json')
);

pkgWatcher.onDidChange(async (fileUri) => {
  // 读取磁盘上最新的package.json内容
  const fileBuffer = await vscode.workspace.fs.readFile(fileUri);
  const pkgData = JSON.parse(Buffer.from(fileBuffer).toString('utf-8'));
  // 对比依赖字段变化，执行你的自定义逻辑
});

// 扩展停用时自动销毁监听器，避免内存泄漏
context.subscriptions.push(pkgWatcher);

解决未保存状态下的编辑感知问题 #

你遇到的「手动改package.json不保存就不触发」问题，本质是原生fs模块只能读取磁盘上的持久化文件，完全接触不到VSCode编辑器内存里的临时缓冲区内容，这部分要靠文本文档变更事件实现：
绑定vscode.workspace.onDidChangeTextDocument事件，这个事件会在用户输入编辑时实时触发，不管文件有没有存盘，你可以过滤出package.json对应的文档，实时拿到当前编辑区的内容：

// 可自行实现防抖逻辑，避免用户每敲一个字符就触发逻辑
const debounce = (fn: Function, delay = 500) => {
  let timer: NodeJS.Timeout;
  return (...args: any[]) => {
    clearTimeout(timer);
    timer = setTimeout(() => fn(...args), delay);
  };
};

const handlePkgEdit = debounce(async (document: vscode.TextDocument) => {
  const content = document.getText();
  try {
    const pkgData = JSON.parse(content);
    // 重点比对以下依赖字段的变化，非依赖字段改动可直接跳过
    const depFields = [
      'dependencies',
      'devDependencies',
      'peerDependencies',
      'optionalDependencies'
    ];
    // 字段存在实际变动时再执行后续自定义操作
  } catch (e) {
    // 编辑过程中JSON格式不合法时直接跳过，不做处理
  }
});

vscode.workspace.onDidChangeTextDocument((e) => {
  const doc = e.document;
  if (path.basename(doc.uri.fsPath) !== 'package.json') return;
  handlePkgEdit(doc);
});

可选优化：精准捕获依赖安装行为 #

如果你不需要感知未保存的编辑，只需要在用户实际安装/删除依赖时触发逻辑，还可以额外监听VSCode的终端任务事件，识别npm install、pnpm add、yarn add/remove这类依赖操作命令的执行，在命令执行完成后再校验依赖变化，能避免用户修改package.json其他字段时的误触发。

内容的提问来源于stack exchange，提问作者Anastasiia Solop