在前端开发中，很多项目都会使用一些命令行工具来辅助开发过程，而 @oclif/plugin-help 就是其中一个非常好用的 npm 包。它可以让你的 CLI 应用程序的用户更方便地查看命令的使用方法、参数、输出等信息。
安装
@oclif/plugin-help 可以通过 npm 安装，使用以下命令：
npm i @oclif/plugin-help
配置
在你编写好了一个 CLI 应用程序之后，需要将 @oclif/plugin-help 加入到你的应用程序中。
首先在你的应用程序中引入 @oclif/plugin-help，可以在命令的入口文件中添加以下代码：
const { Help } = require('@oclif/plugin-help')然后，配置 Help 实例，在命令的入口文件中添加以下代码：
-- -------------------- ---- ------- ----- ---- - --- ------ -- ----------- ------------ ----- -- -- ------- --- --- ---- ------------ --------------------- -- ------------------- -- ------- ------ -- -- --------------- ---- ---------- ----------- --------- ---- -- ----------- ---- ---------- ---------- --------- ---- -- -- -- -------------------------- ------------ - -- ------------------------- ------ - ----- -------- ----- ---- ------------ ------ ------ ----- --------- -- ----------- - ------------ ----- ------ ------- -- ------ - ------------ ---- ----- -- ------- -- ------- - ------------ ----- ------- ----- -------- -- -- -- ------------- -- ----------- -- ------------ --- ----------- ------ ---- ------- --------- - ----- - ------------ -------- - -------- ------ ----- ---------- ----- -- ----- -------- -- - -- -- -------------------- ----------- ---- ---- ----------- -- --- -- --- ---- ---- ------ ----- -- --- --------------- --
使用
输出完整的帮助信息
在编写 CLI 时，你需要在你的命令文件中调用 Help 类生成完整的帮助输出
help.showHelp(['commandName'])
其中，'commandName' 参数为选填项。若不给予该参数，则输出默认的帮助信息。
在 CLI 命令中使用
每个命令都将自动继承全局选项，因此在编写每个命令的时候可以根据需要引用 Help 实例。
以下是一些常见的CLI用法，可以在框架或其它应用程序中访问 CLI 命令时使用：
-- -------------------- ---- -------
----- - ---- - - -----------------------------
-- --- ---- ---------------------------
-- ------ ---------- ---- ---------------
-- ----- ---- - --------------------
----- ----------- - --- ------
-- --- --------- ------- --- -- ---------- -- ---- -------
-- ----------------
------------ -- ------- -- ----------- --------------------
----- ------ -------- ---- ------- --- ---- ---------
-- -----------------
----------- ----- ----- ----- ---- ---------
-- ------
------------ -
------ - ----- -------- ----- ---- ------------ ------ ------ ----- --------- --
------ - ------------ ---- ----- -- ------- --
------- - ------------ ----- ------ --
--
-- -----
--------- -
------------ -
------------ -- ---- ---- -- ---- ---------
----- ---- ---- ------- --- ---- ---------
-- ---------
----- -
-
----- -----
--------- -----
------------ --- -- --- ------ -- ------
--
--
--
--
--
-------------- - -
----------- -----------------------
------ ------------------
-- --------
-- --- ------- ----- --- -------
----- --- --------- ------- ------ --------- ------ -------------- --------- -
-- ----------------
----- ----- - ------------------- ------- --
-- ------
-----------------------------------------
-- ------
----- ---- - ------------------------------------
-- ----------------
------------------
-- --------- ------- ------------------
-----------------
-- ---------------------- -------------------- ---
-- -----
-------------
-
-总结
通过上述步骤可以很方便地将 @oclif/plugin-help 集成到你的项目中，并让你的 CLI 应用程序更加友好和易用。
此外，在编写命令和全局选项时，你可以充分利用 @oclif/plugin-help 提供的帮助和提示，将 CLI 的使用方法和参数等信息尽可能地表达清楚，使得最终用户能够更自然、更高效地使用你的应用程序。
以下是一个完整的 CLI 应用程序代码示例：
-- -------------------- ---- -------
-- --------
----- - -------- ----- - - -------------------------
----- - ---- - - -----------------------------
----- - ------- - - -------------------------
----- ---- - --- ------
------------ ----- -- -- ------- --- --- ---- ------------ ---------------------
--------
------------ -
----- ------------ ----- --- ---
-------- --------------- ----- --- ---
------ - ----- -------- ----- ---- ------------ ------ ------ ----- --------- --
----------- - ------------ ----- ------ ------- --
------ - ------------ ---- ----- -- ------- --
------- - ------------ ----- ------- ----- -------- --
--
--------- -
----- -
------------ -------- - --------
------ ----- ----------
----- -- ----- -------- ---
--
--
--
----- ----- ------- ------- -
----- ----- -
----- - ----- - - -----------------
------------------
-
-
----------- - -
----- ------------ ----- --- ---
-------- --------------- ----- --- ---
--------- -------------- ------------ ----- ------- ---
-
---------- - -
- ----- ------ --------- ----- ------------ ---- --- -- ------ --
-
----------
-- - -----
-- ------ ---- ------
-- - ----- ------
-- ------ ---- ------
-- - ----- ---- ------
-- ------ ---- ------希望通过本文，您能够更加深入地了解 @oclif/plugin-help 的使用方法，让你的 CLI 应用程序变得更加友好和易用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/89577