karin plugin chaite
npm install karin-plugin-chaitets插件的开发较为繁琐,但请不要着急,容我娓娓道来~
- TypeScript 开发编写 -> 编译为js -> 发布 npm 包 -> 用户安装
> 需要注意 请先安装karin哦~
打开模板仓库
点击Use this template或使用此模板按钮,创建自己的仓库。
!202404121412587
填写仓库名称,描述,选择是否公开。
!202404121414580
``bash`请改成你自己的仓库 注意! 现在是克隆成单独的文件夹 而不是以前一样作为插件
git clone https://github.com/karinjs/karin-plugin-template-ts.git
`bash`
pnpm install
`bash`
npx karin ts
`bash`编译
npm run buildor
pnpm build
> 需要1个基本的npm秘钥
1. 前往npmjs注册账号
2. 注册完成点击右上角头像 -> Access Tokens -> Granular Access Token -> Classic Tokentoken
3. 填写的name,选择Automation,如下图Generate Token
!npm
4. 随后点击即可Fork
5. 打开Github,请自行登录账号。
6. 打开你刚才的仓库,点击Settings(设置) -> Secrets and variables(机密和变量) -> actions(操作)Repository secrets(仓库机密)
7. 选择,点击New repository secret(新建仓库机密)Name (名称 )
8. 输入 NPM_TOKEN , Secret (机密 ) 输入你刚才得到的npm秘钥,随后保存即可。github-actions
9. 允许发起pr,打开仓库主页,点击Settings(设置) -> Actions(操作) -> 勾选Allow GitHub Actions to create and approve pull requests(允许 GitHub Actions 创建和批准拉取请求) -> Save(保存)
这里的步骤很长,请仔细认真一步步来,npm的秘钥,获取一次之后,多个仓库都可以重复使用,建议npm账户打开2FA
> [!IMPORTANT]
> 对于包名,请自行查看npm上是否已经冲突,npm的包名必须是唯一的。
你需要更改以下这些选项:
- package.json:name
- : 改成npm包名,请注意使用全部小写author
- : 改成你的名字,需要英文哦description
- : 改成插件描述homepage
- : npm显示的主页bugs.url
- : 反馈bugrepository
- : 指定项目的代码存储库地址.github/workflows/release-please.yml
- :package-name
- 修改其中的,注意,这里需要和上面package.json的一致。
> 对于更多选项,请自行查看注释。
> [!IMPORTANT]
> 编写好代码之后,正常git pull,随后等待几秒钟,合并pr即可。
利用Gihub提供的actions来编译,推送npm。
`bash``在karin根目录执行
pnpm add package.name -w