开发

开发指南

开发时,本机需要具有 NodeGit 环境,并需要了解 npmNode.jsMQTTTypeScript 等相关知识。

# Fork & Clone 项目
git clone git@github.com:${name}/MQTTX.git

cd MQTTX/cli
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 请求前, 已经仔细阅读过了贡献指南

在此页面