介绍
在前端开发中，我们经常需要执行一些命令行操作。比如构建、打包、测试等等。npm 包 @ninestuff/bin 提供了一种方便的方式，让我们可以在项目中快速使用自定义命令。
@ninestuff/bin 是基于 Node.js 编写的命令行工具，它支持在命令行中自定义占位符来处理参数，并可以在项目中配置命令和脚本，让我们可以快速、灵活地管理项目的命令行操作。
安装
使用 npm 安装 @ninestuff/bin：
npm install @ninestuff/bin --save-dev
快速开始
生成配置
在项目根目录下创建一个 ninestuff.config.js 文件，用于配置 @ninestuff/bin：
-- -------------------- ---- -------
-------------- - -
--------- -
-- ----
--
-------- -
-- ----
--
-------- -
-- ----
-
--命令列表
在 commands 数组中配置我们的命令列表。命令对象包括 command、description、handler 和 options 四个属性：
-- -------------------- ---- -------
-
-- ----
-------- --------
-- ----
------------ ------ --- ---------
-- ------
-------- -- -- -
-- ----
--
-- ------
-------- -
- ----- ---------- ------------ ------ ----- --
- ----- --------- -------- ------------ ------- ----- --
--
--选项列表
在 options 对象中配置我们的选项列表。选项对象包括 name 和 description 两个属性：
{
'--watch': 'Watch mode',
'--config <file>': 'Config file',
}别名列表
在 aliases 对象中配置我们的别名列表：
{
b: 'build',
t: 'test',
}处理参数
在 command 对象的 handler 函数中处理参数。可以使用占位符来获取参数值：
-- -------------------- ---- -------
-
-------- -------
------------ ---- ---- -------
-------- -- -------- ---- -- -- -
----- - ------ -------- - - --------
----- --------- - -----
-- ----
--
-------- -
- ----- ---------- ------------ ------ ----- --
- ----- ------------- ------------ --------- ------- --
--
-运行命令
在 package.json 文件中使用 scripts 字段来运行命令。每个命令都需要在前面加上 bin 命令，例如：
{
"scripts": {
"build": "bin build",
"test": "bin test"
}
}这样我们就可以在命令行中运行 npm run build 和 npm run test 了。
使用选项
选项可以通过命令行参数来传递。例如：
npm run test -- --watch --coverage '**/*.test.js'
使用别名
别名可以用于简化命令的输入。例如：
npm run t -- --watch
示例代码
下面是一个完整的 ninestuff.config.js 文件示例：
-- -------------------- ---- -------
-------------- - -
--------- -
-
-------- --------
------------ ------ --- ---------
-------- -- -- -
---------------------------
-
--
-
-------- -------
------------ ---- ---- -------
-------- -- -------- ---- -- -- -
----- - ------ -------- - - --------
----- --------- - -----
----------------- -------- -------------
-- ------- -
------------------ -------
-
-- ---------- -
--------------------- ---------
-
--
-------- -
- ----- ---------- ------------ ------ ----- --
- ----- ------------- ------------ --------- ------- --
--
--
--
-------- -
---- ----------- ------ ---------
--
-------- -
-- --------
-- -------
--
--结语
@ninestuff/bin 提供了一种方便的方式来管理项目的命令行操作，它使得我们可以自定义命令和选项，并可以使用占位符来处理参数，让我们可以快速、灵活地处理各种任务。希望本文能够帮助你更好地使用 @ninestuff/bin，并在开发过程中起到指导作用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60059bf981e8991b448ed45c