VSCode扩展中如何监听文件重命名及未保存文件命名？

Great question! I've run into this exact issue when building VS Code extensions that need to track file renames and untitled file saves—FileSystemWatcher alone just doesn't cut it because it treats renames as a delete + create pair with no built-in way to link the two events. Here are the most reliable, optimized approaches to solve both parts of your problem:

1. Capture File Rename Old→New Mappings #

VS Code provides a dedicated workspace event specifically for tracking file renames: workspace.onDidRenameFiles. This event gives you direct access to an array of rename operations, each containing both the old and new URI of the renamed file—no need to guess or correlate delete/create events.

Example Code: #

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  // Listen for file rename events
  const renameDisposable = vscode.workspace.onDidRenameFiles(event => {
    event.files.forEach(renameInfo => {
      const oldFileName = vscode.workspace.asRelativePath(renameInfo.oldUri);
      const newFileName = vscode.workspace.asRelativePath(renameInfo.newUri);
      
      console.log(`File renamed: ${oldFileName} → ${newFileName}`);
      // Add your custom logic here (e.g., update references, log changes)
    });
  });

  context.subscriptions.push(renameDisposable);
}

This event works for both single-file renames and bulk renames, and it’s far more reliable than trying to pair FileSystemWatcher's onDidDelete and onDidCreate events (which can have race conditions or miss edge cases like renames across different directories).

2. Track Untitled File Saves to Named Files #

For untitled files (like Untitled-1) being saved to a specific name, you’ll need to combine two workspace events:

• onDidOpenTextDocument: Track when an untitled document is opened
• onDidSaveTextDocument: Detect when that untitled document is saved to a permanent file

Example Code: #

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
  // Map to track untitled documents by their URI (before save)
  const untitledDocuments = new Map<string, vscode.TextDocument>();

  // Listen for untitled document opens
  const openDisposable = vscode.workspace.onDidOpenTextDocument(doc => {
    if (doc.isUntitled) {
      untitledDocuments.set(doc.uri.toString(), doc);
      console.log(`Untitled document opened: ${doc.uri.path}`);
    }
  });

  // Listen for saves to capture untitled → named transitions
  const saveDisposable = vscode.workspace.onDidSaveTextDocument(doc => {
    const docUriStr = doc.uri.toString();
    if (untitledDocuments.has(docUriStr)) {
      const oldUntitledName = untitledDocuments.get(docUriStr)?.uri.path.split('/').pop();
      const newFileName = vscode.workspace.asRelativePath(doc.uri);
      
      console.log(`Untitled file saved: ${oldUntitledName} → ${newFileName}`);
      // Add your custom logic here
      
      untitledDocuments.delete(docUriStr); // Clean up after processing
    }
  });

  context.subscriptions.push(openDisposable, saveDisposable);
}

Notes: #

• The isUntitled property is true for unsaved, unnamed documents. Once saved, this property flips to false, and the document’s uri updates to point to the saved file path.
• We use a Map to track untitled documents because their URI (e.g., untitled:Untitled-1) stays consistent until they’re saved.

Why Avoid FileSystemWatcher for This? #

As you noticed, FileSystemWatcher only emits separate onDidDelete and onDidCreate events for renames. Trying to correlate these requires complex logic (like timing windows, checking file content matches) which is prone to errors—especially if multiple files are created/deleted around the same time. The built-in workspace events are designed to handle these edge cases natively.

内容的提问来源于stack exchange，提问作者Mishkin Faustini