npm 包 @oclif/plugin-help 使用教程

在前端开发中，很多项目都会使用一些命令行工具来辅助开发过程，而 @oclif/plugin-help 就是其中一个非常好用的 npm 包。它可以让你的 CLI 应用程序的用户更方便地查看命令的使用方法、参数、输出等信息。

安装

@oclif/plugin-help 可以通过 npm 安装，使用以下命令：

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

配置

在你编写好了一个 CLI 应用程序之后，需要将 @oclif/plugin-help 加入到你的应用程序中。

  1. 首先在你的应用程序中引入 @oclif/plugin-help，可以在命令的入口文件中添加以下代码：

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

  2. 然后，配置 Help 实例，在命令的入口文件中添加以下代码：

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

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

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

使用

输出完整的帮助信息

在编写 CLI 时，你需要在你的命令文件中调用 Help 类生成完整的帮助输出

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

其中，'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

阅读全文

猜你喜欢

  • npm 包 @axetroy/libpack 使用教程

    前言 在 Web 前端开发中，我们经常需要使用各种第三方库和工具，这时候往往需要通过 npm 包管理工具来进行安装和管理。本文将介绍一个比较实用的 npm 包：@axetroy/libpack，它可以...

    5 年前
  • npm 包 @deskproapps/dpat 使用教程

    前端开发中，我们常常需要使用各种各样的工具和库，以提高开发效率或实现更复杂的功能。其中， npm 作为前端最常用的包管理工具，为我们提供了许多第三方的包供我们使用。

    5 年前
  • npm 包 @deskpro/apps-dpat 使用教程

    前言 在前端开发过程中，我们需要依赖不同的库和框架，以简化开发流程并提高开发效率。npm 是一个非常流行的 Node.js 包管理器，它提供了大量的第三方包供我们使用。

    5 年前
  • npm 包 dbmmods 使用教程

    介绍 dbmmods 是一个基于 Node.js 的 npm 包，提供了一些常用的前端开发工具和模块的实现。本文将详细介绍 dbmmods 的使用方法，包括安装、基础使用和一些高级技巧。

    5 年前
  • npm 包 steno 使用教程

    1 简介 npm 是 Node.js 的包管理器，它为开发者提供了一个方便的途径来安装、更新和删除 Node.js 模块。steno 是一个 npm 包，它是一个用于处理文件的 Node.js 模块，...

    5 年前
  • npm 包 react-native-camera-roll-picker 使用教程

    在 React Native 中，我们经常需要使用相册所储存的照片和视频来进行开发。而 react-native-camera-roll-picker 就是一款帮助开发者轻松使用相册中照片和视频的 R...

    5 年前
  • npm 包 rc-swipeout 使用教程

    前言 在前端开发中，我们经常需要开发移动端应用或网站，这时候就需要用到一些移动端特有的组件，例如 swipeout 组件，用于实现滑动删除等操作。在这里，我们将介绍一个 npm 包——rc-swipe...

    5 年前
  • npm 包 rc-slider 使用教程

    在前端开发中，常常需要使用滑动条这种 UI 组件来进行交互。而 npm 包 rc-slider 提供了一个简单易用的滑动条组件，本文将介绍如何使用 rc-slider，并提供一些实例代码，帮助读者快速...

    5 年前
  • npm 包 rc-drawer 使用教程

    前言 在前端开发中，样式库和组件库是不可或缺的利器。而 rc-drawer 是一个非常好用的抽屉式滑动组件，在移动端开发中特别方便。在这篇文章中，我们将学习如何使用 rc-drawer 组件和相关配置...

    5 年前
  • npm 包 rc-collapse 使用教程

    在前端开发中，我们经常需要实现页面元素的收缩和展开，比如折叠菜单、手风琴效果等。而 npm 包 rc-collapse 是一个非常好用的工具，可以帮助我们快速实现这些效果。

    5 年前
  • npm 包 rc-checkbox 使用教程

    前言 在前端开发中，复选框是非常常见的控件，而在 React 项目中，我们可以使用 rc-checkbox 这个 npm 包来实现复选框的功能。本文就是要详细介绍 rc-checkbox 的使用教程。

    5 年前
  • npm包array-tree-filter使用教程

    前言 作为前端开发者，经常会接触到树形结构的数据，这时一个好用的array-tree-filter npm包可以帮助我们高效地过滤出符合条件的数据。本文将为大家介绍array-tree-filter的...

    5 年前
  • NPM包@talentui/cz-project-changelog使用教程

    提供了一种基于commitizen的git commit信息规范化的方式，用于创建项目的CHANGELOG.md。这个规范的设计目的是为了生成人类可读的CHANGELOG，同时也非常适合与自动化发布工...

    5 年前
  • npm 包 ember-cli-groundskeeper 使用教程

    什么是 ember-cli-groundskeeper ember-cli-groundskeeper 是一个拥有代码压缩、混淆和精简能力的 Ember.js 插件。

    5 年前
  • npm包 easy-amdtest 使用教程

    简介 easy-amdtest是一个轻便的JavaScript测试框架，提供了AMD规范的测试接口和丰富的 API，可以让前端开发者更加方便地进行单元测试和集成测试，提高代码质量。

    5 年前
  • npm 包 bbb 使用教程

    简介 npm（Node Package Manager） 是 Node.js 的包管理工具，提供了各式各样的 Node.js 包，使得 Node.js 开发变得更加易用、高效。

    5 年前
  • npm 包 ttys 使用教程

    简介 ttys是一个 npm 包，它可以轻松获取当前 tty 的信息，包括判断当前进程是否在终端上运行，以及获取终端的尺寸等。 安装 使用 npm 进行安装： --- ------- ----使用 引...

    5 年前
  • npm 包 sonar-web-frontend-reporters 使用教程

    在现代 Web 应用程序开发过程中，前端代码几乎与后端代码同等重要。然而，前端开发人员常常面临不同平台、Web 浏览器和设备的兼容性问题。sonar-web-frontend-reporters 是一...

    5 年前
  • npm 包 @pollyjs/persister-fs 使用教程

    前言 在前端开发中，我们经常需要进行数据持久化记录和读取。而 @pollyjs/persister-fs 是一个方便且易于使用的 npm 包，能够帮助我们将 JSON 形式的数据存储到本地文件中，同时...

    5 年前
  • npm 包 @pollyjs/core 使用教程

    什么是 @pollyjs/core ？ @pollyjs/core 是一个用于录制和回放 HTTP 交互的工具包。它通过将 HTTP 请求和响应存储在本地来模拟 HTTP 交互，避免了对网络的依赖。

    5 年前

相关推荐

    暂无文章