Skip to content

Frontmatter for inline scripts #64809

Open

Description

@everett1992

What is the problem this feature will solve?

Taking inspiration from nix, cargo, and python I would like a way for stand-alone scripts to embed configuration normally passed via package.json, node.config.json, argv, or wrapper scripts.

#59565 asks to support typescript-module in extensionless files but proposals for #!/usr/bin/env node --ext mts were rejected because many systems don't support multi-word shebangs.

I don't think this limitation is exclusive to that --ext use cases, there are other options including --permission that cannot be set in a self contained script, yes you can use .env, node.config.json, or package.json but that's no-longer self contained.

This would also be an interesting integration point for package managers that could read dependencies from the frontmatter and support npm x ./script to install the script's inline dependencies.

https://nixos.wiki/wiki/Nix-shell_shebang
https://rust-lang.github.io/rfcs/3424-cargo-script.html
https://packaging.python.org/en/latest/specifications/inline-script-metadata/

What is the feature you are proposing to solve the problem?

The rough outline is for node to parse a leading comment in the main entry point and read command line arguments,
node.config, and package.json fields. The comment would only be read in the main entry point and would sit after explicit options in priority.

#!/usr/bin/env node
// ```node.config.json
// {
//    "nodeOptions": { "ext": "mts" },
//    "permission": {},
//  }
// ```
await main(process.argv.slice(2))

async function main(args: string[]) {
  console.log(args)
}

What alternatives have you considered?

Today I'll create directories with package.jsonuse .mts file extensions, or use nasty tricks to combine shell and ts into a single script

#!/bin/sh
':' // ; exec node --ext mts
// script goes here
let n: number = 1;

Activity

  1. avivkeller commented on Jul 29, 2026

    @avivkeller
    Member

    Wouldn't this require AST parsing every script? that would dramatically slow down node, would it not?

  2. avivkeller commented on Jul 29, 2026

    @avivkeller
    Member

    IMHO the multi-word sheband makes sense, and then it becomes the system's responsibility

  3. everett1992 commented on Jul 29, 2026

    @everett1992
    ContributorAuthor

    I would be happy with a more limited implementation that just solves the argv / shebang splitting problem, to allow portable scripts to pass args to their node process.

    But I don't think either version would significantly slow script execution

    • It's just the main entry point, not every file
    • It's just the first lines, till a syntax error or line that doesn't start with // or a special marker we choose.
    • It's not building a JS AST, something smaller like JSON parsing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestIssues requesting new Node.js features.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions