From 128c60d90609ac25e6dce9cd5937c497786bda41 Mon Sep 17 00:00:00 2001
From: Yagiz Nizipli <yagiz@nizipli.com>
Date: Sun, 7 Apr 2024 20:49:14 -0400
Subject: [PATCH] cli: implement `node --run <script-in-package-json>`
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Daniel Lemire <daniel@lemire.me>
PR-URL: https://github.com/nodejs/node/pull/52190
Reviewed-By: Daniel Lemire <daniel@lemire.me>
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Ruy Adorno <ruy@vlt.sh>
---
 doc/api/cli.md                                | 44 +++++++++
 lib/internal/main/run.js                      | 74 ++++++++++++++
 lib/internal/shell.js                         | 37 +++++++
 src/node.cc                                   |  4 +
 src/node_modules.cc                           | 40 ++++++++
 src/node_modules.h                            |  3 +
 src/node_options.cc                           |  3 +
 src/node_options.h                            |  1 +
 test/fixtures/run-script/.env                 |  1 +
 .../fixtures/run-script/node_modules/.bin/ada |  2 +
 .../run-script/node_modules/.bin/ada.bat      |  1 +
 .../run-script/node_modules/.bin/custom-env   |  2 +
 .../node_modules/.bin/custom-env.bat          |  1 +
 .../node_modules/.bin/positional-args         |  2 +
 .../node_modules/.bin/positional-args.bat     |  2 +
 test/fixtures/run-script/package.json         | 11 +++
 test/message/node_run_non_existent.js         | 14 +++
 test/message/node_run_non_existent.out        | 10 ++
 test/parallel/test-node-run.js                | 99 +++++++++++++++++++
 typings/internalBinding/modules.d.ts          |  1 +
 20 files changed, 352 insertions(+)
 create mode 100644 lib/internal/main/run.js
 create mode 100644 lib/internal/shell.js
 create mode 100644 test/fixtures/run-script/.env
 create mode 100755 test/fixtures/run-script/node_modules/.bin/ada
 create mode 100755 test/fixtures/run-script/node_modules/.bin/ada.bat
 create mode 100755 test/fixtures/run-script/node_modules/.bin/custom-env
 create mode 100755 test/fixtures/run-script/node_modules/.bin/custom-env.bat
 create mode 100755 test/fixtures/run-script/node_modules/.bin/positional-args
 create mode 100755 test/fixtures/run-script/node_modules/.bin/positional-args.bat
 create mode 100644 test/fixtures/run-script/package.json
 create mode 100644 test/message/node_run_non_existent.js
 create mode 100644 test/message/node_run_non_existent.out
 create mode 100644 test/parallel/test-node-run.js

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 002aa1eef5859c..f08afb737d41b4 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1807,6 +1807,50 @@ Only CommonJS modules are supported.
 Use [`--import`][] to preload an [ECMAScript module][].
 Modules preloaded with `--require` will run before modules preloaded with `--import`.
 
+### `--run`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1.1 - Active development
+
+This runs a specified command from a package.json's `"scripts"` object.
+If no `"command"` is provided, it will list the available scripts.
+
+`--run` prepends `./node_modules/.bin`, relative to the current
+working directory, to the `PATH` in order to execute the binaries from
+dependencies.
+
+For example, the following command will run the `test` script of
+the `package.json` in the current folder:
+
+```console
+$ node --run test
+```
+
+You can also pass arguments to the command. Any argument after `--` will
+be appended to the script:
+
+```console
+$ node --run test -- --verbose
+```
+
+#### Intentional limitations
+
+`node --run` is not meant to match the behaviors of `npm run` or of the `run`
+commands of other package managers. The Node.js implementation is intentionally
+more limited, in order to focus on top performance for the most common use
+cases.
+Some features of other `run` implementations that are intentionally excluded
+are:
+
+* Searching for `package.json` files outside the current folder.
+* Prepending the `.bin` or `node_modules/.bin` paths of folders outside the
+  current folder.
+* Running `pre` or `post` scripts in addition to the specified script.
+* Defining package manager-specific environment variables.
+
 ### `--secure-heap=n`
 
 <!-- YAML
