开发

开发指南

开发环境使用 Git、Yarn 和 Node.js 18，版本见 cli/.nvmrc。切换分支时，请核对对应的 .nvmrc 和 cli/package.json。建议了解 Node.js、MQTT 和 TypeScript 等相关知识。

如需贡献代码，请先 Fork 仓库，并将下方克隆地址替换为自己的 Fork 地址。如果使用 nvm，可按示例运行 nvm use；使用其他版本管理器时，请先切换到所需的 Node.js 版本。

# 克隆项目
git clone https://github.com/emqx/MQTTX.git

cd MQTTX/cli
nvm use
yarn install

# 编译和热重载以进行开发
yarn run dev

# 编译和压缩以构建生产版本
yarn run build

开发时，可以使用 yarn link 命令将 MQTTX CLI 链接到全局，方便调试。

构建成功后，会在 dist 目录里出现构建成功的相应的文件，需要在 Node.js 环境中使用。

如果需要打包一个二进制可执行文件，请参考以下命令：

# 全局安装 pkg
npm install pkg -g

# 构建二进制可执行文件
pkg package.json

构建成功后，在 release 目录里可以看到对应各系统的二进制可执行文件了。

贡献

请确保在发出 PR 请求前， 已经仔细阅读过了贡献指南