Skip to content

docbase-cc/plugin-template

Repository files navigation

DocBase 插件模板

请使用 bun 开发插件

插件配置

插件配置项在 package.json 中配置,以下是每个配置项的含义:

  • "name": 定义了包的名称。这个名称是唯一的,用于在 npm 或其他包管理系统中标识该包,规则为 docbase-plugin-docloader/docsplitter-你的包名
  • "displayName": 包的显示名称,在插件市场中展示给用户。
  • "version": 指定了包的版本号,遵循语义化版本规范(SemVer)。
  • "description": 包的简要描述,用于向用户解释该包的用途和功能。
  • "author": 包的作者信息,包含作者姓名和电子邮件地址。
  • "pluginType": 自定义的插件类型,可选文档加载器(DocLoader)和文档分割器(DocSplitter)。
  • "homepage": 包的主页 URL,通常指向该包的官方网站或项目页面。
  • "repository": 包的代码仓库地址,方便用户查看和贡献代码。
  • "icon": 包的图标 URL,用于在用户界面中显示该包的图标。
  • "exts": 支持的文件扩展名列表,表明该 DocLoader 插件需要处理哪些拓展名的文件,不带 . ( DocSplitter 文档分割器无需该项)。

插件开发

  1. 修改 package.json 中的配置项。
  2. src/index.ts 中实现 DocBasePlugin 接口,其中 init 为初始化函数,会在插件初始化时运行,插件参数也会被传入该函数;func 为处理函数,在 DocLoader 中用于将文件路径处理为 AsyncIterable<string> 格式文件内容,在 DocSplitter 中用于将文本进行分割。
  3. 使用 bun run build 将你的插件编译,dist/index.js 即为你的插件编译物,编译后插件参数的 JSON Schema 必须在 dist/schema.json 中一同被分发。
  4. 使用 npm run publish 将你的插件发布到 npm 上。

插件注册

  1. 将你插件的 NPM 包名和插件类型添加到 https://github.com/docbase-cc/plugins/blob/main/index.json

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published