npm 包 argollector 使用教程

阅读时长 5 分钟读完

概述

在开发前端项目时,我们常常需要处理命令行参数,以实现更灵活的工作流程。npm 包 argollector 可以方便地收集和解析命令行参数。

本文将介绍如何使用 argollector 进行命令行参数处理,并且给出一些示例代码。

安装

可以通过 npm 安装 argollector:

基本使用

在使用 argollector 之前,需要进行初始化和配置。

接下来,可以使用 option 方法配置命令行参数的选项。例如:

-- -------------------- ---- -------
--------------------------- -
  ------ ----
  ----- ---------
  --------- ------ ---- ------
---

---------------------------- -
  ------ ----
  ----- ---------
  --------- ------- ---- ------
---

以上代码中,option 方法中的第一个参数为命令行参数的名称,第二个参数则是相应选项的配置。

可以使用 parse 方法解析命令行参数,并获取相应的值。

在命令行中输入以下命令:

则会输出如下结果:

进阶使用

argollector 还支持更多高级的用法,例如:

子命令

可以使用 command 方法定义子命令。例如:

-- -------------------- ---- -------
-----------
  ----------------- -
    ----- ----------
    -------- ------
    --------- ---- ------ --------
  --
  ----------------- -
    --------- ------ ---------
    -------- ------ -- -
      --------------------- --------- ------
    --
  --
  ----------------- -
    --------- ------ ---------
    -------- ------ -- -
      --------------------- --------- ------
    --
  ---

以上代码中,首先定义了一个名为 global 的全局选项。然后定义了两个子命令 buildstart,每个子命令都有一个对应的处理函数。最后,可以使用 parse 方法解析命令行参数,获取相应的子命令和选项。

将会执行 build 命令,并输出如下结果:

校验

可以使用 check 方法校验命令行参数是否符合要求。

-- -------------------- ---- -------
-----------
  ---------------- -
    ----- ---------
    --------- ------ ---- ------
    ------------- -----
  --
  ----------------- -
    ----- ---------
    --------- ------- ---- ------
    ------------- -----
  --
  ------------- -- -
    -- ----------- --- ------------ -
      ----- --- ------------- ---- ------ -- --- ---- -- ----- -------
    -
    ------ -----
  ---

以上代码中,定义了 inputoutput 两个必选选项,并使用 check 方法对选项进行校验,确保它们的值不相同。

自定义类型

可以使用 addHandler 方法自定义类型的解析和校验。例如:

-- -------------------- ---- -------
----------------------------- ------- -- -
  ----- ------ - -----------------
  -- ------------------ -- -------------------- -
    ----- --- ---------- ------ ------ -- ----------
  -
  ------ ---------------- -- ------------- -----
---

----------------------------- -
  ----- ------
  --------- -- ---- -- ---------
---

以上代码中,定义了一个名为 csv 的类型,表示逗号分隔的数字列表。然后可以使用 numbers 选项来接收这样的值。

将会输出如下结果:

总结

argollector 是一个方便的命令行参数处理工具。除了本文介绍的用法之外,argollector 还支持更多功能,例如:

  • 合并选项
  • 自定义帮助信息
  • 自动补全

读者可以通过查看 argollector 的文档来学习更多内容。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/71831

纠错
反馈