From 328b47106a9c0e13449a79b64b674f1a452ba41d Mon Sep 17 00:00:00 2001 From: Shigma <1700011071@pku.edu.cn> Date: Wed, 27 Apr 2022 19:22:33 +0800 Subject: [PATCH] chore: use symlink --- README.md | 68 +---------------------------------- packages/core/src/database.ts | 2 ++ packages/koishi/.gitignore | 1 - packages/koishi/readme.md | 67 ++++++++++++++++++++++++++++++++++ 4 files changed, 70 insertions(+), 68 deletions(-) mode change 100644 => 120000 README.md delete mode 100644 packages/koishi/.gitignore create mode 100644 packages/koishi/readme.md diff --git a/README.md b/README.md deleted file mode 100644 index 9a578fcdec..0000000000 --- a/README.md +++ /dev/null @@ -1,67 +0,0 @@ -
- - logo - -

Koishi

- -[![Codecov](https://img.shields.io/codecov/c/github/koishijs/koishi?style=flat-square)](https://codecov.io/gh/koishijs/koishi) -[![downloads](https://img.shields.io/npm/dm/koishi?style=flat-square)](https://www.npmjs.com/package/koishi) -[![npm](https://img.shields.io/npm/v/koishi?style=flat-square)](https://www.npmjs.com/package/koishi) -[![GitHub](https://img.shields.io/github/license/koishijs/koishi?style=flat-square)](https://github.com/koishijs/koishi/blob/master/LICENSE) - -
- -Koishi 是一个现代化跨平台机器人框架，目前可支持 [QQ](https://im.qq.com/)，[Telegram](https://telegram.org/)，[Discord](https://discord.com/) 等多个平台。 - -这个项目的名字和图标来源于东方 Project 中的角色古明地恋 (Komeiji Koishi)。 - -## 特性 - -### 开箱即用的控制台 - -高度便利的脚手架让你无需基础让你在几分钟之内搭建自己的聊天机器人。 - -- 提供在线插件市场，即使没有 js 编程基础，也能轻松在控制台中下载安装插件 -- 支持 QQ，Telegram，Discord 等主流聊天平台，支持多账户和跨平台数据互通 -- 随时随地通过控制面板监控运行状态，控制机器人的行为，甚至上号聊天 - -参见：[模板项目](https://koishi.js.org/manual/starter/installation.html) - -### 功能强大的 API - -经过了几个版本的迭代，Koishi 已经发展出了丰富的 API。从上层负责交互的指令、会话、中间件，再到中层负责控制的应用、上下文、插件，最后到底层的机器人和适配器，每一个部分都经过了精心的编写，可以让你轻松实现任何需求。如果担心在复杂的功能中迷失方向，我们也准备了细致的文档来提供帮助。 - -参见：[API 文档](https://koishi.js.org/api/) - -### 丰富的生态系统 - -Koishi 本体仅有不到 100 KB，绝大部分功能都采用插件化分发。上百个官方和社区插件，覆盖了机器人开发的方方面面，从平台接入、数据库、资源存储、网页控制台、状态管理到具体的业务功能一应俱全。无论你的目标是构建大型交互应用还是轻量级的业务机器人，Koishi 都为你提供了最佳实践。 - -参见：[插件市场](https://koishi.js.org/market.html) - -### 专为开发者打造 - -Koishi 更为开发者提供了众多专业功能，使开发者得以在各种复杂需求中构建规模化的解决方案。 - -- **类型支持**：拥有顶级的 TypeScript 类型支持，丰富的代码提示让你在编写代码的时候甚至无需查看文档 -- **单元测试**：核心功能均已经通过单元测试，既确保了可靠性，也为开发者提供了一套现代化开发的最佳实践 -- **模块热重载**：只需轻点保存即可热重载，无需频繁重启机器人，如同前端开发一样丝滑顺畅 - -## 使用协议 - -Koishi 完全使用 [MIT](./LICENSE) 协议开源，维护良好的开源生态从我做起 (*>ω<)φ - -Copyright © 2019-2022, Shigma - -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi?ref=badge_large) - -## 贡献指南 - -[请看这里](./.github/contributing.md) - -## 联系方式 - -[![Discord](https://img.shields.io/discord/811975252883800125?label=discord&style=flat-square&logo=discord&logoColor=white)](https://discord.gg/xfxYwmd284) -[![QQ](https://img.shields.io/badge/QQ-426230045-brightgreen?style=flat-square&logo=tencent-qq&logoColor=white)](https://jq.qq.com/?_wv=1027&k=6FDoxQ6g) - -本群只交流程序开发，不欢迎伸手党，禁止谈论商业行为。 diff --git a/README.md b/README.md new file mode 120000 index 0000000000..4a7530bfc0 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +./packages/koishi/readme.md \ No newline at end of file diff --git a/packages/core/src/database.ts b/packages/core/src/database.ts index 7059c214b9..0c5f668218 100644 --- a/packages/core/src/database.ts +++ b/packages/core/src/database.ts @@ -5,6 +5,7 @@ import { Context } from './context' import ns from 'ns-require' export interface User { + // TODO v5: change to number id: string flag: number authority: number @@ -75,6 +76,7 @@ export class DatabaseService extends Database { super() this.extend('user', { + // TODO v5: change to number id: 'string(63)', name: 'string(63)', flag: 'unsigned(20)', diff --git a/packages/koishi/.gitignore b/packages/koishi/.gitignore deleted file mode 100644 index b43bf86b50..0000000000 --- a/packages/koishi/.gitignore +++ /dev/null @@ -1 +0,0 @@ -README.md diff --git a/packages/koishi/readme.md b/packages/koishi/readme.md new file mode 100644 index 0000000000..9a578fcdec --- /dev/null +++ b/packages/koishi/readme.md @@ -0,0 +1,67 @@ +
+ + logo + +

Koishi

+ +[![Codecov](https://img.shields.io/codecov/c/github/koishijs/koishi?style=flat-square)](https://codecov.io/gh/koishijs/koishi) +[![downloads](https://img.shields.io/npm/dm/koishi?style=flat-square)](https://www.npmjs.com/package/koishi) +[![npm](https://img.shields.io/npm/v/koishi?style=flat-square)](https://www.npmjs.com/package/koishi) +[![GitHub](https://img.shields.io/github/license/koishijs/koishi?style=flat-square)](https://github.com/koishijs/koishi/blob/master/LICENSE) + +
+ +Koishi 是一个现代化跨平台机器人框架，目前可支持 [QQ](https://im.qq.com/)，[Telegram](https://telegram.org/)，[Discord](https://discord.com/) 等多个平台。 + +这个项目的名字和图标来源于东方 Project 中的角色古明地恋 (Komeiji Koishi)。 + +## 特性 + +### 开箱即用的控制台 + +高度便利的脚手架让你无需基础让你在几分钟之内搭建自己的聊天机器人。 + +- 提供在线插件市场，即使没有 js 编程基础，也能轻松在控制台中下载安装插件 +- 支持 QQ，Telegram，Discord 等主流聊天平台，支持多账户和跨平台数据互通 +- 随时随地通过控制面板监控运行状态，控制机器人的行为，甚至上号聊天 + +参见：[模板项目](https://koishi.js.org/manual/starter/installation.html) + +### 功能强大的 API + +经过了几个版本的迭代，Koishi 已经发展出了丰富的 API。从上层负责交互的指令、会话、中间件，再到中层负责控制的应用、上下文、插件，最后到底层的机器人和适配器，每一个部分都经过了精心的编写，可以让你轻松实现任何需求。如果担心在复杂的功能中迷失方向，我们也准备了细致的文档来提供帮助。 + +参见：[API 文档](https://koishi.js.org/api/) + +### 丰富的生态系统 + +Koishi 本体仅有不到 100 KB，绝大部分功能都采用插件化分发。上百个官方和社区插件，覆盖了机器人开发的方方面面，从平台接入、数据库、资源存储、网页控制台、状态管理到具体的业务功能一应俱全。无论你的目标是构建大型交互应用还是轻量级的业务机器人，Koishi 都为你提供了最佳实践。 + +参见：[插件市场](https://koishi.js.org/market.html) + +### 专为开发者打造 + +Koishi 更为开发者提供了众多专业功能，使开发者得以在各种复杂需求中构建规模化的解决方案。 + +- **类型支持**：拥有顶级的 TypeScript 类型支持，丰富的代码提示让你在编写代码的时候甚至无需查看文档 +- **单元测试**：核心功能均已经通过单元测试，既确保了可靠性，也为开发者提供了一套现代化开发的最佳实践 +- **模块热重载**：只需轻点保存即可热重载，无需频繁重启机器人，如同前端开发一样丝滑顺畅 + +## 使用协议 + +Koishi 完全使用 [MIT](./LICENSE) 协议开源，维护良好的开源生态从我做起 (*>ω<)φ + +Copyright © 2019-2022, Shigma + +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi?ref=badge_large) + +## 贡献指南 + +[请看这里](./.github/contributing.md) + +## 联系方式 + +[![Discord](https://img.shields.io/discord/811975252883800125?label=discord&style=flat-square&logo=discord&logoColor=white)](https://discord.gg/xfxYwmd284) +[![QQ](https://img.shields.io/badge/QQ-426230045-brightgreen?style=flat-square&logo=tencent-qq&logoColor=white)](https://jq.qq.com/?_wv=1027&k=6FDoxQ6g) + +本群只交流程序开发，不欢迎伸手党，禁止谈论商业行为。