typescript - 如何使用 Typescript 创建自定义 CLI 工具

Question

我刚刚编写了一个.json使用 Typescript 转换不同文件格式的程序。

但我使用固定文件路径来读取它。

const file = readFileSync('./name_of_file_path.json', 'utf-8'); // fix file path.
file_obj = JSON.parse(file);
// more code ...

我想知道可以使程序成为CLI工具，使文件路径更灵活。

用户只需要在命令提示符类型：

converter_json [-someFlagOption] ./folder/random_json_file_path.json

然后程序将.json像这样获取用户的文件路径：

function func_user_file_path(){ // some function like this? 
    return real_user_json_filepath;
}
var file_path_input: string; 
file_path_input = func_user_file_path() //dynamic file path (user input)
const file = file_path_input; 
file_obj = JSON.parse(file);
// more code ...

所以我的问题是如何做到这一点？

标签： typescriptcommand-line-interface

Answer 1

TypeScript 被编译成 JavaScript，由 NodeJS 执行。要创建一个基本的 cli，您将创建一个 npm 包，（可选地）发布它，然后用户将在他们的机器上安装该包（npm install -g）以便能够调用它。有许多库可以帮助您解析命令行参数和控制台输入/输出。

这是一个快速教程：https ://walrus.ai/blog/2019/11/typescript-cli/