从命令行（Node JS）在脚本中运行函数

Question

我正在用 Node.js 编写一个 Web 应用程序。如果我有一些 JS 文件 db.js，其中有一个函数 init，我怎么能从命令行调用该函数？

Answer 1

如果您将db.js 变成一个模块，您可以从db_init.js 中要求它，只需：node db_init.js。

db.js：

module.exports = {
  method1: function () { ... },
  method2: function () { ... }
}

db_init.js：

var db = require('./db');

db.method1();
db.method2();

Answer 2

没有评论您为什么要这样做，或者什么可能是更标准的做法：这是您问题的解决方案....请记住，您的命令行所需的引号类型可能会有所不同。

在您的db.js 中，导出init 函数。方法有很多，但例如：

module.exports.init = function () {
  console.log('hi');
};

然后这样调用它，假设您的db.js 与您的命令提示符位于同一目录中：

node -e 'require("./db").init()'

对于其他读者来说，OP 的 init 函数可以被称为任何东西，这并不重要，它只是问题中使用的特定名称。

Answer 3

试试make-runnable。

在 db.js 中，在末尾添加require('make-runnable');。

现在你可以这样做了：

node db.js init

任何进一步的 args 都会以列表或键值对的形式传递给 init 方法。

Answer 4

2020 年更新 - CLI

正如@mix3d 指出的那样，您可以运行一个命令，其中file.js 是您的文件，someFunction 是您的函数，可选地后跟以空格分隔的参数

npx run-func file.js someFunction "just some parameter"

就是这样。

上例中调用file.js

const someFunction = (param) => console.log('Welcome, your param is', param)

// exporting is crucial
module.exports = { someFunction }

更详细的说明

直接从 CLI 运行（全局）

安装

npm i -g run-func

用法即运行函数“init”，必须导出，见底部

run-func db.js init

或

从 package.json 脚本运行（本地）

安装

npm i -S run-func

设置

"scripts": {
   "init": "run-func db.js init"
}

用法

npm run init

参数

以下任何参数都将作为函数参数传递init(param1, param2)

run-func db.js init param1 param2

重要

函数（在本例中为init）必须导出到包含它的文件中

module.exports = { init };

或 ES6 导出

export { init };

Answer 5

简单的方法：

假设您在项目结构的 helpers 目录中有 db.js 文件。

现在进入 helpers 目录并进入节点控制台

 helpers $ node

2) 需要 db.js 文件

> var db = require("./db")

3) 调用你的函数（在你的例子中是它的 init()）

> db.init()

希望对你有帮助

Answer 6

如果你的文件只包含你的函数，例如：

我的文件.js：

function myMethod(someVariable) {
    console.log(someVariable)
}

像这样从命令行调用它不会发生任何事情：

node myFile.js

但是如果你改变你的文件：

我的文件.js：

myMethod("Hello World");

function myMethod(someVariable) {
    console.log(someVariable)
}

现在这将在命令行中运行：

node myFile.js

Answer 7

根据其他答案，将以下内容添加到someFile.js

module.exports.someFunction = function () {
  console.log('hi');
};

然后您可以将以下内容添加到package.json

"scripts": {
   "myScript": "node -e 'require(\"./someFile\").someFunction()'"
}

然后你可以从终端调用

npm run myScript

我发现这是一种更容易记住命令并使用它们的方法

Answer 8

这个很脏但可以工作:)

我将从我的脚本中调用main() 函数。以前我只是在脚本末尾调用 main 。但是我确实添加了一些其他函数并从脚本中导出它们（以在代码的其他一些部分中使用函数） - 但我不想每次在其他脚本中导入其他函数时都执行 main() 函数。

所以我这样做了， 在我的脚本中，我删除了对 main() 的调用，而是在脚本末尾放置了这个检查：

if (process.argv.includes('main')) {
   main();
}

所以当我想在 CLI 中调用该函数时：node src/myScript.js main

Answer 9

我做一个 IIFE，类似这样的：

(() => init())();

此代码将立即执行并调用 init 函数。

Answer 10

有时你想通过 CLI 运行一个函数，有时你想从另一个模块require 它。以下是如何做到这两点。

// file to run
const runMe = () => {}
if (require.main === module) {
  runMe()
} 
module.exports = runMe

Answer 11

也许这个方法不是你的意思，但谁知道它会有所帮助

index.js

const arg = process.argv.splice(2);

function printToCli(text){
    console.log(text)
}

switch(arg[0]){
    case "--run":
        printToCli("how are you")
    break;
    default: console.log("use --run flag");
}

并运行命令node . --run

命令行

probuss-MacBook-Air:fb_v8 probus$ node . --run
how are you
probuss-MacBook-Air:fb_v8 probus$ 

你可以添加更多的 arg[0] , arg[1], arg[2] ...等等

为node . --run -myarg1 -myarg2

Answer 12

灵感来自https://github.com/DVLP/run-func/blob/master/index.js

我创建https://github.com/JiangWeixian/esrua

如果文件index.ts

export const welcome = (msg: string) => {
  console.log(`hello ${msg}`)
}

快跑

esrua ./index.ts welcome -p world

将输出hello world

Answer 13

如果你想在你的 .env 文件中包含环境变量，你可以使用env-cmd:

npx env-cmd node -e 'require("./db").init()'

如果您也想在文件中运行特定函数，请使用run-func：

npx env-cmd npx run-func db.js init someArg

或者，要为接受的答案提供论据，您必须执行以下操作：

npx env-cmd node -e 'require("./db").init(someArg)'

与为命令提供不同的参数相比，在此处编写/更新表达式不太明确（例如，当您检查时更容易错过），因此我建议将env-cmd 与run-func 一起使用。

注意：我通常也会在必要时在末尾添加--experimental-modules。