请使用 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 文档分割器无需该项)。
- 修改
package.json中的配置项。 - 在
src/index.ts中实现 DocBasePlugin 接口,其中init为初始化函数,会在插件初始化时运行,插件参数也会被传入该函数;func为处理函数,在 DocLoader 中用于将文件路径处理为AsyncIterable<string>格式文件内容,在 DocSplitter 中用于将文本进行分割。 - 使用
bun run build将你的插件编译,dist/index.js即为你的插件编译物,编译后插件参数的JSON Schema必须在dist/schema.json中一同被分发。 - 使用
npm run publish将你的插件发布到 npm 上。
- 将你插件的 NPM 包名和插件类型添加到 https://github.com/docbase-cc/plugins/blob/main/index.json 中