Skip to content

Clean up createRequire workarounds once VS Code ESM support is fixed #227

Description

@rayman2000

Context

During the ESM migration (#226), we had to use createRequire workarounds to avoid two VS Code ESM loader bugs:

  1. vscode module deadlock (microsoft/vscode#285297): VS Code's ESM resolve hook uses MessageChannel to intercept import 'vscode', but this deadlocks under certain conditions. Workaround: use createRequire(import.meta.url)('vscode') instead of import * as vscode from 'vscode'.

  2. fs module interception: VS Code's ESM loader hook rewrites import 'fs' to node:original-fs (a stripped-down version missing methods like createWriteStream, readFile). This breaks fs-extra when loaded via ESM since its ESM entry point imports fs. Workaround: use createRequire(import.meta.url)('fs-extra') to load via CJS path, and import from 'node:fs' for bare fs imports.

Files affected

  • src/vscode-util/Progress.tscreateRequire for vscode
  • src/dependencies/FileDownloader.tscreateRequire for fs-extra
  • src/dependencies/ZipExtractor.tscreateRequire for fs-extra
  • src/dependencies/LocalReference.tscreateRequire for fs-extra
  • src/util/Location.tscreateRequire for fs-extra
  • src/util/Platform.tscreateRequire for fs-extra
  • src/test/runTest.tsnode:fs prefix
  • src/test/dependencies.test.tsnode:fs prefix

Cleanup

Once microsoft/vscode#285297 is resolved and the minimum VS Code version is bumped accordingly, these workarounds can be replaced with standard ESM imports:

// Before (workaround)
import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);
const vscode = require('vscode') as typeof import('vscode');

// After (clean)
import * as vscode from 'vscode';
// Before (workaround)
import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);
const fs = require('fs-extra') as typeof import('fs-extra');

// After (clean)
import * as fs from 'fs-extra';

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions