nodejs / nodejs/node

Implement VFS (Virtual File System) Hooks for Single Executable Applications

Open
#60,021 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
JavaScript
Stars
122k
Forks
37.3k
Avg merge
4d 2h
Merged PRs (30d)
283

Description

What is the problem this feature will solve?

Currently, creating Single Executable Applications in Node.js requires complex workarounds and monkey-patching of the fs module to access embedded resources. This approach:

  • Makes Node.js harder to maintain due to ecosystem modules that monkey-patch core behavior[1]
  • Creates compatibility issues when Node.js APIs change
  • Lacks a standardized, official way to handle virtual file systems
  • Forces developers to implement fragile solutions that may break with future Node.js updates
What is the feature you are proposing to solve the problem?

Implementing a VFS hooks API in Node.js core that would allow userland code to override read-only filesystem operations through a virtual file system, specifically to support Single Executable Applications (SEAs) as described in the FS hooks proposal.

What alternatives have you considered?
  • Monkey-patching fs module: Current approach but problematic for maintainability
  • Using Loaders API for fs replacement: Could work but not designed for this purpose
  • External VFS libraries: Require significant setup and don't integrate cleanly with Node.js internals

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the FS hooks proposal linked in the issue, then compare it with the listed monkey-patching, Loaders API, and external-library alternatives. Done means agreeing on and implementing a Node.js core VFS hooks API that supports read-only virtual filesystem operations for Single Executable Applications.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
backend-api-design, operating-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.