fs: remove createVirtual, use node:vfs instead

- Remove fs.createVirtual() from lib/fs.js
- Remove VFS documentation section from doc/api/fs.md (lives in vfs.md)
- Update all VFS tests to use require('node:vfs').create()

Author: mcollina

doc/api/fs.md

@@ -3207,20 +3207,6 @@ function globSync(pattern, options) {
   return new Glob(pattern, options).globSync();
 }
 
-const lazyVfs = getLazy(() => require('internal/vfs/file_system').VirtualFileSystem);
-
-/**
- * Creates a new virtual file system instance.
- * @param {object} [options] Configuration options
- * @param {boolean} [options.fallthrough] Whether to fall through to real fs on miss
- * @param {boolean} [options.moduleHooks] Whether to enable require/import hooks
- * @returns {VirtualFileSystem}
- */
-function createVirtual(options) {
-  const VirtualFileSystem = lazyVfs();
-  return new VirtualFileSystem(options);
-}
-
 module.exports = fs = {
   appendFile,
   appendFileSync,
@@ -3237,7 +3223,6 @@ module.exports = fs = {
   cp,
   cpSync,
   createReadStream,
-  createVirtual,
   createWriteStream,
   exists,
   existsSync,

lib/fs.js

@@ -2,19 +2,19 @@
 
 require('../common');
 const assert = require('assert');
-const fs = require('fs');
+const vfs = require('node:vfs');
 
-// Test that VirtualFileSystem can be created via fs.createVirtual()
+// Test that VirtualFileSystem can be created via vfs.create()
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   assert.ok(myVfs);
   assert.strictEqual(typeof myVfs.writeFileSync, 'function');
   assert.strictEqual(myVfs.mounted, false);
 }
 
 // Test adding and reading a static file
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/test', { recursive: true });
   myVfs.writeFileSync('/test/file.txt', 'hello world');
 
@@ -33,7 +33,7 @@ const fs = require('fs');
 
 // Test statSync
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/test/dir', { recursive: true });
   myVfs.writeFileSync('/test/file.txt', 'content');
 
@@ -54,7 +54,7 @@ const fs = require('fs');
 
 // Test readdirSync
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/dir/subdir', { recursive: true });
   myVfs.writeFileSync('/dir/a.txt', 'a');
   myVfs.writeFileSync('/dir/b.txt', 'b');
@@ -89,7 +89,7 @@ const fs = require('fs');
 
 // Test removing entries
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/test', { recursive: true });
   myVfs.writeFileSync('/test/file.txt', 'content');
 
@@ -105,7 +105,7 @@ const fs = require('fs');
 
 // Test mount mode
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/data', { recursive: true });
   myVfs.writeFileSync('/data/file.txt', 'mounted content');
 
@@ -124,7 +124,7 @@ const fs = require('fs');
 
 // Test internalModuleStat (used by Module._stat)
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/dir', { recursive: true });
   myVfs.writeFileSync('/module.js', 'module.exports = {}');
 
@@ -135,7 +135,7 @@ const fs = require('fs');
 
 // Test reading directory as file throws EISDIR
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/mydir', { recursive: true });
 
   assert.throws(() => {
@@ -145,7 +145,7 @@ const fs = require('fs');
 
 // Test realpathSync
 {
-  const myVfs = fs.createVirtual();
+  const myVfs = vfs.create();
   myVfs.mkdirSync('/test', { recursive: true });
   myVfs.writeFileSync('/test/file.txt', 'content');
 

test/parallel/test-vfs-basic.js

@@ -2,15 +2,15 @@
 
 const common = require('../common');
 const assert = require('assert');
-const fs = require('fs');
+const vfs = require('node:vfs');
 const { Worker, isMainThread, parentPort, workerData } = require('worker_threads');
 
 if (isMainThread) {
   // Test 1: Verify that VFS setup in main thread doesn't automatically apply to workers
   {
-    const vfs = fs.createVirtual({ virtualCwd: true });
-    vfs.mkdirSync('/project', { recursive: true });
-    vfs.mount('/virtual');
+    const myVfs = vfs.create({ virtualCwd: true });
+    myVfs.mkdirSync('/project', { recursive: true });
+    myVfs.mount('/virtual');
 
     // Set virtual cwd in main thread
     process.chdir('/virtual/project');
@@ -29,7 +29,7 @@ if (isMainThread) {
 
     worker.on('exit', common.mustCall((code) => {
       assert.strictEqual(code, 0);
-      vfs.unmount();
+      myVfs.unmount();
     }));
   }
 
@@ -75,30 +75,30 @@ if (isMainThread) {
     parentPort.postMessage({ cwd: process.cwd() });
   } else if (test === 'worker-independent-vfs') {
     // Set up VFS independently in worker
-    const vfs = fs.createVirtual({ virtualCwd: true });
-    vfs.mkdirSync('/data', { recursive: true });
-    vfs.mount('/worker-virtual');
+    const myVfs = vfs.create({ virtualCwd: true });
+    myVfs.mkdirSync('/data', { recursive: true });
+    myVfs.mount('/worker-virtual');
 
     process.chdir('/worker-virtual/data');
     const cwd = process.cwd();
 
-    vfs.unmount();
+    myVfs.unmount();
 
     parentPort.postMessage({ success: true, cwd });
   } else if (test === 'worker-create-vfs') {
     // Test VFS creation and chdir in worker
-    const vfs = fs.createVirtual({ virtualCwd: true });
-    vfs.mkdirSync('/project/src', { recursive: true });
-    vfs.mount('/');
+    const myVfs = vfs.create({ virtualCwd: true });
+    myVfs.mkdirSync('/project/src', { recursive: true });
+    myVfs.mount('/');
 
-    vfs.chdir('/project/src');
+    myVfs.chdir('/project/src');
 
     parentPort.postMessage({
       success: true,
-      virtualCwdEnabled: vfs.virtualCwdEnabled,
-      vfsCwd: vfs.cwd(),
+      virtualCwdEnabled: myVfs.virtualCwdEnabled,
+      vfsCwd: myVfs.cwd(),
     });
 
-    vfs.unmount();
+    myVfs.unmount();
   }
 }