介绍
bz-commando 是一个用 TypeScript 编写的命令行框架。它提供了轻松创建、调试和测试命令行应用程序的功能。此外，bz-commando 还提供了可扩展的中间件机制，使得开发者可以对命令进行定制化扩展。
安装
通过 npm 安装 bz-commando：
npm install bz-commando
快速开始
首先，我们创建一个简单的命令行应用程序，让其输出 "Hello, World!"。
-- -------------------- ---- -------
-------------- ----
------ - --------------- -------- --------------- - ---- --------------
------ ---- ---- -------
----- ------ - --- ----------------
-------------- ---- -- ---------- -
------ ---------------- -- ------ --
---------------- ----- -- -- - ------
---
---------------
----------------------- -- --------
----------------- -- ------
---------- ------- -------- -- ------ -- ---
--
------------------------ -- -----
------------------- -- -------
--- ----- ----------------- ------- ------- - -- ------- ------- -- ----------------- -
------------------- -
------------- -
----- -------- -- ------------- ------ --
------ --------- -- --------
----------- -------- -- ---------------
------------ ----- ------- -- -----
---
-
----- -------- ---------------- - -- ----
------ --------------- --------- -- ----
-
- ---------
---
-------------------- -- -- -
------------------- -- -- ----------------------
---
---------------------------加载命令
需要满足以下两个要求：
- 必须遵循 CommonJS 规范。
- 必须由 JavaScript 或 TypeScript 编写。
命令可以单独写在一个文件中，也可以写在代码文件中。
当文件名为 *.js 时，需要设置 type 属性为 javascript。
当文件名为 *.ts 时，需要安装 TypeScript 并使用 tsc 进行编译。此外，需要将代码文件设置为 CommonJS 规范。
举一个例子，在项目目录下创建一个 commands 文件夹和一个 hello.js 文件：
module.exports = {
name: 'hello',
description: 'Says hello',
execute(message, args) {
message.channel.send('Hello, World!');
},
};在 index.js 中加载命令：
-- -------------------- ---- -------
----- -- - --------------
----- - ------- ---------- - - ----------------------
----- - ------- ----- - - -------------------------
----- ------ - --- ---------
--------------- - --- -------------
----- ------------ - ---------------------------------------- -- ----------------------
--- ------ ---- -- ------------- -
----- ------- - ------------------------------
--------------------------------- ---------
-
-------------------- -- -- -
----------------------
---
-------------------- ------- -- -
-- ------------------------------------ -- ------------------- -------
----- ---- - --------------------------------------------------- ----
----- ----------- - ---------------------------
----- ------- - ---------------------------------
-- ---------- -------
--- -
------------------------ ------
- ----- ------- -
---------------------
-------------------- --- -- ----- ------ -- ------- ---- -----------
-
---
--------------------现在，当输入 !hello 后，会收到 "Hello, World!" 的回复。
命令参数
假设现在要实现一个当指定数字后，返回斐波那契数列的第 n 项数字的命令：
-- -------------------- ---- -------
-------------- - -
----- ------------
------------ ---------- --- --- --------- ---------
----- -----
------ ------
---------------- ----- -
----- - - ------------------
-- ---------- -
------ ------------------- -------- ---- -- -- - ----- ----------
-
----- ------ - -------------
------------------------- ------ --------- ------ -- -------------
--
--
-------- ------------ -
-- -- - -- -
----- --- --------------- ---------
- ---- -- -- - -- -
------ --
- ---- -
------ ----------- - -- - ----------- - ---
-
-现在，当输入 !fibonacci 6 后，会收到 "The 6th Fibonacci number is 8!" 的回复。
命令别名
有时候，为了方便使用，可以为命令添加别名，例如将 !hello 定义为别名 !hi：
module.exports = {
name: 'hello',
description: 'Says hello',
aliases: ['hi'], // 定义别名
execute(message, args) {
message.channel.send('Hello, World!');
},
};现在，当输入 !hi 后，会收到相同的回复。
总结
至此，我们对 bz-commando 的基本使用做了一些介绍。希望以上内容能够对初学者入门有所帮助。同时，如果您有兴趣深入学习 bz-commando，可以通过查看其文档来了解更多的知识。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c8fccdc64669dde5732