@acidjs/cli 中文文档教程

Question

Acid JS - CLI ????

Create command line tools using a simple yargs wrapper.

✅ 设置很少。

✅ 开箱即用。

Install

$ npm install -g @acidjs/cli

Usage

注意：文件夹名为.acid 应该存在于您的项目主目录中。 当您这样做时，您可以配置 cli，并开始创建您的选项和命令。

Create a command:

在名为 .acid/tasks 的目录中创建一个 .js 文件（您可以配置此路径），然后在文件中导出一个包含 4 个条目的数组：

1. Command (string)
2. Description (string)
3. Builder (function)
4. Handler (function)

module.exports = [
    'hello [name]',
    'An example command',
    (yargs) => {}, 
    (argv) => {
        if(argv.name) console.log(`Hey ${argv.name}!`)
    }
]

在命令行中：

所有文件住在 path.resolve('.acid', config.cli.entry.x) 中的将被注册到 yargs。 例如，这是在每个有效命令 (file) 上实际调用的内容：

yargs.command(
  ...require(
    path.resolve(
      '.acid', 
      config.cli.entry.command, 
      file
    )
  )
)

Configure

要覆盖默认值，请在项目的根目录中创建 .acid/config.yml。 如果您的配置文件中有错误，您将收到通知。

默认值：

cli:
  help: true
  color: magenta
  logErrors: true
  entry:
    commands: tasks
    options: tasks/options

License

MIT 许可证

版权所有 (c) 2020 Michael Arakilian

特此免费向任何获得副本的人授予许可 本软件和相关文档文件（“软件”），处理 在软件中不受限制，包括但不限于权利 使用、复制、修改、合并、发布、分发、再许可和/或出售 该软件的副本，并允许该软件是 提供这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在所有 软件的副本或重要部分。

本软件“按原样”提供，不提供任何形式的明示或保证 暗示的，包括但不限于适销性保证， 适用于特定目的和非侵权。 在任何情况下都不得 作者或版权持有人对任何索赔、损害或其他 责任，无论是在合同、侵权或其他方面的行为中，由以下原因引起， 出于或与软件或使用或其他交易有关 软件。