https://github.com/karinjs/plugins-list
https://github.com/karinjs/plugins-list
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/karinjs/plugins-list
- Owner: KarinJS
- Created: 2025-01-20T00:27:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-30T15:56:52.000Z (7 months ago)
- Last Synced: 2025-12-02T22:46:32.585Z (7 months ago)
- Language: JavaScript
- Size: 186 KB
- Stars: 1
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Karin 插件仓库
这是 Karin 的官方插件仓库，用于收集和管理社区贡献的插件。
## 目录
- [插件列表](#插件列表)
- [提交插件](#提交插件)
- [插件规范](#插件规范)
## 插件列表
你可以在 [plugins.json](./plugins.json) 中查看所有可用的插件。
## 提交插件
### 前置条件
1. 确保你的插件符合规范要求
2. 确保你的插件遵循 [插件规范](#插件规范)
3. 准备好插件的相关信息
### 提交步骤
1. Fork 本仓库
2. 在 `plugins.json` 文件中添加你的插件信息
3. 提交 Pull Request
4. 等待自动化检查和审核
### 插件信息格式
每个插件需要提供以下信息：
#### 必填字段
| 字段名 | 类型 | 描述 | 示例 |
| ----------- | ------ | ------------------------------ | ------------------------ |
| name | string | 插件包名 | "karin-plugin-basic" |
| type | string | 插件类型 | "npm" \| "git" \| "app" |
| description | string | 插件描述（限制50字符） | "karin plugin basic" |
| time | string | 发布时间 (YYYY-MM-DD HH:mm:ss) | "2025-01-19 10:00:00" |
| license | object | 开源协议信息 | 见下方示例 |
| home | string | 插件主页 | https://github.com/sj817 |
#### 许可证信息 (license)
| 字段名 | 类型 | 描述 | 示例 |
| ------ | ------ | ---------- | --------------------------------------------------------------- |
| name | string | 许可证名称 | "MIT" |
| url | string | 许可证地址 | https://github.com/karinjs/karin-plugin-basic/blob/main/LICENSE |
#### 作者信息 (author)
作者信息是一个数组，支持多个作者：
| 字段名 | 类型 | 描述 | 示例 |
| ------ | ------ | -------- | ------------------------ |
| name | string | 作者名称 | shijin |
| home | string | 作者主页 | https://github.com/sj817 |
#### 仓库信息 (repo)
仓库信息是一个数组，支持多个仓库：
| 字段名 | 类型 | 描述 | 示例 |
| ------ | ------ | ---------------------------------------------------------------- | --------------------------------------------- |
| type | string | 仓库类型 ("github" \| "gitee" \| "gitcode" \| "gitlab" \| "npm") | "github" |
| url | string | 仓库地址 | https://github.com/karinjs/karin-plugin-basic |
| branch | string | 默认分支（npm类型为空字符串） | "main" |
#### 主页信息 (home)
| 字段名 | 类型 | 描述 | 示例 |
| ------ | ------ | -------- | ------------------------ |
| home | string | 主页地址 | https://github.com/sj817 |
### 插件类型说明
1. **NPM 插件** (`type: "npm"`)
- 通过 npm 包方式发布的插件
- 可选参数：
- `allowBuild`: 字符串数组，指定允许pnpm在安装期间执行脚本的包名列表，可不填写
2. **Git 插件** (`type: "git"`)
- 通过 git 仓库方式发布的插件
3. **App 插件** (`type: "app"`)
- 单应用插件，需要提供文件直链地址
- 需要在配置中添加 `files` 字段，包含应用文件的直链地址
## 注意事项
- 请确保将新插件添加到 `plugins` 数组中
- name 必须是唯一的
- description 长度限制为 50 字符
- 对于 App 类型插件，建议提供多个下载源以提高可用性
- 所有仓库源都必须提供`package.json` 并且包含`name` 和 `version` 字段
### 示例
在 `plugins.json` 文件中的 `plugins` 数组中添加你的插件信息。以下是不同类型插件的示例：
```json
{
"plugins": [
{
"name": "karin-plugin-basic",
"type": "npm",
"description": "karin plugin basic",
"home": "https://github.com/karinjs/karin-plugin-basic",
"license": {
"name": "MIT",
"url": "https://github.com/karinjs/karin-plugin-basic/blob/main/LICENSE"
},
"time": "2025-01-19 10:00:00",
"author": [
{
"name": "shijin",
"home": "https://github.com/sj817"
}
],
"repo": [
{
"type": "github",
"url": "https://github.com/karinjs/karin-plugin-basic",
"branch": "main"
},
{
"type": "npm",
"url": "https://www.npmjs.com/package/karin-plugin-basic",
"branch": ""
}
],
"allowBuild": ["esbuild", "sqlite3"]
},
{
"name": "karin-plugin-git-example",
"type": "git",
"description": "这是一个 Git 插件示例",
"home": "https://github.com/username/karin-plugin-git-example",
"license": {
"name": "MIT",
"url": "https://github.com/username/karin-plugin-git-example/blob/main/LICENSE"
},
"time": "2024-03-19 10:00:00",
"author": [
{
"name": "作者名字",
"home": "https://github.com/username"
}
],
"repo": [
{
"type": "github",
"url": "https://github.com/username/karin-plugin-git-example",
"branch": "main"
},
{
"type": "gitee",
"url": "https://gitee.com/username/karin-plugin-git-example",
"branch": "master"
}
]
},
{
"name": "karin-plugin-app-example",
"type": "app",
"description": "这是一个 App 插件示例",
"home": "https://github.com/username/karin-plugin-app-example",
"license": {
"name": "GPL-3.0",
"url": "https://github.com/username/karin-plugin-app-example/blob/main/LICENSE"
},
"time": "2024-03-19 10:00:00",
"author": [
{
"name": "作者名字",
"home": "https://github.com/username"
}
],
"repo": [
{
"type": "github",
"url": "https://github.com/username/karin-plugin-app-example",
"branch": "main"
}
],
"files": [ // 这里可以添加多个文件
{
"name": "karin-plugin-app-example.js",
"url": "https://mirror.example.com/download/karin-plugin-app-example.js"
}
]
}
]
}
```
## 许可证
本仓库采用 MIT 许可证
## 预览
### npm
```bash
https://registry.npmjs.com/@karinjs/plugins-list/latest
```
### npmmirror
```bash
https://registry.npmmirror.com/@karinjs/plugins-list/latest
```