Quickly create Halo plugin development templates
npm install create-halo-plugin简体中文 | English
🚀 快速创建 Halo 插件开发模板
一个用于创建 Halo 插件项目的脚手架工具，提供现代化的开发环境。
- 🎯 交互式命令行 - 通过提示引导项目设置
- 🏗️ 现代构建工具 - 可选择 Vite 或 Rsbuild 进行 UI 开发
- 📦 完整项目结构 - 预配置的 Gradle 构建、UI 设置和插件清单
- 📝 TypeScript 支持 - 完整的 TypeScript 配置用于 UI 开发
使用以下任一命令创建新的 Halo 插件项目：
``bashnpm
npm create halo-plugin
npm create halo-plugin my-plugin
使用示例
$3
bash
pnpm create halo-plugin
创建一个名为 "plugin-{你的插件名}" 的目录
`$3
bash
pnpm create halo-plugin my-awesome-plugin
在 "./my-awesome-plugin" 目录中创建项目
`$3
CLI 将引导你完成设置过程：
bash
🚀 欢迎使用 Halo 插件创建器！✔ 插件名称: › my-awesome-plugin
✔ 域名 (用于组和包名): › com.example
✔ 作者姓名: › Ryan
✔ 是否包含 UI 项目? › 是
✔ 选择 UI 构建工具: › Vite
📋 项目配置:
名称: my-awesome-plugin
域名: com.example
包名: com.example.myawesomeplugin
作者: Ryan
包含 UI: 是
UI 工具: vite
输出目录: /path/to/my-awesome-plugin
✔ 创建项目? › 是
`$3
如果你的插件不需要用户界面，可以通过命令行参数跳过 UI 项目的创建：
bash
pnpm create halo-plugin my-backend-plugin --name=my-backend-plugin --domain=com.example --author="张三" --includeUI=false
`或者在交互式设置中选择 "否" 来跳过 UI 项目创建。
项目结构
$3
bash
my-plugin/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/example/myplugin/
│ │ │ └── MyPluginPlugin.java
│ │ └── resources/
│ │ ├── plugin.yaml
│ │ └── logo.png
│ └── test/
│ └── java/
│ └── com/example/myplugin/
│ └── MyPluginPluginTest.java
├── ui/
│ ├── src/
│ │ ├── index.ts
│ │ ├── views/
│ │ └── assets/
│ ├── package.json
│ ├── vite.config.ts (或 rsbuild.config.ts)
│ └── tsconfig.json
├── build.gradle
├── settings.gradle
├── gradlew
└── README.md
`$3
bash
my-plugin/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── com/example/myplugin/
│ │ │ └── MyPluginPlugin.java
│ │ └── resources/
│ │ ├── plugin.yaml
│ │ └── logo.png
│ └── test/
│ └── java/
│ └── com/example/myplugin/
│ └── MyPluginPluginTest.java
├── build.gradle
├── settings.gradle
├── gradlew
└── README.md
`开发
$3
创建项目后：
bash
进入项目目录
cd my-plugin启动 Halo 开发服务器
./gradlew haloServer在另一个终端中，启动 UI 开发
cd ui
pnpm dev
`$3
对于不包含 UI 的项目：
bash
进入项目目录
cd my-plugin启动 Halo 开发服务器
./gradlew haloServer
`系统要求
- Node.js >= 18.0.0
- Java >= 21
- Halo >= 2.21.0
插件名称规则
插件名称必须遵循以下模式：
- 以字母数字字符 (a-z, 0-9) 开头和结尾
- 中间可以包含连字符 (-) 和点 (.)
- 只允许小写字母
- 示例：
、blog.comment、user-managementUI 构建工具
在两个现代构建工具中选择：
$3
- 🔧 简单配置
- 📦 优化构建
$3
- 🚀 基于 Rspack 的高速构建
- 🛠️ 丰富的插件生态
- 📊 更好的构建性能
- 📦 支持代码分割，适用于更加大型的插件项目
命令行选项
bash
显示帮助
npx create-halo-plugin --help显示版本
npx create-halo-plugin --version使用命令行参数创建项目
npx create-halo-plugin my-plugin \
--name=my-plugin \
--domain=com.example \
--author="张三" \
--includeUI \
--uiTool=rsbuild创建不包含 UI 的项目
npx create-halo-plugin my-backend-plugin \
--name=my-backend-plugin \
--domain=com.example \
--author="张三" \
--includeUI=false
`可用选项：
-
- 插件名称
- -d, --domain - 域名（用于组和包名）
- -a, --author - 作者名称
- -i, --includeUI - 是否包含 UI 项目
- -u, --uiTool - UI 构建工具 (rsbuild 或 vite，当 includeUI 为 true 时需要)
- -h, --help - 显示帮助信息
- -v, --version` - 显示版本号我们欢迎贡献！请查看我们的 贡献指南 了解详情。