404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
前面一节已对 kotori.yml 有了大概认识，本节内容将更为全面的介绍它。kotori.yml 是一个 Kotori 程序的核心配置文件，它一般位于 Kotori 根目录，与 package.json 文件同级，使用 YAML 格式。
关于 YAML 格式的语法与规范请参考 YAML 入门教程
以下是将先前的配置片段集中在一起的例子（仅作参考请勿直接复制）：
global:
+ lang: zh_CN
+ command-prefix: /
+ dirs:
+ - ./node_modules/
+ - ./node_modules/@kotori-bot/
+ # 上面为默认配置的加载目录
+ - ./node_modules/@custom-scope/
+ - ./test_modules
+
+adapter:
+ cmd-test:
+ extends: cmd
+ master: 2333
+ nickname: Kotarou
+ age: 18
+ sex: male
+ self-id: 720
+
+ kisaki:
+ extends: qq
+ appid: "xxxx"
+ secret: "xxxxx"
+ master: 2333
+ retry: 10
+
+plugin:
+ console:
+ filter: {}
+ test: 1
+
+ menu:
+ alias: cd
+ keywords: [ 菜单, 功能, 帮助]
+ content: 菜单 | 小鳥%break%/menu - 查看BOT菜单%break%/hitokoto - 获取一条一言%break%ByHotaru定义全局使用的语言，目前仅支持英语、日语、台湾语、中文四门语言。
LocaleType，'en_US'type LocaleType = 'en_US' | 'ja_JP' | 'zh_TW' | 'zh_CN';定义全局使用的命令前缀。
'/'定义需要加载的模块目录。
['./node_modules/', './node_modules/@kotori-bot/']定义全局使用的过滤器，目前过滤器功能正在实现中，该项暂时无实际效果。
定义 Bot。
{ [botName: string]: AdapterConfig }{}interface AdapterConfig {
+ extends: string;
+ master?: number;
+ lang?: langType;
+ 'command-prefix'?: string;
+ [propName: string]?: unknown;
+}定义该 Bot 使用的适配器。
定义该 Bot 的最高管理员 id（即该用户在平台的 id）。
定义该 Bot 使用的语言。
LocaleType，global.lang定义该 Bot 使用的命令前缀。
global['command-prefix']除去以上由 Kotori 内部定义的配置项，extends 中指定的适配器一般会额外定义配置项用于 Bot 内部，这些配置项也可能不存在或为可选，具体请参考该模块的详情页。
定义插件的配置项。
{ [pluginName: string]: PluginConfig }{}interface PluginConfig {
+ filter?: {};
+ [propName: string]?: unknown;
+}定义该插件使用的过滤器。
类似于 AdapterConfig 中的 [propName]，该插件也可能会定义一些配置项用于插件内部，具体请参考该模块的详情页。
跨平台 得益于模块化支持，通过编写各种模块实现不同的功能与聊天平台接入
解耦合 基于控制反转（IOC）与面向切面编程（AOP）思想，减少代码冗余与复杂度
现代化 使用现代化的 ECMAScript 语法规范与强大的 TypeScript 类型支持
模块（Modules） 是 Kotori 的重要组成部分之一，通过使用模块以扩展各式各样的功能。
模块根据功能与应用范围不同，主要分为以下三大类型：
Kotori 模块中心 内收录了大部分 Kotori 模块。选择所需模块，在详情页中会有插件的基础信息、介绍、使用说明、配置说明等。
此处以「QQ 适配器服务模块」（@kotori-bot/kotori-plugin-adapter-qq）为例。
模块的包名除去
@xxx/的部分（如果有），会有一段相似的开始字段，将其称之为「模块前缀」。通过模块前缀可判断模块类型，如「kotori-plugin-adapter-xxx」表示适配器服务，「kotori-plugin-database-xxx」表示数据库服务，「kotori-plugin-xxx」表示插件或自定义服务，详细内容请参考 开发文档 - 插件范式。
复制模块详情页里中的安装指令，或手动输入对应模块的 npm 包名，在 Kotori 根目录运行：
pnpm install @kotori-bot/kotori-plugin-adapter-qq该方法仅在必要情况下建议使用。
在模块详情页里跳转至对应的 npm 地址或 GitHub 地址，下载模块的构建产物。 解压压缩包并移动至 Kotori 根目录下的 ./modules/ 内。
GitHub 仓库中存有模块的源码，在当前阶段，你应下载并使用模块的构建产物而非源码。
务必确保解压后的模块文件夹仅有一层文件夹而非多层，否则将无法识别与加载模块。
模块安装在
./modules目录内请忽略该步骤。
通过包管理工具安装的模块一般会安装在 Kotori 根目录下的 ./node_modules/ 内，如若插件包名带有 @xxx/ 的前缀，表示为包的命名空间，上述示例模块中的「@kotori-bot/」为 Kotori 官方包的命名空间，表示官方模块，其余的命名空间或无命名空间的模块为社区模块。
所有未安装在 ./modules/ 都应配置 kotori.yml 的 global.dirs 项以设置额外的加载根目录，但对于 ./node_modules/ 与 @kotori-bot/ 命名空间已经存在于 Kotori.yml 默认配置中，因此无需担心。
对于其它安装目录或命名空间则需手动添加到 Kotori.yml 中，如：
@custom-scope/ 的模块./test_modules/ 内对应配置为：
global:
+ dirs:
+ - ./node_modules/
+ - ./node_modules/@kotori-bot/
+ # 上面为默认配置的加载目录
+ - ./node_modules/@custom-scope/
+ - ./test_modules根据安装的模块类型不同，配置策略也将不同。
插件配置数据应写在 kotori.yml 的 plugin.<plugin-name> 项下，其中 <plugin-name> 为插件名字，不应含有包的命名空间与模块前缀，值必须是一个对象。插件的配置项由插件本身提供与指定，并非所有插件本身都会提供配置项。一般地，有提供配置项的插件内都会有一套默认配置，因此不配置也可以正常运行插件。插件的配置和说明可参考该插件的详情页，此处以 「菜单插件」（@kotori-bot/kotori-plugin-menu）为例，在详情页查看配置说明后在 kotori.yml 中配置相关内容：
plugin:
+ menu:
+ alias: cd
+ keywords: [菜单, 功能, 帮助]
+ content: 菜单 | 小鳥%break%/menu - 查看BOT菜单%break%/hitokoto - 获取一条一言%break%ByHotaru适配器配置数据应写在 kotori.yml 的 adapter[instanceName] 项下，其中 instanceName 为适配器实例（以下简称「Bot」）名字应由小写英语字母、数字、连字符（[a-z0-9]）组成，值必须是一个对象。适配器的配置数据不会作用于适配器模块，Kotori 会根据配置数据创建对应 Bot。对于适配器的配置，必须提供一些必要配置项才能确保实例的正常运行，其中有部分配置项由 Kotori 内部定义，如：
adapter:
+ cmd-test:
+ extends: cmd
+ master: 2333「cmd-test」是该 Bot 的名字也是在 kotori 程序运行中的唯一标识符，不可重复。extends 用于指定该实例使用的适配器，值为适配器模块的包名除去命名空间与适配器服务前缀的字符串，如：使用「@kotori-bot/kotori-plugin-adapter-qq」适配器，则应填入「qq」。master 用于指定该实例的最高管理员（Admin），值类型可为数字或字符串，非必填。 除去由 Kotori 内部定义的配置项以外，一般还需要填入该适配器要求传入的必要配置项。
adapter:
+ cmd-test:
+ extends: cmd
+ master: 2333
+ nickname: Kotarou
+ age: 18
+ sex: male
+ self-id: 720cmd 适配器即「@kotori-bot/kotori-plugin-adapter-cmd」，属于 kotori 预装模块之一，为 kotori 程序当前所在控制台提供聊天交互功能，也是最方便的测试机器人的场所（但并不推荐，因为只支持文字交互，模块开发有更好的测试场所选择，详细内容请参考 开发文档 - 项目构建）。
不过此处使用的 cmd 适配器定义的配置项均有默认值因此为可选。接着使用「@kotori-bot/kotori-plugin-adapter-qq」适配器再创建一个 Bot：
adapter:
+ cmd-test:
+ extends: cmd
+ master: 2333
+ nickname: Kotarou
+ age: 18
+ sex: male
+ self-id: 720
+
+ kisaki:
+ extends: qq
+ appid: 'xxxx'
+ secret: 'xxxxx'
+ master: 2333
+ retry: 10查看 QQ 适配器的详情页面可知，appid 、 secret 为其定义的必要配置项，retry 为其定义的可选配置项，关于 QQ 适配器的具体使用与配置项含义请查看其插件详情页。
`,41),l=[e];function p(h,k,o,d,r,c){return a(),i("div",null,l)}const y=s(t,[["render",p]]);export{g as __pageData,y as default}; diff --git a/assets/basic_modules.md.BM1hIfQJ.lean.js b/assets/basic_modules.md.BM1hIfQJ.lean.js new file mode 100644 index 00000000..4e5569d7 --- /dev/null +++ b/assets/basic_modules.md.BM1hIfQJ.lean.js @@ -0,0 +1 @@ +import{_ as s,c as i,o as a,V as n}from"./chunks/framework.Dy019jra.js";const g=JSON.parse('{"title":"模块安装","description":"","frontmatter":{},"headers":[],"relativePath":"basic/modules.md","filePath":"basic/modules.md","lastUpdated":1707642172000}'),t={name:"basic/modules.md"},e=n("",41),l=[e];function p(h,k,o,d,r,c){return a(),i("div",null,l)}const y=s(t,[["render",p]]);export{g as __pageData,y as default}; diff --git a/assets/basic_start.md.BcMzOQtP.js b/assets/basic_start.md.BcMzOQtP.js new file mode 100644 index 00000000..32865ded --- /dev/null +++ b/assets/basic_start.md.BcMzOQtP.js @@ -0,0 +1,21 @@ +import{_ as s,c as a,o as i,V as n}from"./chunks/framework.Dy019jra.js";const E=JSON.parse('{"title":"快速开始","description":"","frontmatter":{},"headers":[],"relativePath":"basic/start.md","filePath":"basic/start.md","lastUpdated":1707642172000}'),t={name:"basic/start.md"},l=n(`关于 Kotori.yml 的详细介绍请参考 配置详解
前往 Node.js 官网 根据系统版本选择对应的安装方式，确保 Node.js 版本 >= 17.9.0。输入以下命令确认安装成功：
node -v
+npm -v该内容待更新....
git clone https://github.com/kotori/kotori.gitKotori 基于 pnpm 的 Monorepo 进行开发，因此需要先安装 pnpm：
npm install pnpm -g进入到 Kotori 根目录并使用 pnpm 安装所有依赖：
cd ./kotori-bot-master
+pnpm install使用文本编辑器打开位于 Kotori 根目录的 kotori.yml，当前你还无需对该文件配置进行必要的改动。
global:
+ lang: zh_CN
+ command-prefix: /
+ dirs:
+ - ./node_modules/
+ - ./node_modules/@kotori-bot/
+
+adapter:
+ cmd-test:
+ extends: cmd
+ master: 2333
+ nickname: Kotarou
+ age: 18
+ sex: male
+ self-id: 720
+
+plugin:
+ console:
+ test: 1关于 kotori.yml 的详细介绍请参考 配置详解
pnpm startpnpm devTIP
本篇适用于想立即体验基于 Kotori 搭建的 Bot 实际效果、或单纯想使用由官方提供的各平台 Bot 服务的平台用户。
目前共提供 1 个平台、两个 Bot：
基于 Onebot 标准的 go-cqhttp 项目（@Kotori-bot/kotori-plugin-adapter-onebot）。相比于官方 QQ 机器人，第三方 QQ 机器人拥有着更健全的基础功能，权限使用上几乎无任何限制，缺点是因某种原因导致 go-cqhttp 等第三方 QQ 机器人项目跑路或归档，稳定性低于官方机器人。
立即使用：Kotori 交流群。
基于 Tencent 官方 API（@Kotori-bot/kotori-plugin-adapter-qq）。相比于第三方 QQ 机器人，限制较多（不可发送主动消息、URL 需备案等），但稳定性较高，其余功能与「小鳥二号」基本一致。
立即使用：Kotori 交流群。
除了加入官方群或添加 Bot 账户直接使用以外，也可以申请对应平台的 Bot 接入到你自己的群聊。
申请链接：Github Issues
请仔细查看说明并填写信息，一般在 24 小时内处理完毕 issue。
以下展示并非全部功能。
/core 查看实例统计信息/bot 查看当前 bot 信息与运行状态/bots 查看所有 bot 信息与运行状态/version 查看版本信息/about 帮助信息/update 检查更新/help [command] 查看指令帮助信息/menu 查看 BOT 菜单 别名：cd
/sex [tags] Pixiv 图片/sexh HuliImg 图片/bing 必应每日图/day 60s 带你看世界/earth 实时地球/china 实时中国/bgm <content> [order：number=1] 番组计划搜索游戏/动漫/bgmc 获取番组计划今日放送/bgm 素晴日
+> 原名：素晴らしき日々～不連続存在～公式ビジュアルアーカイヴ
+中文名：素晴之日 不连续的存在 Official Visual Archive
+介绍：人気アダルトゲームブランド「ケロQ」から、実に６年ぶりに発売された新作『素晴らしき日々 ～不連続存在～』。その魅力をギュッと閉じ込めたファン必携の一冊。描き下ろしイラスト＆原作を担当したSCA－自（すかぢ）氏の新作書き下ろしテキスト満載でお届け。
+标签：素晴らしき日々 设定集 电波 神作 素晴日 公式书 2010 百合 FanBook 悬疑 画集 画集・設定資料集 推理 VFB
+详情：https://bgm.tv/subject/8318
+[image]/bili <bvid> Bilibili 视频信息查询/bilier <uid> Bilibili 用户信息查询/hitokotos 随机语录/hitokoto 获取一条一言/hitokoto
+> 如果人们不相信数学简单，那是因为他们没有意识到人生有多复杂。——冯诺依曼
+类型：俗语/wiki <content> [order] 搜索 MediaWiki/wikil 查看 MediaWiki 列表/wiki 月社妃
+> 标题：月社妃
+内容：月社妃（日语：月社（つきやしろ） 妃（きさき））是由ウグイスカグラ所制作的18禁galgame《纸上的魔法使》及其衍生作品的登场角色。是主人公四条琉璃的同胞妹妹。
+https://mzh.moegirl.org.cn/.php?curid=384932
+来源：萌娘百科/github <repository> 查询 Github 仓库信息/github kotorijs/kotori
+> 地址：kotorijs/kotori
+描述：Cross platform, decoupled, and modernized ChatBot framework base on NodeJS
+语言：TypeScript
+所有者：kotorijs
+创建时间：
+2023-06-14T11:45:16Z
+最后更新时间：2023-12-31T15:28:10Z
+最后推送时间：2024-01-14T09:48:13Z
+开源协议：GNU General Public License v3.0/music <name> [order：number=1] 网易云点歌 序号默认为 1，填 0 显示歌曲列表/music 夢水の調べ
+> 歌曲ID：2077744375
+歌曲标题：夢水の調べ
+歌曲作者：おはる
+歌曲下载：http://music.163.com/song/media/outer/url?id=2077744375.mp3
+歌曲封面：[image]/weather <area> 查询城市天气/weather 北京
+> 城市：北京市
+日期：周四
+温度：-6～4℃
+天气：晴
+风度：南风-2级
+空气质量：良
+
+日期：周五
+温度：-5～0℃
+天气：阴
+风度：东风-1级
+空气质量：良
+
+日期：周六
+温度：-8～0℃
+天气：阴
+风度：东北风-1级
+空气质量：良在上一节中学习了事件系统的使用，现在通过 on_message 事件实现一个小功能：
ctx.on('on_message', (session) => {
+ if (!session.message.startWith('/')) return;
+ const command = session.message.slice(1);
+ if (command === 'echo') {
+ const content = command.slice(5);
+ session.send(content ? content : '输入内容为空');
+ } else if (command === 'time') {
+ session.send(\`现在的时间是 \${new Date().getTime()}\`);
+ } else {
+ session.send('未知的指令');
+ }
+});当收到「/echo xxx」消息时将发送 「xxx」；当收到「/time」消息时将发送当前时间戳；两者都不是时发送「未知的指令」。然而当结果越来越多后，if...else 语句也会越来越多，显然，这是十分糟糕的。尽管可以考虑将条件内容作为键、结果处理包装成回调函数作为值，以键值对形式装进一个对象或者 Map 中，然后遍历执行。但是当条件越来越复杂时，字符串的键远无法满足需求，同时也可能有相当一部分内容仅在私聊或者群聊下可用，其次，参数的处理也需要在结果处理内部中完成，这是十分复杂与繁琐的，因此便有入了本节内容。
指令（Command） 是 Kotori 的核心功能，也是最常见的交互方式，指令实质是 Kotori 内部对 on_message 事件的再处理与封装，这点与下一节中将学习的中间件是一致的，因此也可以看作是一个事件处理的语法糖。通过 ctx.command() 可注册一条指令，参数为指令模板字符，返回 Command 实例对象，实例上有着若干方法用于装饰该指令，其返回值同样为当前指令的实例对象。
ctx.command('echo <...content>').action((data) => data.args.join(' '));
+ctx.command('time')
+ .action(() => {
+ const time = new Date().getTime();
+ return time;
+});ctx.command('bar');
+ctx.command('car <arg1> <arg2>');
+ctx.command('dar <arg1> [arg2] [arg3=value]');
+ctx.command('ear [arg1:number=1] [...args:string] - 指令描述');上述演示了指令模板字符的基本格式。
<> 表示必要参数，方括号 [] 为可选参数参数名:参数类型，参数名应为小写字母与数字（[a-z0-9]）组成，参数类型可省略，默认 string，支持的类型有：string、number、boolean=值 设置默认参数... 设置剩余参数，与 TypeScript 不同的是，剩余参数的类型不需要加上数组表示 - 指令描述 设置指令描述通过 Command.option() 设置指令选项，第一个参数为该选项的缩写名，第二个参数为选模板字符，可设置多个指令选项。
ctx.command('bar')
+ .options()通过 Command.action() 设置指令的回调函数，回调函数中第一个参数为 args 与 options 两个键组成的对象，类型分别为 (string | number | boolean)[] 与 Record<string, string | number | boolean>，分别代表输入的参数值与选项值。每个指令仅可设置一个回调函数。
options中的键为对应选项的全名而非缩写名。
事件系统（Events） 的上游是事件订阅者模式（Events Emiter），该设计模式与事件系统共同构成了 Kotori 的基础，Kotori 内部通过订阅事件保持各部分间的联系和协作任务。同时也有来自各个聊天平台的事件，通过订阅这些事件能实现丰富多样的功能。
事件系统的使用方法与常规的事件订阅者一致，通过 ctx.on() 订阅一个事件，第一个参数为事件名，第二个参数为回调函数，事件被触发时事件数据将作为实际参数传给回调函数。
import { MessageScope } from 'kotori-bot'
+
+// ...
+
+ctx.on('on_message', (session) => {
+ if (session.message !== '你是谁') return;
+ if (session.type === MessageScope.GROUP) {
+ session.api.sendGroupMsg('是 Kotori！', session.groupId);
+ } else {
+ session.api.sendPrivateMsg('是 Kotori！', session.userId);
+ }
+});从上述代码中可以看出，当收到消息时，如果不是「你是谁」则立即退出，执行完毕。如果是则判断 session.type 的值，调用相应的发送消息接口发送「是 Kotori！」。根据语义化命名可知：session.type 为消息类型，值是一个 MessageScope 枚举值，分为 「GROUP」（群聊）和「PRIVATE」（私聊）；session.api 是 Api 的实例对象，提供了多种与聊天平台交互的接口，此处用到的 sendG丨groupMsg 与 sendPrivateMsg 分别是发送群聊消息与发送私聊消息，第一个参数为消息内容，第二个参数分别为群聊 id 与用户 id。
id 一般为对应聊天平台提供的 id/uid，叫法不一，值类型为 string 或 number。如当你收到由适配器 @kotori-bot/kotori-plugin-adapter-onebot 发出的消息时，
groupId为 QQ 群号，userId为 QQ 号。
上面的代码每次都需要判断消息类型再执行相应方法，显得有点繁琐，因此 kotori 提供了一个语法糖：
ctx.on('on_message', (session) => {
+ if (session.message !== '你是谁') return;
+ session.send('是 Kotori！');
+ }
+});使用 session.send() 只需要传入消息内容即可，消息类型判断和传入相应 id 的工作已在该方法内部完成。session 上还有不少与之类似的语法糖，将在后面章节中逐一提到，也因如此，session.send() 在实际开发中使用率并不高，因为它对后续内容而言依旧很繁琐。
正如订阅事件是「on」，取消订阅事件则是「off」。ctx.off() 的使用方法与 ctx.on() 一致。
+const handle = (session: Session['on_message']) => {
+ ctx.off('on_message', handle);
+ // ...
+}
+
+ctx.on('on_message', handle);上述代码中，触发事件后会立即取消订阅事件，意味着它只会被触发一次。ctx.on() 在执行后会返回取消订阅自己的方法，因此可以这样简化：
const off = ctx.on('on_message', (session) => {
+ off();
+ // ...
+});使用 ctx.once() 再进一步简化：
ctx.once('on_message', (session) => {
+ // ...
+});工作流程与上面一致，通过 ctx.once() 订阅事件，在触发后会立即取消订阅。
使用 ctx.offAll() 取消订阅指定事件名下所有事件：
ctx.once('on_message', (session) => {
+ // ...
+});
+
+ctx.once('on_message', (session) => {
+ // ...
+});
+
+ctx.on('on_message', (session) => {
+ if (session.message === '消失吧！') return;
+ ctx.ofAll('on_message');
+ }
+});在第三个回调函数中，当收到消息「消失吧！」时将取消订阅所有 on_message 事件。
Kotori 中事件类型大致分为三类：
data。session。常见的系统事件有：
ready ：当加载完所有模块时触发dispose ：当 Kotori 关闭时触发status ：当 Bot 的在线状态改变时触发通过 status 实现 Bot 上线后自动发送消息给最高管理员：
ctx.on('status', (data) => {
+ if (data.status !== 'online') return;
+ const { api, config } = data.adapter;
+ api.sendPrivateMsg('上线了！', config.master);
+});由于 status 是由适配器发出的系统事件，它并没有类似于会话事件中的 session.send()，因此只能使用最原始的办法发送消息。status 的事件数据中仅有两个值，一个是 data.status 表示当前在线状态（「online」或「offline」），data.adapter 为目标 Bot，Bot 上有 adapter.api 与 adapter.config，前者等价于会话事件中的 session.api，后者为 Bot 配置，来自于 kotori.yml。
常见的会话事件有：
on_message ：当收到消息时触发on_recall ：当有消息撤回时触发on_group_increase ：当群人数增加时触发通过 on_group_increase 实现群欢迎：
ctx.on('on_group_increase', (session) => {
+ session.send(\`因为遇见了\${session.el.at(session.userId)}，我的世界才充满颜色！\`);
+});其中 session.el 与 session.api 类似，是 Elements 的实例对象，它提供了用于转换消息元素的接口，如 session.el.at() 传入用户 id 转换成艾特消息，session.el.image() 传入图片 URL 转换成图片消息。当然，并不是所有聊天平台都支持所有的消息元素，应以具体聊天平台为准。
得益于 TypeScript 有着 声明合并（Declaration Merging） 的特性，在模块中可通过其实现自定义事件的局部声明。
declare module 'kotori-bot' {
+ interface EventsMapping {
+ custom_event1(data: string): void;
+ }
+}
+
+ctx.on('custom_event1', (data) => {
+ ctx.logger.debug(data);
+});Kotori 中所有事件均定义在 EventsMapping 接口上。custom_event1 事件触发后将打印事件数据。ctx.logger 是一个日志打印工具，ctx.logger.debug() 意味着打印内容仅在 dev 模式下运行 Kotori 可见。然而，订阅事件后，事件却从来没有发出，因此需要发出事件：
// ...
+
+ctx.emit('custom_event1', '这是事件数据');
+ctx.emit('custom_event1', '这里也是事件数据');ctx.emit() 第一个参数为事件名，然后为剩余参数，剩余参数与该事件参数一一对应。虽然 Kotori 中系统事件与会话事件的参数均只有一个，但是可以在自定义事件中实现任意多个参数：
declare module 'kotori-bot' {
+ interface EventsMapping {
+ custom_event2(arg1: string, arg2: number, arg3: boolean): void;
+ custom_event3(...args: any[]): void;
+ }
+}
+
+ctx.emit('custom_event2', 'string', 42, true);
+ctx.emit('custom_event3', 'string1', 'string2', 233, 2333, {value: 42});`,44),p=[h];function k(l,e,E,d,r,g){return a(),i("div",null,p)}const y=s(t,[["render",k]]);export{c as __pageData,y as default}; diff --git a/assets/guide_base_events.md.D1LHe1qC.lean.js b/assets/guide_base_events.md.D1LHe1qC.lean.js new file mode 100644 index 00000000..c96739a7 --- /dev/null +++ b/assets/guide_base_events.md.D1LHe1qC.lean.js @@ -0,0 +1 @@ +import{_ as s,c as i,o as a,V as n}from"./chunks/framework.Dy019jra.js";const c=JSON.parse('{"title":"事件系统","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/events.md","filePath":"guide/base/events.md","lastUpdated":1707642172000}'),t={name:"guide/base/events.md"},h=n("",44),p=[h];function k(l,e,E,d,r,g){return a(),i("div",null,p)}const y=s(t,[["render",k]]);export{c as __pageData,y as default}; diff --git a/assets/guide_base_middleware.md.PKeNh_IF.js b/assets/guide_base_middleware.md.PKeNh_IF.js new file mode 100644 index 00000000..a9c58825 --- /dev/null +++ b/assets/guide_base_middleware.md.PKeNh_IF.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as d,m as e,a as r}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"中间件","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/middleware.md","filePath":"guide/base/middleware.md","lastUpdated":1707642172000}'),s={name:"guide/base/middleware.md"},o=e("h1",{id:"中间件",tabindex:"-1"},[r("中间件 "),e("a",{class:"header-anchor",href:"#中间件","aria-label":'Permalink to "中间件"'},"")],-1),i=[o];function c(n,l,m,_,p,h){return d(),t("div",null,i)}const b=a(s,[["render",c]]);export{u as __pageData,b as default}; diff --git a/assets/guide_base_middleware.md.PKeNh_IF.lean.js b/assets/guide_base_middleware.md.PKeNh_IF.lean.js new file mode 100644 index 00000000..a9c58825 --- /dev/null +++ b/assets/guide_base_middleware.md.PKeNh_IF.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as d,m as e,a as r}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"中间件","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/middleware.md","filePath":"guide/base/middleware.md","lastUpdated":1707642172000}'),s={name:"guide/base/middleware.md"},o=e("h1",{id:"中间件",tabindex:"-1"},[r("中间件 "),e("a",{class:"header-anchor",href:"#中间件","aria-label":'Permalink to "中间件"'},"")],-1),i=[o];function c(n,l,m,_,p,h){return d(),t("div",null,i)}const b=a(s,[["render",c]]);export{u as __pageData,b as default}; diff --git a/assets/guide_base_regexp.md.5V-1qgk-.js b/assets/guide_base_regexp.md.5V-1qgk-.js new file mode 100644 index 00000000..d7a70f34 --- /dev/null +++ b/assets/guide_base_regexp.md.5V-1qgk-.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as r,m as e,a as s}from"./chunks/framework.Dy019jra.js";const x=JSON.parse('{"title":"正则匹配","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/regexp.md","filePath":"guide/base/regexp.md","lastUpdated":1707642172000}'),o={name:"guide/base/regexp.md"},d=e("h1",{id:"正则匹配",tabindex:"-1"},[s("正则匹配 "),e("a",{class:"header-anchor",href:"#正则匹配","aria-label":'Permalink to "正则匹配"'},"")],-1),c=[d];function n(i,p,_,l,m,h){return r(),t("div",null,c)}const g=a(o,[["render",n]]);export{x as __pageData,g as default}; diff --git a/assets/guide_base_regexp.md.5V-1qgk-.lean.js b/assets/guide_base_regexp.md.5V-1qgk-.lean.js new file mode 100644 index 00000000..d7a70f34 --- /dev/null +++ b/assets/guide_base_regexp.md.5V-1qgk-.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as r,m as e,a as s}from"./chunks/framework.Dy019jra.js";const x=JSON.parse('{"title":"正则匹配","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/regexp.md","filePath":"guide/base/regexp.md","lastUpdated":1707642172000}'),o={name:"guide/base/regexp.md"},d=e("h1",{id:"正则匹配",tabindex:"-1"},[s("正则匹配 "),e("a",{class:"header-anchor",href:"#正则匹配","aria-label":'Permalink to "正则匹配"'},"")],-1),c=[d];function n(i,p,_,l,m,h){return r(),t("div",null,c)}const g=a(o,[["render",n]]);export{x as __pageData,g as default}; diff --git a/assets/guide_base_schedule.md.Bgo9T4LD.js b/assets/guide_base_schedule.md.Bgo9T4LD.js new file mode 100644 index 00000000..df6b4e68 --- /dev/null +++ b/assets/guide_base_schedule.md.Bgo9T4LD.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as d}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"计划任务","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/schedule.md","filePath":"guide/base/schedule.md","lastUpdated":1707642172000}'),c={name:"guide/base/schedule.md"},o=e("h1",{id:"计划任务",tabindex:"-1"},[d("计划任务 "),e("a",{class:"header-anchor",href:"#计划任务","aria-label":'Permalink to "计划任务"'},"")],-1),r=[o];function n(i,l,_,h,p,u){return s(),t("div",null,r)}const b=a(c,[["render",n]]);export{f as __pageData,b as default}; diff --git a/assets/guide_base_schedule.md.Bgo9T4LD.lean.js b/assets/guide_base_schedule.md.Bgo9T4LD.lean.js new file mode 100644 index 00000000..df6b4e68 --- /dev/null +++ b/assets/guide_base_schedule.md.Bgo9T4LD.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as d}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"计划任务","description":"","frontmatter":{},"headers":[],"relativePath":"guide/base/schedule.md","filePath":"guide/base/schedule.md","lastUpdated":1707642172000}'),c={name:"guide/base/schedule.md"},o=e("h1",{id:"计划任务",tabindex:"-1"},[d("计划任务 "),e("a",{class:"header-anchor",href:"#计划任务","aria-label":'Permalink to "计划任务"'},"")],-1),r=[o];function n(i,l,_,h,p,u){return s(),t("div",null,r)}const b=a(c,[["render",n]]);export{f as __pageData,b as default}; diff --git a/assets/guide_extend_database.md.CNO_RCKh.js b/assets/guide_extend_database.md.CNO_RCKh.js new file mode 100644 index 00000000..6f60fb9f --- /dev/null +++ b/assets/guide_extend_database.md.CNO_RCKh.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as d}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"数据库","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/database.md","filePath":"guide/extend/database.md","lastUpdated":1707642172000}'),o={name:"guide/extend/database.md"},r=e("h1",{id:"数据库",tabindex:"-1"},[d("数据库 "),e("a",{class:"header-anchor",href:"#数据库","aria-label":'Permalink to "数据库"'},"")],-1),n=[r];function c(i,_,l,p,m,h){return s(),t("div",null,n)}const x=a(o,[["render",c]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_database.md.CNO_RCKh.lean.js b/assets/guide_extend_database.md.CNO_RCKh.lean.js new file mode 100644 index 00000000..6f60fb9f --- /dev/null +++ b/assets/guide_extend_database.md.CNO_RCKh.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as d}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"数据库","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/database.md","filePath":"guide/extend/database.md","lastUpdated":1707642172000}'),o={name:"guide/extend/database.md"},r=e("h1",{id:"数据库",tabindex:"-1"},[d("数据库 "),e("a",{class:"header-anchor",href:"#数据库","aria-label":'Permalink to "数据库"'},"")],-1),n=[r];function c(i,_,l,p,m,h){return s(),t("div",null,n)}const x=a(o,[["render",c]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_filter.md.CWzl_4Ib.js b/assets/guide_extend_filter.md.CWzl_4Ib.js new file mode 100644 index 00000000..a1e8879c --- /dev/null +++ b/assets/guide_extend_filter.md.CWzl_4Ib.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as r,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"滤器","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/filter.md","filePath":"guide/extend/filter.md","lastUpdated":1707642172000}'),d={name:"guide/extend/filter.md"},o=e("h1",{id:"滤器",tabindex:"-1"},[s("滤器 "),e("a",{class:"header-anchor",href:"#滤器","aria-label":'Permalink to "滤器"'},"")],-1),n=[o];function i(c,l,_,f,p,m){return r(),a("div",null,n)}const x=t(d,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_filter.md.CWzl_4Ib.lean.js b/assets/guide_extend_filter.md.CWzl_4Ib.lean.js new file mode 100644 index 00000000..a1e8879c --- /dev/null +++ b/assets/guide_extend_filter.md.CWzl_4Ib.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as r,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"滤器","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/filter.md","filePath":"guide/extend/filter.md","lastUpdated":1707642172000}'),d={name:"guide/extend/filter.md"},o=e("h1",{id:"滤器",tabindex:"-1"},[s("滤器 "),e("a",{class:"header-anchor",href:"#滤器","aria-label":'Permalink to "滤器"'},"")],-1),n=[o];function i(c,l,_,f,p,m){return r(),a("div",null,n)}const x=t(d,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_i18n.md.DZqqnwvM.js b/assets/guide_extend_i18n.md.DZqqnwvM.js new file mode 100644 index 00000000..6c48db23 --- /dev/null +++ b/assets/guide_extend_i18n.md.DZqqnwvM.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as n,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"国际化","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/i18n.md","filePath":"guide/extend/i18n.md","lastUpdated":1707642172000}'),d={name:"guide/extend/i18n.md"},o=e("h1",{id:"国际化",tabindex:"-1"},[s("国际化 "),e("a",{class:"header-anchor",href:"#国际化","aria-label":'Permalink to "国际化"'},"")],-1),r=[o];function i(c,_,l,p,m,h){return n(),a("div",null,r)}const x=t(d,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_i18n.md.DZqqnwvM.lean.js b/assets/guide_extend_i18n.md.DZqqnwvM.lean.js new file mode 100644 index 00000000..6c48db23 --- /dev/null +++ b/assets/guide_extend_i18n.md.DZqqnwvM.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as n,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"国际化","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/i18n.md","filePath":"guide/extend/i18n.md","lastUpdated":1707642172000}'),d={name:"guide/extend/i18n.md"},o=e("h1",{id:"国际化",tabindex:"-1"},[s("国际化 "),e("a",{class:"header-anchor",href:"#国际化","aria-label":'Permalink to "国际化"'},"")],-1),r=[o];function i(c,_,l,p,m,h){return n(),a("div",null,r)}const x=t(d,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_internal.md.Be4CBysu.js b/assets/guide_extend_internal.md.Be4CBysu.js new file mode 100644 index 00000000..dce20f52 --- /dev/null +++ b/assets/guide_extend_internal.md.Be4CBysu.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as n,m as e,a as r}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"内部接口","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/internal.md","filePath":"guide/extend/internal.md","lastUpdated":1707642172000}'),s={name:"guide/extend/internal.md"},d=e("h1",{id:"内部接口",tabindex:"-1"},[r("内部接口 "),e("a",{class:"header-anchor",href:"#内部接口","aria-label":'Permalink to "内部接口"'},"")],-1),o=[d];function i(c,l,_,p,m,h){return n(),a("div",null,o)}const x=t(s,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_internal.md.Be4CBysu.lean.js b/assets/guide_extend_internal.md.Be4CBysu.lean.js new file mode 100644 index 00000000..dce20f52 --- /dev/null +++ b/assets/guide_extend_internal.md.Be4CBysu.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o as n,m as e,a as r}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"内部接口","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/internal.md","filePath":"guide/extend/internal.md","lastUpdated":1707642172000}'),s={name:"guide/extend/internal.md"},d=e("h1",{id:"内部接口",tabindex:"-1"},[r("内部接口 "),e("a",{class:"header-anchor",href:"#内部接口","aria-label":'Permalink to "内部接口"'},"")],-1),o=[d];function i(c,l,_,p,m,h){return n(),a("div",null,o)}const x=t(s,[["render",i]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_logger.md.BgYPW8uO.js b/assets/guide_extend_logger.md.BgYPW8uO.js new file mode 100644 index 00000000..a361b986 --- /dev/null +++ b/assets/guide_extend_logger.md.BgYPW8uO.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as r}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"日志打印","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/logger.md","filePath":"guide/extend/logger.md","lastUpdated":1707642172000}'),s={name:"guide/extend/logger.md"},d=e("h1",{id:"日志打印",tabindex:"-1"},[r("日志打印 "),e("a",{class:"header-anchor",href:"#日志打印","aria-label":'Permalink to "日志打印"'},"")],-1),n=[d];function c(i,l,_,g,p,m){return o(),a("div",null,n)}const u=t(s,[["render",c]]);export{f as __pageData,u as default}; diff --git a/assets/guide_extend_logger.md.BgYPW8uO.lean.js b/assets/guide_extend_logger.md.BgYPW8uO.lean.js new file mode 100644 index 00000000..a361b986 --- /dev/null +++ b/assets/guide_extend_logger.md.BgYPW8uO.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as r}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"日志打印","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/logger.md","filePath":"guide/extend/logger.md","lastUpdated":1707642172000}'),s={name:"guide/extend/logger.md"},d=e("h1",{id:"日志打印",tabindex:"-1"},[r("日志打印 "),e("a",{class:"header-anchor",href:"#日志打印","aria-label":'Permalink to "日志打印"'},"")],-1),n=[d];function c(i,l,_,g,p,m){return o(),a("div",null,n)}const u=t(s,[["render",c]]);export{f as __pageData,u as default}; diff --git a/assets/guide_extend_tools.md.DvrPWCpH.js b/assets/guide_extend_tools.md.DvrPWCpH.js new file mode 100644 index 00000000..368ca5c9 --- /dev/null +++ b/assets/guide_extend_tools.md.DvrPWCpH.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"工具函数","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/tools.md","filePath":"guide/extend/tools.md","lastUpdated":1707642172000}'),d={name:"guide/extend/tools.md"},r=e("h1",{id:"工具函数",tabindex:"-1"},[s("工具函数 "),e("a",{class:"header-anchor",href:"#工具函数","aria-label":'Permalink to "工具函数"'},"")],-1),n=[r];function c(i,l,_,p,m,h){return o(),a("div",null,n)}const x=t(d,[["render",c]]);export{u as __pageData,x as default}; diff --git a/assets/guide_extend_tools.md.DvrPWCpH.lean.js b/assets/guide_extend_tools.md.DvrPWCpH.lean.js new file mode 100644 index 00000000..368ca5c9 --- /dev/null +++ b/assets/guide_extend_tools.md.DvrPWCpH.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as s}from"./chunks/framework.Dy019jra.js";const u=JSON.parse('{"title":"工具函数","description":"","frontmatter":{},"headers":[],"relativePath":"guide/extend/tools.md","filePath":"guide/extend/tools.md","lastUpdated":1707642172000}'),d={name:"guide/extend/tools.md"},r=e("h1",{id:"工具函数",tabindex:"-1"},[s("工具函数 "),e("a",{class:"header-anchor",href:"#工具函数","aria-label":'Permalink to "工具函数"'},"")],-1),n=[r];function c(i,l,_,p,m,h){return o(),a("div",null,n)}const x=t(d,[["render",c]]);export{u as __pageData,x as default}; diff --git a/assets/guide_modules_context.md.BqjfvHTT.js b/assets/guide_modules_context.md.BqjfvHTT.js new file mode 100644 index 00000000..b9522cec --- /dev/null +++ b/assets/guide_modules_context.md.BqjfvHTT.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as s}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"上下文","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/context.md","filePath":"guide/modules/context.md","lastUpdated":1707642172000}'),c={name:"guide/modules/context.md"},d=e("h1",{id:"上下文",tabindex:"-1"},[s("上下文 "),e("a",{class:"header-anchor",href:"#上下文","aria-label":'Permalink to "上下文"'},"")],-1),n=[d];function r(i,l,_,m,p,u){return o(),a("div",null,n)}const x=t(c,[["render",r]]);export{f as __pageData,x as default}; diff --git a/assets/guide_modules_context.md.BqjfvHTT.lean.js b/assets/guide_modules_context.md.BqjfvHTT.lean.js new file mode 100644 index 00000000..b9522cec --- /dev/null +++ b/assets/guide_modules_context.md.BqjfvHTT.lean.js @@ -0,0 +1 @@ +import{_ as t,c as a,o,m as e,a as s}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"上下文","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/context.md","filePath":"guide/modules/context.md","lastUpdated":1707642172000}'),c={name:"guide/modules/context.md"},d=e("h1",{id:"上下文",tabindex:"-1"},[s("上下文 "),e("a",{class:"header-anchor",href:"#上下文","aria-label":'Permalink to "上下文"'},"")],-1),n=[d];function r(i,l,_,m,p,u){return o(),a("div",null,n)}const x=t(c,[["render",r]]);export{f as __pageData,x as default}; diff --git a/assets/guide_modules_lifecycle.md.CtUUVpzs.js b/assets/guide_modules_lifecycle.md.CtUUVpzs.js new file mode 100644 index 00000000..6838d599 --- /dev/null +++ b/assets/guide_modules_lifecycle.md.CtUUVpzs.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as c,m as e,a as s}from"./chunks/framework.Dy019jra.js";const h=JSON.parse('{"title":"生命周期","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/lifecycle.md","filePath":"guide/modules/lifecycle.md","lastUpdated":1707642172000}'),o={name:"guide/modules/lifecycle.md"},d=e("h1",{id:"生命周期",tabindex:"-1"},[s("生命周期 "),e("a",{class:"header-anchor",href:"#生命周期","aria-label":'Permalink to "生命周期"'},"")],-1),l=[d];function r(i,n,_,m,f,p){return c(),t("div",null,l)}const x=a(o,[["render",r]]);export{h as __pageData,x as default}; diff --git a/assets/guide_modules_lifecycle.md.CtUUVpzs.lean.js b/assets/guide_modules_lifecycle.md.CtUUVpzs.lean.js new file mode 100644 index 00000000..6838d599 --- /dev/null +++ b/assets/guide_modules_lifecycle.md.CtUUVpzs.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as c,m as e,a as s}from"./chunks/framework.Dy019jra.js";const h=JSON.parse('{"title":"生命周期","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/lifecycle.md","filePath":"guide/modules/lifecycle.md","lastUpdated":1707642172000}'),o={name:"guide/modules/lifecycle.md"},d=e("h1",{id:"生命周期",tabindex:"-1"},[s("生命周期 "),e("a",{class:"header-anchor",href:"#生命周期","aria-label":'Permalink to "生命周期"'},"")],-1),l=[d];function r(i,n,_,m,f,p){return c(),t("div",null,l)}const x=a(o,[["render",r]]);export{h as __pageData,x as default}; diff --git a/assets/guide_modules_plugin.md.DId8fkF7.js b/assets/guide_modules_plugin.md.DId8fkF7.js new file mode 100644 index 00000000..3c6cecc6 --- /dev/null +++ b/assets/guide_modules_plugin.md.DId8fkF7.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as o}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"插件范式","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/plugin.md","filePath":"guide/modules/plugin.md","lastUpdated":1707642172000}'),d={name:"guide/modules/plugin.md"},n=e("h1",{id:"插件范式",tabindex:"-1"},[o("插件范式 "),e("a",{class:"header-anchor",href:"#插件范式","aria-label":'Permalink to "插件范式"'},"")],-1),r=[n];function i(c,l,p,u,_,m){return s(),t("div",null,r)}const g=a(d,[["render",i]]);export{f as __pageData,g as default}; diff --git a/assets/guide_modules_plugin.md.DId8fkF7.lean.js b/assets/guide_modules_plugin.md.DId8fkF7.lean.js new file mode 100644 index 00000000..3c6cecc6 --- /dev/null +++ b/assets/guide_modules_plugin.md.DId8fkF7.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as o}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"插件范式","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/plugin.md","filePath":"guide/modules/plugin.md","lastUpdated":1707642172000}'),d={name:"guide/modules/plugin.md"},n=e("h1",{id:"插件范式",tabindex:"-1"},[o("插件范式 "),e("a",{class:"header-anchor",href:"#插件范式","aria-label":'Permalink to "插件范式"'},"")],-1),r=[n];function i(c,l,p,u,_,m){return s(),t("div",null,r)}const g=a(d,[["render",i]]);export{f as __pageData,g as default}; diff --git a/assets/guide_modules_schema.md.D2O0zqIT.js b/assets/guide_modules_schema.md.D2O0zqIT.js new file mode 100644 index 00000000..bb91c1d6 --- /dev/null +++ b/assets/guide_modules_schema.md.D2O0zqIT.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as o}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"动态检查","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/schema.md","filePath":"guide/modules/schema.md","lastUpdated":1707642172000}'),c={name:"guide/modules/schema.md"},d=e("h1",{id:"动态检查",tabindex:"-1"},[o("动态检查 "),e("a",{class:"header-anchor",href:"#动态检查","aria-label":'Permalink to "动态检查"'},"")],-1),r=[d];function n(i,m,l,_,h,p){return s(),t("div",null,r)}const x=a(c,[["render",n]]);export{f as __pageData,x as default}; diff --git a/assets/guide_modules_schema.md.D2O0zqIT.lean.js b/assets/guide_modules_schema.md.D2O0zqIT.lean.js new file mode 100644 index 00000000..bb91c1d6 --- /dev/null +++ b/assets/guide_modules_schema.md.D2O0zqIT.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as o}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"动态检查","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/schema.md","filePath":"guide/modules/schema.md","lastUpdated":1707642172000}'),c={name:"guide/modules/schema.md"},d=e("h1",{id:"动态检查",tabindex:"-1"},[o("动态检查 "),e("a",{class:"header-anchor",href:"#动态检查","aria-label":'Permalink to "动态检查"'},"")],-1),r=[d];function n(i,m,l,_,h,p){return s(),t("div",null,r)}const x=a(c,[["render",n]]);export{f as __pageData,x as default}; diff --git a/assets/guide_modules_service.md.f93Srqk2.js b/assets/guide_modules_service.md.f93Srqk2.js new file mode 100644 index 00000000..a9174ed7 --- /dev/null +++ b/assets/guide_modules_service.md.f93Srqk2.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as r}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"依赖与服务","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/service.md","filePath":"guide/modules/service.md","lastUpdated":1707642172000}'),o={name:"guide/modules/service.md"},c=e("h1",{id:"依赖与服务",tabindex:"-1"},[r("依赖与服务 "),e("a",{class:"header-anchor",href:"#依赖与服务","aria-label":'Permalink to "依赖与服务"'},"")],-1),d=[c];function i(n,l,_,m,p,u){return s(),t("div",null,d)}const v=a(o,[["render",i]]);export{f as __pageData,v as default}; diff --git a/assets/guide_modules_service.md.f93Srqk2.lean.js b/assets/guide_modules_service.md.f93Srqk2.lean.js new file mode 100644 index 00000000..a9174ed7 --- /dev/null +++ b/assets/guide_modules_service.md.f93Srqk2.lean.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as s,m as e,a as r}from"./chunks/framework.Dy019jra.js";const f=JSON.parse('{"title":"依赖与服务","description":"","frontmatter":{},"headers":[],"relativePath":"guide/modules/service.md","filePath":"guide/modules/service.md","lastUpdated":1707642172000}'),o={name:"guide/modules/service.md"},c=e("h1",{id:"依赖与服务",tabindex:"-1"},[r("依赖与服务 "),e("a",{class:"header-anchor",href:"#依赖与服务","aria-label":'Permalink to "依赖与服务"'},"")],-1),d=[c];function i(n,l,_,m,p,u){return s(),t("div",null,d)}const v=a(o,[["render",i]]);export{f as __pageData,v as default}; diff --git a/assets/guide_nav.md.DNOOSt65.js b/assets/guide_nav.md.DNOOSt65.js new file mode 100644 index 00000000..7a5aa01a --- /dev/null +++ b/assets/guide_nav.md.DNOOSt65.js @@ -0,0 +1 @@ +import{_ as a,c as t,o as e,V as r}from"./chunks/framework.Dy019jra.js";const S=JSON.parse('{"title":"前言","description":"","frontmatter":{},"headers":[],"relativePath":"guide/nav.md","filePath":"guide/nav.md","lastUpdated":1707642172000}'),o={name:"guide/nav.md"},i=r('一般地，自定义事件应只用于单个模块内部，用于多个模块间相互通信传输数据时，每个涉及模块应先加载定义自定义事件的模块，以免出现类型定义的问题。
TIP
阅读本章前请确保你已阅读完毕 使用指南。
拥有一定的 JavaScript 与 Node.js 知识基础。
Kotori 运行于 Node.js 环境，因此开发 Kotori 模块前掌握 JavaScript 与 Node.js 基础内容是必然的。此处推荐几个文档：
基于 TypeScript 与现代化 ECMAScript 开发。
TypeScript 是 JavaScript 的超集，TypeScript 在继承了 JavaScript 全部特性的同时，为弱类型动态语言的 JavaScript 提供了一个独立且强大的类型系统。同时，使用 TypeScript 基本意味着使用 ESModule 与现代化的 JavaScript 语法与规范，这是 Kotori 三大特点之一。理论上在 Kotori 程序的生产环境中可正常运行由 JavaScript 直接编写的模块，但 Kotori 本身便使用 TypeScript 开发，因此更推荐你使用 TypeScript 用于你的模块开发，尽管这并不是必须的。
在 使用指南 中你已安装并部署了 Node.js 环境与 pnpm，此处不再赘述。
Git 是一个开源的分布式版本控制系统，可以有效、高速地处理从很小到非常大的项目版本管理。版本控制可方便的实现协作开发、版本回退等，其重要性对每一位开发者都是不言而喻。GitHub 是一个面向开源及私有软件项目的托管平台，拥有着全球最大的开源社区，使用 Git 可轻松将你的项目推送至 GitHub 远程仓库，你与你的项目也将成为开源社区的一份子。Git 与 GitHub 具体使用流程此处不逐一赘述。
显然 Kotori 并不属于 Web 前端的范畴，但依旧隶属于 JavaScript 生态，因此推荐 世界上最好的 Web 开发 IDE 「Visual Studio Code」（以下简称「VSC」）。虽然 VSC 本质上只是文本编辑器，但因其强大的扩展商店使其能做到大部分 IDE 的功能，当然你也可以根据你的喜好选择，如：
当开发完毕模块后，可以将它发布至社区，一个 Kotori 模块一般会同时发布到如下三个平台：
「构建产物」在 JavaScript 生态中指将源码（Kotori 模块开发中一般为 TypeScript 文件）进行处理以适用于生产环境中（处理过程一般有 TypeScript 转为 JavaScript、向下兼容语法、压缩代码等）。JavaScript 生态中构建工具非常多，你可以选择喜欢的构建工具并自习配置，当然如果你对此并不了解也可以使用 Kotori 默认的构建方式（通过TypeScript 自带的 tsc 程序），在你的模块根目录中输入以下指令：
pnpm build一般地，你将会发现在模块根目录出现了一个 lib 文件夹，这在上一节已有提到，它是构建产物的输出目录，有必要的话可在 tsconfig.json 文件中更改：
{
+ // ...
+ "compilerOptions": {
+ "rootDir": "./src", // 输入目录
+ "outDir": "./lib" // 输出目录
+ // ...
+ }
+}关于
tsconfig.json的更多内容：TypeScript Documentation
对于模块发布主要分为发布构建产物（publish）与发布源码（push），两种情况下需要发布的文件内容会有些许不同，因此便引入了「文件忽略」。
用于指定在使用 publish 时忽略的文件与文件夹，在模块根目录创建一个 .npmignore 文件：
node_modules
+src
+test
+
+tsconfig.json
+!README.md实际上在 publish 时只需要附带少数文件即可，而 .npmignore 采用的是黑名单机制显得很繁琐，因此 Kotori 模块的默认模板中并未使用该方式也并不推荐。
在上一节的 package.json 示例中会发现有一个以字符串数组为值的 files 配置项，其用于指定在使用 publish 时需要附带的文件与文件夹。
{
+ "files": ["lib", "LICENSE", "README.md"],
+}files 配置项优先级高于 .npmignore，其直接写在 package.json 中显得十分简洁也会减少整个模块目录的文件冗余。
不同于前两者，.gitignore 用于指定在使用 Git 进行 push 时需要忽略的文件，语法与 .npmignore 类似，同样位于模块根目录：
node_modules
+dist
+lib
+.husky/_
+
+.vscode/*
+.vs/*
+!.vscode/extensions.json
+
+*.tgz
+tsconfig.tsbuildinfo
+*.log
+
+kotori.dev.yml使用工作区开发时，需确保当前为待发布模块根目录。首先检查 npm 源是否为 http://registry.npmjs.org：
npm config get registry
+# If not:
+# npm config set registry=http://registry.npmjs.org前往 npmjs.org 注册账号，然后根据提示在浏览器内登录：
npm login当一切就绪时：
npm publish一般地，访问 npm 个人页即可查看刚才发布的插件： kotori-plugin-my-project。
使用 Git 前务必先配置好你的账号、邮箱和与 GitHub 通信的 ssh，可参考 手把手教你配置 git 和 git 仓库 。使用工作区开发时，可选择发布整个工作区也可仅发布单个模块，切换到相应的目录即可。首先在 GitHub New 页面创建一个远程仓库，接着在本地仓库中关联到该远程仓库：
git remote add origin git@github.com:kotorijs/kotori-plugin-my-project提交并推送至远程仓库
git add .
+git commit -m 'feat: create a project'
+git push origin master当然，你也可以为本次提交添加一个 tag：
git tag v1.0.0
+git push --tags该内容待更新....
「create-kotori」是专用于构建 Kotori 模块的 Cli 工具。
create-kotori <project-name>pnpm init kotori@latest my-project除此之外，也可以将其安装在全局使用：
npm install create-kotori -g
+create-kotori my-project亦称为「工作区开发」，该方法适用于有一定 Node.js 开发经验的开发者，并不推荐新人使用。使用该方法可同时开发多个插件，也可在开发当前插件时安装使用其它插件，同时可以便捷的修改与调试 Kotori 源码并进行二次开发。使用 Git 直接克隆 Kotorijs/kotori 仓库的源码：
git clone https://github.com/kotorijs/kotori.git此处默认克隆的是主分支下的代码，也可以选择克隆 dev 分支，该内容将在 进阶开发中 详细说明。进入根目录并使用 pnpm 安装依赖：
cd ./kotori-bot-master
+pnpm install在 ./modules/ 目录下使用 create-kotori 创建一个模块：
cd ./modules/
+pnpm init kotori@latest my-project
+cd ./my-project/my-project
+├── kotori.yml
+├── package.json
+├── tsconfig.json
+├── LICENSE
+├── README.md
+├── .gitignore
+├── node_modules
+├── lib
+│ ├── index.js
+│ ├── index.d.ts
+│ ├── ...
+├── locales
+│ ├── en_US.json
+│ ├── ja_JP.json
+│ ├── zh_CN.json
+│ └── zh_TW.json
+└── src
+ ├── config.ts
+ ├── index.ts
+ ├── types.tskotori.yml 仅在直接构建时存在于模块根目录，工作区开发下将位于工作区的根目录。
kotori.yml Kotori 配置文件kotori.dev.yml Kotori Dev 模式下配置文件package.json 包信息文件tsconfig.json TypeScript 配置文件LICENSE 协议文件README.md 自述文件.gitignore git 忽略文件lib 构建产物输出目录（前端为 dist，后端为 lib）locales 国际化文件夹，将在后面的章节中讲解src 工程文件夹，代码存放处 cofig.ts 默认配置数据文件index.ts 整个模块的入口文件types.ts 公共类型文件以下为默认创建的 package.json：
{
+ "name": "kotori-plugin-my-project",
+ "version": "1.0.0",
+ "description": "This is my first Kotori plugin",
+ "main": "lib/.js",
+ "scripts": {
+ "build": "tsc --build"
+ },
+ "license": "GPL-3.0",
+ "keywords": ["kotori-plugin"],
+ "files": ["lib", "LICENSE", "README.md"],
+ "peerDependencies": {
+ "kotori-bot": "1.1.0"
+ }
+}添加一些非必要配置项以完善包信息：
{
+ "author": "Himeno <biyuehuya@gmail.com>",
+ "bugs": {
+ "url": "https://github.com/kotorijs/my-project/issues"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/kotorijs/my-project.git"
+ },
+ "homepage": "https://github.com/kotorijs/my-project/"
+}添加用于传给 Kotori 的元数据：
{
+ "kotori": {
+ "enforce": "pre",
+ "meta": {
+ "languages": ["en_US", "ja_JP", "zh_TW", "zh_CN"]
+ }
+ }
+}一个合法的 Kotori 模块其 package.json 需要满足一系列来自 Kotori 的约定，Kotori 程序只有在其合法时才会加载该模块。不过当前你无需关心这个问题，元数据与 package.json 约定将放在「模块化」章节中讲解。以下是该 package.json 的完整效果：
{
+ "name": "kotori-plugin-my-project",
+ "version": "1.0.0",
+ "description": "This is my first Kotori plugin",
+ "main": "lib/.js",
+ "scripts": {
+ "build": "tsc --build"
+ },
+ "license": "GPL-3.0",
+ "keywords": [
+ "kotori-plugin"
+ ],
+ "files": [
+ "lib",
+ "LICENSE",
+ "README.md"
+ ],
+ ,
+ "peerDependencies": {
+ "kotori-bot": "1.1.0"
+ },
+ "author": "Himeno <biyuehuya@gmail.com>",
+ "bugs": {
+ "url": "https://github.com/kotorijs/my-project/issues"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/kotorijs/my-project.git"
+ },
+ "homepage": "https://github.com/kotorijs/my-project/",
+ "kotori": {
+ "enforce": "pre",
+ "meta": {
+ "languages": [
+ "en_US",
+ "ja_JP",
+ "zh_TW",
+ "zh_CN"
+ ]
+ }
+ }
+}关于
package.json的默认配置项与更多信息请参考 npm Docs。
以下为默认创建的 index.ts，当前你还无需理解其具体含义：
import type { Context } from 'kotori-bot';
+import config from './config.ts';
+import types from './types.ts';
+
+export function main(ctx: Context) {
+ ctx
+ .command('echo <content> [num:number=3]')
+ .action((data, message) => {
+ ctx.logger.debug(data, data.args[0]);
+ ctx.logger.debug(message);
+ return [
+ \`返回消息:~%message%\`,
+ {
+ message: data.args[0],
+ },
+ ];
+ })
+ .alias('print')
+ .scope('group');
+
+ ctx.regexp(/^(.*)#print$/, match => match[1]);
+
+ ctx.command('ison').action((_, events) => {
+ if (events.api.adapter.config.master === events.userId) return \`在的哟主人~\`;
+ return '你是...谁?';
+ });
+}在入门教程中提到过使用「@kotori-bot/kotori-plugin-adapter-cmd」适配器可以在命令行中测试指令，但命令行本身仅支持纯文字交互因此并不友好也不便于开发者调试。同样的，Kotori 已默认安装「@kotori-bot/kotori-plugin-adapter-sandbox」适配器，它提供了一个极为方便、全面的机器人沙盒测试环境，只需在 kotori.yml 中设置该适配器即可：
adapter:
+ developer:
+ extends: sandbox
+ master: 1
+ port: 2333运行模式分为 「生产模式（Build）」与「开发模式（Dev）」两种：
src/.ts 。kotori.yml，Dev 模式下读取 kotori.dev.yml，两者用法与实际效果均一致，旨在区分不同模式下不同配置。从 Dev 模式下启动 Kotori：
pnpm dev在浏览器中打开 http://localhost:2333 即可进入沙盒环境，输入 /echo Hello,Kotori! 以查看效果：
WARNING
KotoriV1 文档正在建设并完善中
kotori 是一个跨平台、解耦合、现代化于一体的聊天机器人框架，运行于 Node.js 环境，使用 TypeScript 语言开发。
「Kotori」是一个罗马字，在日语中是「ことり」（小鳥）的意思，发音为 /kotoliː/ ，该名字取自于 Key 公式 的游戏 《Rewrite》 中主要女性角色之一：神户小鸟 (神戸（かんべ） 小鳥（ことり）)。 借助 Kotori，可快速搭建一个多平台、功能强大的聊天机器人应用，通过安装不同模块为 Kotori 扩展功能、玩法和个性化配置等。同时，Kotori 为开发者提供了现成的 Cli 用于模块开发与 Kotori 二次开发。
跨平台 得益于模块化支持，通过编写各种模块实现不同的功能与聊天平台接入
解耦合 基于控制反转（IOC）与面向切面编程（AOP）思想，减少代码冗余与复杂度
现代化 使用现代化的 ECMAScript 语法规范与强大的 TypeScript 类型支持
「create-kotori」是专用于构建 Kotori 模块的 Cli 工具。
create-kotori <project-name>pnpm init kotori@latest my-project除此之外，也可以将其安装在全局使用：
npm install create-kotori -g
+create-kotori my-project亦称为「工作区开发」，该方法适用于有一定 Node.js 开发经验的开发者，并不推荐新人使用。使用该方法可同时开发多个插件，也可在开发当前插件时安装使用其它插件，同时可以便捷的修改与调试 Kotori 源码并进行二次开发。使用 Git 直接克隆 Kotorijs/kotori 仓库的源码：
git clone https://github.com/kotorijs/kotori.git此处默认克隆的是主分支下的代码，也可以选择克隆 dev 分支，该内容将在 进阶开发中 详细说明。进入根目录并使用 pnpm 安装依赖：
cd ./kotori-bot-master
+pnpm install在 ./modules/ 目录下使用 create-kotori 创建一个模块：
cd ./modules/
+pnpm init kotori@latest my-project
+cd ./my-project/my-project
+├── kotori.yml
+├── package.json
+├── tsconfig.json
+├── LICENSE
+├── README.md
+├── .gitignore
+├── node_modules
+├── lib
+│ ├── index.js
+│ ├── index.d.ts
+│ ├── ...
+├── locales
+│ ├── en_US.json
+│ ├── ja_JP.json
+│ ├── zh_CN.json
+│ └── zh_TW.json
+└── src
+ ├── config.ts
+ ├── index.ts
+ ├── types.tskotori.yml 仅在直接构建时存在于模块根目录，工作区开发下将位于工作区的根目录。
kotori.yml Kotori 配置文件kotori.dev.yml Kotori Dev 模式下配置文件package.json 包信息文件tsconfig.json TypeScript 配置文件LICENSE 协议文件README.md 自述文件.gitignore git 忽略文件lib 构建产物输出目录（前端为 dist，后端为 lib）locales 国际化文件夹，将在后面的章节中讲解src 工程文件夹，代码存放处 cofig.ts 默认配置数据文件index.ts 整个模块的入口文件types.ts 公共类型文件以下为默认创建的 package.json：
{
+ "name": "kotori-plugin-my-project",
+ "version": "1.0.0",
+ "description": "This is my first Kotori plugin",
+ "main": "lib/.js",
+ "scripts": {
+ "build": "tsc --build"
+ },
+ "license": "GPL-3.0",
+ "keywords": ["kotori-plugin"],
+ "files": ["lib", "LICENSE", "README.md"],
+ "peerDependencies": {
+ "kotori-bot": "1.1.0"
+ }
+}添加一些非必要配置项以完善包信息：
{
+ "author": "Himeno <biyuehuya@gmail.com>",
+ "bugs": {
+ "url": "https://github.com/kotorijs/my-project/issues"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/kotorijs/my-project.git"
+ },
+ "homepage": "https://github.com/kotorijs/my-project/"
+}添加用于传给 Kotori 的元数据：
{
+ "kotori": {
+ "enforce": "pre",
+ "meta": {
+ "languages": ["en_US", "ja_JP", "zh_TW", "zh_CN"]
+ }
+ }
+}一个合法的 Kotori 模块其 package.json 需要满足一系列来自 Kotori 的约定，Kotori 程序只有在其合法时才会加载该模块。不过当前你无需关心这个问题，元数据与 package.json 约定将放在「模块化」章节中讲解。以下是该 package.json 的完整效果：
{
+ "name": "kotori-plugin-my-project",
+ "version": "1.0.0",
+ "description": "This is my first Kotori plugin",
+ "main": "lib/.js",
+ "scripts": {
+ "build": "tsc --build"
+ },
+ "license": "GPL-3.0",
+ "keywords": [
+ "kotori-plugin"
+ ],
+ "files": [
+ "lib",
+ "LICENSE",
+ "README.md"
+ ],
+ ,
+ "peerDependencies": {
+ "kotori-bot": "1.1.0"
+ },
+ "author": "Himeno <biyuehuya@gmail.com>",
+ "bugs": {
+ "url": "https://github.com/kotorijs/my-project/issues"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/kotorijs/my-project.git"
+ },
+ "homepage": "https://github.com/kotorijs/my-project/",
+ "kotori": {
+ "enforce": "pre",
+ "meta": {
+ "languages": [
+ "en_US",
+ "ja_JP",
+ "zh_TW",
+ "zh_CN"
+ ]
+ }
+ }
+}关于
package.json的默认配置项与更多信息请参考 npm Docs。
以下为默认创建的 index.ts，当前你还无需理解其具体含义：
import type { Context } from 'kotori-bot';
+import config from './config.ts';
+import types from './types.ts';
+
+export function main(ctx: Context) {
+ ctx
+ .command('echo <content> [num:number=3]')
+ .action((data, message) => {
+ ctx.logger.debug(data, data.args[0]);
+ ctx.logger.debug(message);
+ return [
+ `返回消息:~%message%`,
+ {
+ message: data.args[0],
+ },
+ ];
+ })
+ .alias('print')
+ .scope('group');
+
+ ctx.regexp(/^(.*)#print$/, match => match[1]);
+
+ ctx.command('ison').action((_, events) => {
+ if (events.api.adapter.config.master === events.userId) return `在的哟主人~`;
+ return '你是...谁?';
+ });
+}在入门教程中提到过使用「@kotori-bot/kotori-plugin-adapter-cmd」适配器可以在命令行中测试指令，但命令行本身仅支持纯文字交互因此并不友好也不便于开发者调试。同样的，Kotori 已默认安装「@kotori-bot/kotori-plugin-adapter-sandbox」适配器，它提供了一个极为方便、全面的机器人沙盒测试环境，只需在 kotori.yml 中设置该适配器即可：
adapter:
+ developer:
+ extends: sandbox
+ master: 1
+ port: 2333运行模式分为 「生产模式（Build）」与「开发模式（Dev）」两种：
src/.ts 。kotori.yml，Dev 模式下读取 kotori.dev.yml，两者用法与实际效果均一致，旨在区分不同模式下不同配置。从 Dev 模式下启动 Kotori：
pnpm dev在浏览器中打开 http://localhost:2333 即可进入沙盒环境，输入 /echo Hello,Kotori! 以查看效果：