diff --git a/lib/internal/main/run.js b/lib/internal/main/run.js
new file mode 100644
index 00000000000000..900e73d2810357
--- /dev/null
+++ b/lib/internal/main/run.js
@@ -0,0 +1,74 @@
+'use strict';
+/* eslint-disable node-core/prefer-primordials */
+
+// There is no need to add primordials to this file.
+// `run.js` is a script only executed when `node --run <script>` is called.
+const {
+  prepareMainThreadExecution,
+  markBootstrapComplete,
+} = require('internal/process/pre_execution');
+const { getPackageJSONScripts } = internalBinding('modules');
+const { execSync } = require('child_process');
+const { resolve, delimiter } = require('path');
+const { escapeShell } = require('internal/shell');
+const { getOptionValue } = require('internal/options');
+const { emitExperimentalWarning } = require('internal/util');
+
+prepareMainThreadExecution(false, false);
+markBootstrapComplete();
+emitExperimentalWarning('Task runner');
+
+// TODO(@anonrig): Search for all package.json's until root folder.
+const json_string = getPackageJSONScripts();
+
+// Check if package.json exists and is parseable
+if (json_string === undefined) {
+  process.exitCode = 1;
+  return;
+}
+const scripts = JSON.parse(json_string);
+// Remove the first argument, which are the node binary.
+const args = process.argv.slice(1);
+const id = getOptionValue('--run');
+let command = scripts[id];
+
+if (!command) {
+  const { error } = require('internal/console/global');
+
+  error(`Missing script: "${id}"\n`);
+
+  const keys = Object.keys(scripts);
+  if (keys.length === 0) {
+    error('There are no scripts available in package.json');
+  } else {
+    error('Available scripts are:');
+    for (const script of keys) {
+      error(`  ${script}: ${scripts[script]}`);
+    }
+  }
+  process.exit(1);
+  return;
+}
+
+const env = process.env;
+const cwd = process.cwd();
+const binPath = resolve(cwd, 'node_modules/.bin');
+
+// Filter all environment variables that contain the word "path"
+const keys = Object.keys(env).filter((key) => /^path$/i.test(key));
+const PATH = keys.map((key) => env[key]);
+
+// Append only the current folder bin path to the PATH variable.
+// TODO(@anonrig): Prepend the bin path of all parent folders.
+const paths = [binPath, PATH].join(delimiter);
+for (const key of keys) {
+  env[key] = paths;
+}
+
+// If there are any remaining arguments left, append them to the command.
+// This is useful if you want to pass arguments to the script, such as
+// `node --run linter -- --help` which runs `biome --check . --help`
+if (args.length > 0) {
+  command += ' ' + escapeShell(args.map((arg) => arg.trim()).join(' '));
+}
+execSync(command, { stdio: 'inherit', env, shell: true });
diff --git a/lib/internal/shell.js b/lib/internal/shell.js
new file mode 100644
index 00000000000000..144fd9e98dcd0c
--- /dev/null
+++ b/lib/internal/shell.js
@@ -0,0 +1,37 @@
+'use strict';
+
+
+// There is no need to add primordials to this file.
+// `shell.js` is a script only executed when `node run <script>` is called.
+
+const forbiddenCharacters = /[\t\n\r "#$&'()*;<>?\\`|~]/;
+
+/**
+ * Escapes a string to be used as a shell argument.
+ *
+ * Adapted from `promise-spawn` module available under ISC license.
+ * Ref: https://github.com/npm/promise-spawn/blob/16b36410f9b721dbe190141136432a418869734f/lib/escape.js
+ * @param {string} input
+ */
+function escapeShell(input) {
+  // If the input is an empty string, return a pair of quotes
+  if (!input.length) {
+    return '\'\'';
+  }
+
+  // Check if input contains any forbidden characters
+  // If it doesn't, return the input as is.
+  if (!forbiddenCharacters.test(input)) {
+    return input;
+  }
+
+  // Replace single quotes with '\'' and wrap the whole result in a fresh set of quotes
+  return `'${input.replace(/'/g, '\'\\\'\'')}'`
+    // If the input string already had single quotes around it, clean those up
+    .replace(/^(?:'')+(?!$)/, '')
+    .replace(/\\'''/g, '\\\'');
+}
+
+module.exports = {
+  escapeShell,
+};
diff --git a/src/node.cc b/src/node.cc
index 07a91f485502b8..3a904697a7ac80 100644
--- a/src/node.cc
+++ b/src/node.cc
@@ -409,6 +409,10 @@ MaybeLocal<Value> StartExecution(Environment* env, StartExecutionCallback cb) {
     return StartExecution(env, "internal/main/watch_mode");
   }
 
+  if (!env->options()->run.empty()) {
+    return StartExecution(env, "internal/main/run");
+  }
+
   if (!first_argv.empty() && first_argv != "-") {
     return StartExecution(env, "internal/main/run_main_module");
   }
diff --git a/src/node_modules.cc b/src/node_modules.cc
index 9dca1857f96e43..e9e7ddbb0070f2 100644
--- a/src/node_modules.cc
+++ b/src/node_modules.cc
@@ -3,6 +3,7 @@
 #include "base_object-inl.h"
 #include "node_errors.h"
 #include "node_external_reference.h"
+#include "node_process-inl.h"
 #include "node_url.h"
 #include "permission/permission.h"
 #include "permission/permission_base.h"
@@ -219,6 +220,21 @@ const BindingData::PackageConfig* BindingData::GetPackageJSON(
       if (field_value == "commonjs" || field_value == "module") {
         package_config.type = field_value;
       }
+    } else if (key == "scripts") {
+      if (value.type().get(field_type)) {
+        return throw_invalid_package_config();
+      }
+      switch (field_type) {
+        case simdjson::ondemand::json_type::object: {
+          if (value.raw_json().get(field_value)) {
+            return throw_invalid_package_config();
+          }
+          package_config.scripts = field_value;
+          break;
+        }
+        default:
+          break;
+      }
     }
   }
   // package_config could be quite large, so we should move it instead of
@@ -344,6 +360,28 @@ void BindingData::GetNearestParentPackageJSONType(
   args.GetReturnValue().Set(Array::New(realm->isolate(), values, 3));
 }
 
+void BindingData::GetPackageJSONScripts(
+    const FunctionCallbackInfo<Value>& args) {
+  Realm* realm = Realm::GetCurrent(args);
+  std::string_view path = "package.json";
+
+  THROW_IF_INSUFFICIENT_PERMISSIONS(
+      realm->env(), permission::PermissionScope::kFileSystemRead, path);
+
+  auto package_json = GetPackageJSON(realm, path);
+  if (package_json == nullptr) {
+    printf("Can't read package.json\n");
+    return;
+  } else if (!package_json->scripts.has_value()) {
+    printf("Can't read package.json \"scripts\" object\n");
+    return;
+  }
+
+  args.GetReturnValue().Set(
+      ToV8Value(realm->context(), package_json->scripts.value())
+          .ToLocalChecked());
+}
+
 void BindingData::GetPackageScopeConfig(
     const FunctionCallbackInfo<Value>& args) {
   CHECK_GE(args.Length(), 1);
@@ -424,6 +462,7 @@ void BindingData::CreatePerIsolateProperties(IsolateData* isolate_data,
             "getNearestParentPackageJSON",
             GetNearestParentPackageJSON);
   SetMethod(isolate, target, "getPackageScopeConfig", GetPackageScopeConfig);
+  SetMethod(isolate, target, "getPackageJSONScripts", GetPackageJSONScripts);
 }
 
 void BindingData::CreatePerContextProperties(Local<Object> target,
@@ -440,6 +479,7 @@ void BindingData::RegisterExternalReferences(
   registry->Register(GetNearestParentPackageJSONType);
   registry->Register(GetNearestParentPackageJSON);
   registry->Register(GetPackageScopeConfig);
+  registry->Register(GetPackageJSONScripts);
 }
 
 }  // namespace modules
diff --git a/src/node_modules.h b/src/node_modules.h
index 27b2bcb11f56b0..6b47e5711c49cd 100644
--- a/src/node_modules.h
+++ b/src/node_modules.h
@@ -32,6 +32,7 @@ class BindingData : public SnapshotableObject {
     std::string type = "none";
     std::optional<std::string> exports;
     std::optional<std::string> imports;
+    std::optional<std::string> scripts;
     std::string raw_json;
 
     v8::Local<v8::Array> Serialize(Realm* realm) const;
@@ -60,6 +61,8 @@ class BindingData : public SnapshotableObject {
       const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetPackageScopeConfig(
       const v8::FunctionCallbackInfo<v8::Value>& args);
+  static void GetPackageJSONScripts(
+      const v8::FunctionCallbackInfo<v8::Value>& args);
 
   static void CreatePerIsolateProperties(IsolateData* isolate_data,
                                          v8::Local<v8::ObjectTemplate> ctor);
diff --git a/src/node_options.cc b/src/node_options.cc
index 808c08a47a7bba..398d4f428d018c 100644
--- a/src/node_options.cc
+++ b/src/node_options.cc
@@ -573,6 +573,9 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             &EnvironmentOptions::prof_process);
   // Options after --prof-process are passed through to the prof processor.
   AddAlias("--prof-process", { "--prof-process", "--" });
+  AddOption("--run",
+            "Run a script specified in package.json",
+            &EnvironmentOptions::run);
 #if HAVE_INSPECTOR
   AddOption("--cpu-prof",
             "Start the V8 CPU profiler on start up, and write the CPU profile "
diff --git a/src/node_options.h b/src/node_options.h
index fbdbe7c7a27251..ba171b4d14ac4c 100644
--- a/src/node_options.h
+++ b/src/node_options.h
@@ -161,6 +161,7 @@ class EnvironmentOptions : public Options {
   bool heap_prof = false;
 #endif  // HAVE_INSPECTOR
   std::string redirect_warnings;
+  std::string run;
   std::string diagnostic_dir;
   std::string env_file;
   bool has_env_file_string = false;
diff --git a/test/fixtures/run-script/.env b/test/fixtures/run-script/.env
new file mode 100644
index 00000000000000..c9784df76f3f70
--- /dev/null
+++ b/test/fixtures/run-script/.env
@@ -0,0 +1 @@
+CUSTOM_ENV="hello world"
diff --git a/test/fixtures/run-script/node_modules/.bin/ada b/test/fixtures/run-script/node_modules/.bin/ada
new file mode 100755
index 00000000000000..c6acb65ef626ef
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/ada
@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "06062023"
diff --git a/test/fixtures/run-script/node_modules/.bin/ada.bat b/test/fixtures/run-script/node_modules/.bin/ada.bat
new file mode 100755
index 00000000000000..18bb1405d22a73
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/ada.bat
@@ -0,0 +1 @@
+@echo "06062023"
diff --git a/test/fixtures/run-script/node_modules/.bin/custom-env b/test/fixtures/run-script/node_modules/.bin/custom-env
new file mode 100755
index 00000000000000..e6f291c6b2457d
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/custom-env
@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "$CUSTOM_ENV"
diff --git a/test/fixtures/run-script/node_modules/.bin/custom-env.bat b/test/fixtures/run-script/node_modules/.bin/custom-env.bat
new file mode 100755
index 00000000000000..9597eb0be35958
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/custom-env.bat
@@ -0,0 +1 @@
+echo %CUSTOM_ENV%
diff --git a/test/fixtures/run-script/node_modules/.bin/positional-args b/test/fixtures/run-script/node_modules/.bin/positional-args
new file mode 100755
index 00000000000000..47d2d7d6a26d93
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/positional-args
@@ -0,0 +1,2 @@
+#!/bin/bash
+echo $@
diff --git a/test/fixtures/run-script/node_modules/.bin/positional-args.bat b/test/fixtures/run-script/node_modules/.bin/positional-args.bat
new file mode 100755
index 00000000000000..b95ea66f90851a
--- /dev/null
+++ b/test/fixtures/run-script/node_modules/.bin/positional-args.bat
@@ -0,0 +1,2 @@
+@shift
+@echo %*
diff --git a/test/fixtures/run-script/package.json b/test/fixtures/run-script/package.json
new file mode 100644
index 00000000000000..79017b44450f96
--- /dev/null
+++ b/test/fixtures/run-script/package.json
@@ -0,0 +1,11 @@
+{
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "ada": "ada",
+    "ada-windows": "ada.bat",
+    "positional-args": "positional-args",
+    "positional-args-windows": "positional-args.bat",
+    "custom-env": "custom-env",
+    "custom-env-windows": "custom-env.bat"
+  }
+}
diff --git a/test/message/node_run_non_existent.js b/test/message/node_run_non_existent.js
new file mode 100644
index 00000000000000..7c49978b43a25b
--- /dev/null
+++ b/test/message/node_run_non_existent.js
@@ -0,0 +1,14 @@
+'use strict';
+
+require('../common');
+const assert = require('node:assert').strict;
+const childProcess = require('node:child_process');
+const fixtures = require('../common/fixtures');
+
+const child = childProcess.spawnSync(
+  process.execPath,
+  [ '--run', 'non-existent-command'],
+  { cwd: fixtures.path('run-script'), encoding: 'utf8' },
+);
+assert.strictEqual(child.status, 1);
+console.log(child.stderr);
diff --git a/test/message/node_run_non_existent.out b/test/message/node_run_non_existent.out
new file mode 100644
index 00000000000000..8d98465fa80606
--- /dev/null
+++ b/test/message/node_run_non_existent.out
@@ -0,0 +1,10 @@
+Missing script: "non-existent-command"
+
+Available scripts are:
+  test: echo "Error: no test specified" && exit 1
+  ada: ada
+  ada-windows: ada.bat
+  positional-args: positional-args
+  positional-args-windows: positional-args.bat
+  custom-env: custom-env
+  custom-env-windows: custom-env.bat
diff --git a/test/parallel/test-node-run.js b/test/parallel/test-node-run.js
new file mode 100644
index 00000000000000..fc727b702fde1a
--- /dev/null
+++ b/test/parallel/test-node-run.js
@@ -0,0 +1,99 @@
+// Flags: --expose-internals
+'use strict';
+
+const common = require('../common');
+const { it, describe } = require('node:test');
+const assert = require('node:assert');
+
+const fixtures = require('../common/fixtures');
+const envSuffix = common.isWindows ? '-windows' : '';
+
+describe('node run [command]', () => {
+  it('should emit experimental warning', async () => {
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--run', 'test'],
+      { cwd: __dirname },
+    );
+    assert.match(child.stderr, /ExperimentalWarning: Task runner is an experimental feature and might change at any time/);
+    assert.match(child.stdout, /Can't read package\.json/);
+    assert.strictEqual(child.code, 1);
+  });
+
+  it('returns error on non-existent file', async () => {
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--no-warnings', '--run', 'test'],
+      { cwd: __dirname },
+    );
+    assert.match(child.stdout, /Can't read package\.json/);
+    assert.strictEqual(child.stderr, '');
+    assert.strictEqual(child.code, 1);
+  });
+
+  it('runs a valid command', async () => {
+    // Run a script that just log `no test specified`
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--run', 'test', '--no-warnings'],
+      { cwd: fixtures.path('run-script') },
+    );
+    assert.match(child.stdout, /Error: no test specified/);
+    assert.strictEqual(child.code, 1);
+  });
+
+  it('adds node_modules/.bin to path', async () => {
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--no-warnings', '--run', `ada${envSuffix}`],
+      { cwd: fixtures.path('run-script') },
+    );
+    assert.match(child.stdout, /06062023/);
+    assert.strictEqual(child.stderr, '');
+    assert.strictEqual(child.code, 0);
+  });
+
+  it('appends positional arguments', async () => {
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--no-warnings', '--run', `positional-args${envSuffix}`, '--', '--help "hello world test"'],
+      { cwd: fixtures.path('run-script') },
+    );
+    assert.match(child.stdout, /--help "hello world test"/);
+    assert.strictEqual(child.stderr, '');
+    assert.strictEqual(child.code, 0);
+  });
+
+  it('should support having --env-file cli flag', async () => {
+    const child = await common.spawnPromisified(
+      process.execPath,
+      [ '--no-warnings', `--env-file=${fixtures.path('run-script/.env')}`, '--run', `custom-env${envSuffix}`],
+      { cwd: fixtures.path('run-script') },
+    );
+    assert.match(child.stdout, /hello world/);
+    assert.strictEqual(child.stderr, '');
+    assert.strictEqual(child.code, 0);
+  });
+
+  it('should properly escape shell', async () => {
+    const { escapeShell } = require('internal/shell');
+
+    const expectations = [
+      ['', '\'\''],
+      ['test', 'test'],
+      ['test words', '\'test words\''],
+      ['$1', '\'$1\''],
+      ['"$1"', '\'"$1"\''],
+      ['\'$1\'', '\\\'\'$1\'\\\''],
+      ['\\$1', '\'\\$1\''],
+      ['--arg="$1"', '\'--arg="$1"\''],
+      ['--arg=node exec -c "$1"', '\'--arg=node exec -c "$1"\''],
+      ['--arg=node exec -c \'$1\'', '\'--arg=node exec -c \'\\\'\'$1\'\\\''],
+      ['\'--arg=node exec -c "$1"\'', '\\\'\'--arg=node exec -c "$1"\'\\\''],
+    ];
+
+    for (const [input, expectation] of expectations) {
+      assert.strictEqual(escapeShell(input), expectation);
+    }
+  });
+});
diff --git a/typings/internalBinding/modules.d.ts b/typings/internalBinding/modules.d.ts
index ddbb3d02704908..86efd6c971ae04 100644
--- a/typings/internalBinding/modules.d.ts
+++ b/typings/internalBinding/modules.d.ts
@@ -26,4 +26,5 @@ export interface ModulesBinding {
     string, // raw content
   ]
   getPackageScopeConfig(path: string): SerializedPackageConfig | undefined
+  getPackageJSONScripts(): string | undefined
 }