karin-plugin-iroha

!to

前言

karin的随缘插件

> 易于使用

🚀 快速开始

``bash
pnpm add karin-plugin-iroha
`

目前功能

- 终末地自动签到
- QQ开放平台数据查询
- 后续..

详细开发流程

1. 一键创建项目

`bash
pnpm create karin
`

- 选择“ts插件开发模板”
- 填写你的插件名称（会自动作为 package.json 的 name）
- 其余信息按提示填写
2. 安装依赖

`bash
pnpm install
`
3. 开发与调试

- 启动开发命令：
`bash
pnpm dev
`
- 编写你的插件代码于 src/ 目录。
- 编译输出：
`bash
pnpm build
`
- 调试编译之后的代码：
`bash
pnpm app
`
- 本地调试建议：
- 可用 pnpm link --global 进行全局软链测试。
- 或在 karin 根目录用 pnpm add ../your-plugin-repo -w 进行本地依赖测试。
4. 配置 NPM 秘钥

> 用于自动化发布，建议开启 2FA。

1. 注册 npmjs 账号。
2. 进入 Access Tokens，新建 Classic Token，类型选 Automation。
3. 复制生成的 Token。
4. 打开你的 GitHub 仓库 → Settings → Secrets and variables → Actions。
5. 新建 NPM_TOKEN，粘贴 Token。
6. 允许 GitHub Actions 创建和批准 PR（Settings → Actions）。
5. 设置包信息

> 包名必须唯一，建议先在 npm 搜索确认。

- 初始化时填写的插件名会自动作为 package.json 的 name，无需手动修改。
- 其他如 author、description、homepage、bugs.url、repository 可在 package.json 中补充完善。
- CI 配置无需再手动修改 package-name，已自动同步。
6. 自动化发布

> 推送代码后，GitHub Actions 会自动编译并发布到 npm。

- 常规开发流程：
1. git add . && git commit -m "feat: ..." && git push
2. 等待 CI 自动发布
3. 发布成功后可在 npm 页面看到新版本
7. 安装与验证

- 在 karin 根目录下安装你的插件：
`bash
pnpm add your-package-name -w
`
- 验证插件是否生效，可查看 karin 启动日志或相关功能。

---

💡 常见问题与建议

- Q: 发布失败怎么办？
- 检查 NPM_TOKEN 是否配置正确，权限是否足够。
- 包名是否唯一，未被占用。
- Actions 日志可定位具体报错。
- Q: 如何本地调试插件？
- 推荐用 pnpm link 或本地依赖安装。
- Q: 如何贡献代码？
- 欢迎 PR，建议先提 issue 讨论。

---

贡献与反馈

- 有任何建议或问题，欢迎在 Issues 提出。
- 也可加入官方交流群交流经验。

`

``