使用 MRI 包扫描 CLI 标志和参数

在本文中，提供了 MRI 包的概述以及从 Changesets 源代码中选取的使用示例。

MRI 套餐：

您可以使用 MRI 包快速扫描标志和参数。它是 yargs-parser 的替代品。

安装

npm install - save mri

用法

// Example CLI with options 
$ demo-cli - foo - bar=baz -mtv - hello world

以下代码摘自 MRI npm 包文档。

const mri = require('mri');
const argv = process.argv.slice(2);
mri(argv);
//=> { _: ['hello', 'world'], foo:true, bar:'baz', m:true, t:true, v:true }
mri(argv, { boolean:['bar'] });
//=> { _: ['baz', 'hello', 'world'], foo:true, bar:true, m:true, t:true, v:true }
mri(argv, {
 alias: {
 b: 'bar',
 foo: ['f', 'fuz']
 }
});
//=> { _: ['hello', 'world'], foo:true, f:true, fuz:true, b:'baz', bar:'baz', m:true, t:true, v:true }

了解有关选项的更多信息：

• 别名

• 布尔值

• 默认

本质上，我们将 CLI 参数转换为对象。现在我们了解了 MRI 的基础知识，是时候看看它在变更集中的用法了。

变更集中的 MRI 使用：

发现Changesets CLI包中导入了MRI

当您使用命令 npxchangeset add 或 npxchangeset 添加变更集时，可以在 CLI 包中访问这些变更集，如下所示。

const args = process.argv.slice(2);

解析变更集中的 CLI 参数

下面的代码展示了mri如何在Changeset CLI包中使用

const parsed = mri(args, {
 boolean: ["sinceMaster", "verbose", "empty", "open", "gitTag", "snapshot"],
 string: [
 "output",
 "otp",
 "since",
 "ignore",
 "tag",
 "snapshot",
 "snapshotPrereleaseTemplate",
 ],
 alias: {
 // Short flags
 v: "verbose",
 o: "output",
 // Support kebab-case flags
 "since-master": "sinceMaster",
 "git-tag": "gitTag",
 "snapshot-prerelease-template": "snapshotPrereleaseTemplate",
 // Deprecated flags
 "update-changelog": "updateChangelog",
 "is-public": "isPublic",
 "skip-c-i": "skipCI",
 },
 default: {
 gitTag: true,
 },
});

解析后的值如下所示，我根据文档推断出这一点：

{
 // string value (if you have used 'add' in npx changeset add)
 ['add'],
// boolean values
 "sinceMaster": true, 
 "verbose": true, 
 "empty": true, 
 "open": true, 
 "gitTag": true, 
 "snapshot": true
// string values
 // Note: if you have passed these options in your CLI, these keys will be parsed as string, no matter the what you pass in
 // example: if you pass in - otp=123, 123 here, even though is a number, gets parsed as string since otp is configured to be parsed as
 // string in the above code
 "output",
 "otp",
 "since",
 "ignore",
 "tag",
 "snapshot",
 "snapshotPrereleaseTemplate",
// The alias option in mri allows you to define alternative names (aliases) for CLI arguments.
 // This is particularly useful for supporting:
// Short flags: Such as -v for - verbose.
 // Kebab-case flags: Allowing flags like - since-master to map to camelCase variables in JavaScript (e.g., sinceMaster).
 // Deprecated flags: If you want to support older names for backward compatibility but still map them to the current property names.
}

解析的变量用于从 /run.ts 导入的名为 run 的函数

// run function call
run(parsed._, parsed, cwd).catch((err)

第一个参数是pared._，因为在文档中，规定像'add'这样的解析命令看起来像{ _: ['add']}

// run function definition
export async function run(
 input: string[],
 flags: { [name: string]: any },
 cwd: string
) {

parsed 包含基于 CLI 参数和布尔值、字符串、默认值、别名的配置集的 mri 解析对象。

cwd 是当前工作目录，您可以使用 process.cwd() 获取它

关于我们：

在Thinkthroo，我们研究大型开源项目并提供架构指南。我们开发了使用 Tailwind 构建的可重用组件，您可以在项目中使用它们。我们提供 Next.js、React 和 Node 开发服务。

与我们预约会面讨论您的项目。

参考资料：

1. https://www.npmjs.com/package/mri

2. https://github.com/changesets/changesets/blob/main/packages/cli/src/index.ts#L1C18-L1C21

3. https://github.com/changesets/changesets/blob/main/packages/cli/src/index.ts#L9

以上是使用 MRI 包扫描 CLI 标志和参数的详细内容。更多信息请关注PHP中文网其他相关文章！