diff --git a/zh-CN/guide/develop/publish.md b/zh-CN/guide/develop/publish.md index 678e5137328a..f9bb04e2767f 100644 --- a/zh-CN/guide/develop/publish.md +++ b/zh-CN/guide/develop/publish.md @@ -153,12 +153,12 @@ root 编辑完上面的清单文件并 [构建源代码](./workspace.md#构建源代码) 后,你就可以公开发布你的插件了。 ::: tabs code -```npm -npm run pub [...name] -``` ```yarn yarn pub [...name] ``` +```npm +npm run pub [...name] +``` ::: - **name:** 要发布的插件列表,缺省时表示全部 (此处 `name` 不包含 `koishi-plugin-` 前缀,而是你的工作区目录名) @@ -179,12 +179,12 @@ No token found and can't prompt for login when running with --non-interactive. 此时你需要在发布时使用官方镜像,具体操作如下: ::: tabs code -```npm -npm run pub [...name] -- --registry https://registry.npmjs.org -``` ```yarn yarn pub [...name] --registry https://registry.yarnpkg.com ``` +```npm +npm run pub [...name] -- --registry https://registry.npmjs.org +``` ::: 对于 Yarn v2 及以上版本,你还可以分别针对发布和安装设置不同的镜像: @@ -204,12 +204,12 @@ yarn config set npmPublishRegistry https://registry.yarnpkg.com 初始创建的插件版本号为 `1.0.0`。当你修改过插件后,你需要更新版本号才能重新发布。在应用目录运行下面的命令以更新版本号: ::: tabs code -```npm -npm run bump [...name] -- [-1|-2|-3|-p|-v ] [-r] -``` ```yarn yarn bump [...name] [-1|-2|-3|-p|-v ] [-r] ``` +```npm +npm run bump [...name] -- [-1|-2|-3|-p|-v ] [-r] +``` ::: - **name:** 要更新的插件列表,不能为空 diff --git a/zh-CN/guide/develop/script.md b/zh-CN/guide/develop/script.md index f50cdf9faf74..1404911c025c 100644 --- a/zh-CN/guide/develop/script.md +++ b/zh-CN/guide/develop/script.md @@ -22,12 +22,12 @@ Koishi 提供了一套命令行工具,用于读取配置文件快速启动应 在应用目录运行下面的命令行以启动 Koishi 应用: ::: tabs code -```npm -npm run start -``` ```yarn yarn start ``` +```npm +npm run start +``` ::: 在本节的后续部分,我们会介绍上述启动脚本的更多参数。无论你做何改动,你都可以使用上面的命令行来快速启动。这也是启动脚本的意义所在。 @@ -47,12 +47,12 @@ Koishi 的命令行工具支持自动重启。当运行 Koishi 的进程崩溃 除了 `start` 以外,模板项目还准备了名为 `dev` 的开发模式启动脚本。在应用目录运行下面的命令行可以以开发模式启动应用: ::: tabs code -```npm -npm run dev -``` ```yarn yarn dev ``` +```npm +npm run dev +``` ::: 如你所见,`dev` 相当于在 `start` 指令的基础上添加了额外的参数和环境变量。这些参数为我们启用了额外的特性,而环境变量则能影响插件的部分行为。 diff --git a/zh-CN/guide/develop/setup.md b/zh-CN/guide/develop/setup.md index f1e139781c59..6439b7406a79 100644 --- a/zh-CN/guide/develop/setup.md +++ b/zh-CN/guide/develop/setup.md @@ -59,12 +59,12 @@ git config –-global user.email "you@example.com" 输入下面的命令以创建 Koishi 项目: ::: tabs code -```npm -npm init koishi@latest -``` ```yarn yarn create koishi ``` +```npm +npm init koishi@latest +``` ::: 跟随提示即可完成全套初始化流程。 diff --git a/zh-CN/guide/develop/workspace.md b/zh-CN/guide/develop/workspace.md index 489cdf483e4f..e337ec409e88 100644 --- a/zh-CN/guide/develop/workspace.md +++ b/zh-CN/guide/develop/workspace.md @@ -11,12 +11,12 @@ Koishi 的核心是插件系统,绝大部分 Koishi 功能都可以通过插 在应用目录运行下面的命令以创建一个新的插件工作区: ::: tabs code -```npm -npm run setup [name] -- [-c] [-m] [-G] -``` ```yarn yarn setup [name] [-c] [-m] [-G] ``` +```npm +npm run setup [name] -- [-c] [-m] [-G] +``` ::: - **name:** 插件的包名,缺省时将进行提问 @@ -68,12 +68,12 @@ export function apply(ctx: Context) { 假设你的 npm 用户名是 `alice`,那么你可以使用下面的命令创建一个私域插件工作区: ::: tabs code -```npm -npm run setup @alice/example -``` ```yarn yarn setup @alice/example ``` +```npm +npm run setup @alice/example +``` ::: 此外,你还需要额外修改 `tsconfig.json` 文件。打开这个文件,你将看到下面的内容: @@ -98,12 +98,12 @@ yarn setup @alice/example 上面的插件暂时还只能在开发模式下运行。如果想要在生产模式下使用或发布到插件市场,你需要构建你的源代码。在应用目录运行下面的命令: ::: tabs code -```npm -npm run build [...name] -``` ```yarn yarn build [...name] ``` +```npm +npm run build [...name] +``` ::: - **name:** 要构建的插件列表,缺省时表示全部插件 @@ -118,12 +118,12 @@ yarn build [...name] 插件创建时,`package.json` 中已经包含了一些必要的依赖。如果你需要添加其他依赖,可以使用下面的命令: ::: tabs code -```npm -npm install [...deps] -w koishi-plugin-[name] -``` ```yarn yarn workspace koishi-plugin-[name] add [...deps] ``` +```npm +npm install [...deps] -w koishi-plugin-[name] +``` ::: - **name:** 你的插件名称 @@ -136,12 +136,12 @@ yarn workspace koishi-plugin-[name] add [...deps] 尽管 npm 和 yarn 等包管理器都提供了依赖更新功能,但它们对工作区开发的支持都不是很好。因此,我们也提供了一个简单的命令用于批量更新依赖版本。 ::: tabs code -```npm -npm run dep -``` ```yarn yarn dep ``` +```npm +npm run dep +``` ::: 这将按照每个 `package.json` 中声明的依赖版本进行更新。举个例子,如果某个依赖的版本是 `^1.1.4`,而这个依赖之后发布了新版本 `1.2.3` 和 `2.3.3`,那么运行该指令后,依赖的版本将会被更新为 `^1.2.3`。 @@ -163,12 +163,12 @@ yarn dep 其他人创建的工作区插件可以直接克隆到你的 `external` 目录下。例如,你可以使用下面的命令将 `koishi-plugin-forward` 插件克隆到本地: ::: tabs code -```npm -npm run clone koishijs/koishi-plugin-forward -``` ```yarn yarn clone koishijs/koishi-plugin-forward ``` +```npm +npm run clone koishijs/koishi-plugin-forward +``` ::: ### 开发 Koishi @@ -176,14 +176,14 @@ yarn clone koishijs/koishi-plugin-forward 工作区不仅可以用于插件的二次开发,还可以用于开发 Koishi 本身。只需使用下面的命令将 Koishi 仓库克隆到本地,并完成构建: ::: tabs code -```npm -npm run clone koishijs/koishi -npm run build -w @root/koishi -``` ```yarn yarn clone koishijs/koishi yarn workspace @root/koishi build ``` +```npm +npm run clone koishijs/koishi +npm run build -w @root/koishi +``` ::: 通常来说,非插件仓库在克隆下来之后还需经过路径配置才可以正常使用。不过不同担心,模板项目支持已经内置了 Koishi 生态中的几个核心仓库 ([koishi](https://github.com/koishijs/koishi), [satori](https://github.com/satorijs/satori), [minato](https://github.com/shigma/minato)) 的路径配置。 diff --git a/zh-CN/manual/starter/boilerplate.md b/zh-CN/manual/starter/boilerplate.md index 86a153c48b92..05834a7f2df6 100644 --- a/zh-CN/manual/starter/boilerplate.md +++ b/zh-CN/manual/starter/boilerplate.md @@ -40,7 +40,7 @@ Koishi 需要 [Node.js](https://nodejs.org/) (最低 v18,推荐使用 LTS) 运 ### 安装包管理器 -Node.js 自带名为 [npm](https://www.npmjs.com/) 的包管理器,你可以直接使用它。我们同时也推荐功能更强大的 [yarn](https://classic.yarnpkg.com/) 作为包管理器。它的安装非常简单,只需打开命令行输入下面的命令: +Node.js 自带名为 [npm](https://www.npmjs.com/) 的包管理器,你可以直接使用它。我们推荐使用功能更强大的 [yarn](https://classic.yarnpkg.com/) 作为包管理器。它的安装非常简单,只需打开命令行输入下面的命令: ```sh # 安装 yarn @@ -71,12 +71,12 @@ Set-ExecutionPolicy RemoteSigned 如果你是国内用户,从 npm 或 yarn 上下载依赖可能非常慢。因此,我们推荐你配置一下镜像源,以提升安装速度。 ::: tabs code -```npm -npm config set registry https://registry.npmmirror.com -``` ```yarn yarn config set registry https://registry.npmmirror.com ``` +```npm +npm config set registry https://registry.npmmirror.com +``` ::: ## 创建项目 @@ -93,12 +93,12 @@ yarn config set registry https://registry.npmmirror.com 输入下面的命令以创建 Koishi 项目: ::: tabs code -```npm -npm init koishi@latest -``` ```yarn yarn create koishi ``` +```npm +npm init koishi@latest +``` ::: 跟随提示即可完成全套初始化流程。 @@ -108,12 +108,12 @@ yarn create koishi 如果你顺利完成了上述操作,你的应用此时应该已经是启动状态,并弹出了控制台界面。如果你想要关闭应用,可以在命令行中按下 `Ctrl+C` 组合键。当应用处于关闭状态时,你可以在运行下面的指令以再次启动: ::: tabs code -```npm -npm start -``` ```yarn yarn start ``` +```npm +npm start +``` ::: ## 接下来…… diff --git a/zh-CN/manual/starter/direct.md b/zh-CN/manual/starter/direct.md index a4e3c01232e8..36f5828e1207 100644 --- a/zh-CN/manual/starter/direct.md +++ b/zh-CN/manual/starter/direct.md @@ -30,19 +30,6 @@ Koishi 需要 [Node.js](https://nodejs.org/) (最低 v18,推荐使用 LTS) 运 首先初始化你的机器人目录并安装 Koishi 和所需的插件 (这里以官方插件 console, sandbox 和 echo 为例): ::: tabs code -```npm -# 初始化项目 -npm init - -# 安装 Koishi 和相关插件 -npm i koishi \ - @koishijs/plugin-console \ - @koishijs/plugin-sandbox \ - @koishijs/plugin-echo - -# 安装 TypeScript 相关依赖 (如不使用可忽略此步骤) -npm i typescript @types/node esbuild esbuild-register -D -``` ```yarn # 初始化项目 yarn init @@ -56,6 +43,19 @@ yarn add koishi # 安装 TypeScript 相关依赖 (如不使用可忽略此步骤) yarn add typescript @types/node esbuild esbuild-register -D ``` +```npm +# 初始化项目 +npm init + +# 安装 Koishi 和相关插件 +npm i koishi \ + @koishijs/plugin-console \ + @koishijs/plugin-sandbox \ + @koishijs/plugin-echo + +# 安装 TypeScript 相关依赖 (如不使用可忽略此步骤) +npm i typescript @types/node esbuild esbuild-register -D +``` ::: 新建入口文件 `index.ts`,并写下这段代码: @@ -98,16 +98,16 @@ node -r esbuild-register . 如果你想要接入真实聊天平台,那么你只需要安装适配插件即可: ::: tabs code -```npm -# 以 Satori 和 Discord 适配器为例 -npm i @koishijs/plugin-adapter-satori \ - @koishijs/plugin-adapter-discord -``` ```yarn # 以 Satori 和 Discord 适配器为例 yarn add @koishijs/plugin-adapter-satori \ @koishijs/plugin-adapter-discord ``` +```npm +# 以 Satori 和 Discord 适配器为例 +npm i @koishijs/plugin-adapter-satori \ + @koishijs/plugin-adapter-discord +``` ::: 接着修改你刚刚创建的 `index.ts`。每个机器人相当于启用一个插件: @@ -144,14 +144,14 @@ Koishi 插件可以在 [npm](https://www.npmjs.com) 上获取。通常插件会 对于社区插件,使用类似的方式安装和加载: ::: tabs code -```npm -# 以 puppeteer 和 forward 插件为例 -npm i koishi-plugin-puppeteer koishi-plugin-forward -``` ```yarn # 以 puppeteer 和 forward 插件为例 yarn add koishi-plugin-puppeteer koishi-plugin-forward ``` +```npm +# 以 puppeteer 和 forward 插件为例 +npm i koishi-plugin-puppeteer koishi-plugin-forward +``` ::: ```ts title=index.ts