@mshk-q/cli

Discuz!Q 项目脚手架工具，提供项目初始化、开发、构建和部署能力。

安装

npm install @mshk-q/cli -g

命令

| 命令 | 说明 | |------|------| | dzq init <projectName> | 初始化项目 | | dzq dev | 开发模式 | | dzq build | 构建项目 | | dzq start | 启动 SSR 服务 | | dzq update | 更新核心依赖 | | dzq plugin | 插件开发 | | dzq sls | Serverless 构建 |

使用

初始化项目

# 初始化 web 项目
dzq init my-project

# 初始化小程序项目
dzq init my-project -p mini

init 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | -p, --platform | 平台 (web/mini) | web |

开发

# web 端开发
dzq dev

# 小程序端开发
dzq dev -p mini

# 指定端口和主机
dzq dev -port 8080 -H 127.0.0.1

dev 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | -p, --platform | 平台 (web/mini) | web | | -t, --type | 类型 (weapp) | weapp | | -plugin, --plugin | 私有插件目录 | - | | -port, --port | 端口号 | 3000 | | -H, --hostname | 主机名 | 0.0.0.0 |

构建

# 构建 web 端
dzq build

# 构建小程序端
dzq build -p mini

# 导出静态站点
dzq build -s

build 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | -p, --platform | 平台 (web/mini) | web | | -t, --type | 类型 (weapp) | weapp | | -plugin, --plugin | 私有插件目录 | - | | -s, --staticSite | 导出静态站点 | false |

启动服务

# 启动 SSR 服务
dzq start

# 禁用 SSR（静态模式）
dzq start --no-ssr

start 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | -port, --port | 端口号 | 3000 | | -H, --hostname | 主机名 | 0.0.0.0 | | --no-ssr | 禁用 SSR | - |

插件开发

# 初始化插件
dzq plugin -i

# 开发模式（监听文件变化）
dzq plugin -w

# 构建插件
dzq plugin -b

# 发布插件
dzq plugin -p

# 开启 analyzer
dzq plugin -a

# 开启本地服务
dzq plugin -s

plugin 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | -b, --build | 构建插件 | true | | -p, --publish | 发布插件 | false | | -w, --watch | 监听文件变化 | false | | -s, --server | 开启本地服务 | false | | -a, --analyzer | 开启 analyzer | false | | -i, --init | 初始化插件项目 | false |

Serverless 构建

# 构建 serverless 项目
dzq sls

# 打包为 zip
dzq sls -z

# 上传到 COS
dzq sls -c

sls 选项： | 选项 | 说明 | 默认值 | |------|------|--------| | --no-create | 跳过创建步骤 | - | | -z, --zip | 打包为 zip | false | | -c, --cos | 上传到 COS | false |

更新

# 更新核心依赖
dzq update

依赖

| 依赖 | 版本 | |------|------| | React | 18.x | | Next | 14.x | | Taro | 3.6.x |

License

MIT