Async 主包装
一个简单的工具,用于将 Cli 工具基于 Async 方法.
// cli.js
const wrap = require("@gustavnikolaj/async-main-wrap");
const main = require("./main.js");
wrap(main)(process.cwd(), process.argv.slice(2));
// main.js
module.exports = async function cliTool(cwd, args) {
if (!condition) {
throw new Error("foo!"); // Will exit the CLI tool with status code 1.
}
console.log("All done!");
};
这个工具背后的动机是 我厌倦了写同样的台词 包装我的主要方法 小cli公用事业.
除了小而简单,这个工具还使测试你的 Cli 工具 a 很简单 你不必通过命令线来测试 它,你可以简单的测试你的主要方法.
下列规则适用于主要方法:
- 他们应该返回一个承诺(或者,你知道的,是一个主动函数).
- 如果它们用数字退出属性投出一个错误 当关闭进程时.
这两份文件都有其实例 examples 目录和目录
test/__fixtures__固定装置包含一些不同用途的例子,但
一般来说 大部分会像顶级的榜样 最好的
更真实世界的实施很可能是
光标示例。 。 。 .
提示
通过您的输出通道
在你通过的辩论上 没有什么聪明的事 无论你通过什么
被包裹的方法 传递到你的实际方法。 如果你想让
测试更简单的输出,你可以通过 console 对象.
// cli.js
const wrap = require("@gustavnikolaj/async-main-wrap");
const main = require("./main.js");
wrap(main)(process.cwd(), process.argv.slice(2), console);
// main.js
module.exports = async function cliTool(args, console) {
const name = args[0] || "world";
console.log(`Hello, ${name}!`);
};
// main.spec.js
it("should say hello world", async () => {
const logs = [];
const mockConsole = {
log(message) {
logs.push(message);
}
};
await main([], mockConsole);
expect(logs, "to equal", ["Hello, world!"]);
});
it("should say hello Gustav", async () => {
const logs = [];
const mockConsole = {
log(message) {
logs.push(message);
}
};
await main(["Gustav"], mockConsole);
expect(logs, "to equal", ["Hello, Gustav!"]);
});
你也可以通过原始的 process.stdout 或者说 process.stderr 溪流,如果
你想更严格地控制.
用参数解析器
您可以使用任何您喜欢的参数解析器, 我这里使用 yargs 作为示例 :
// cli.js
const wrap = require("@gustavnikolaj/async-main-wrap");
const main = require("./main.js");
wrap(main)(process.cwd(), process.argv.slice(2));
// main.js
const yargs = require("yargs");
module.exports = async function main(cwd, args) {
const argv = yargs(args).argv;
if (argv.help) {
printHelp();
return;
}
// ...
console.log("Done!");
};
与 esm 有关的工作
Es模块的节点"polyful": 风向
// cli.js
require = require("esm")(module);
const wrap = require("@gustavnikolaj/async-main-wrap");
const main = require("./main").default;
wrap(main)(process.cwd(), process.argv.slice(2));
// main.js
export default async function main(cwd, args) {
// ...
}
Shebang( 如何看起来像一个真正的外壳工具)
这个 #! 文件上方的行将告诉 shell 如何执行
脚本,意思是您不再需要使用 node
二进制.
#!/usr/bin/env node
const wrap = require("@gustavnikolaj/async-main-wrap");
const main = require("./main.js");
wrap(main)(process.cwd(), process.argv.slice(2));
为此您需要给出脚本可执行权限 。 这可以 在Linux和Mac上这样做:
$ chmod +x my-awesome-tool
打印前修改错误
有时你会想在打印错误之前做点什么.
例如 无变化 模块将投掷
自定义属性出错 framesToPop 错误处理器可以用作一个
从堆栈跟踪中删除框架的提示 - 模块将自己放入顶端
任何堆栈追踪,因为它是如何运作的。 使用模块
帧弹出器 您可以删除
那些额外的堆放框.
#!/usr/bin/env node
const wrap = require("@gustavnikolaj/async-main-wrap");
const framePopper = require("@gustavnikolaj/frame-popper");
const main = require("./framePopper-main");
wrap(main, { processError: err => framePopper(err) })();
自定义对人友好的错误输出
设置一个 customOutput 属性,您可以覆盖输出
由 async-main-wrap设置 DEBUG 环境变量
禁用 customOutput- 基于输出并打印全部细节.
可以与 processError 选项以生成友好错误
所有你的错误.
// main.js
module.exports = async function(/* ... */) {
// ...
const err = new Error("Such an unfriendly error message");
err.customOutput = "So friendly, but still an error!";
throw err;
// ...
};
$ cli
So friendly, but still an error!