create-kokkoro 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Yuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,8 +2,42 @@
 
 Kokkoro QQ 机器人框架的项目创建工具。
 
+## 使用
+
+运行以下命令创建 Kokkoro 项目：
+
 ```shell
 bun create kokkoro
 ```
 
-按照提示输入项目名称，即可在当前目录创建 Kokkoro 项目。
+命令会创建项目目录、`plugins` 目录、`package.json`、`kokkoro.json` 和 `main.ts`。
+
+如果项目目录不是空目录，创建将中止。使用 `--force` 选项可以覆盖脚手架创建的同名文件，目录中的其他内容不受影响。
+
+```shell
+bun create kokkoro --force
+```
+
+## 配置项目
+
+命令会依次询问以下内容：
+
+1. 输入项目名称，默认值为 `kokkoro-app`。
+2. 输入服务端口，默认值为 `3000`。
+3. 选择 QQ 服务接入方式，可选 `WebSocket` 或 `WebHook`。
+4. 选择是否添加机器人。不添加机器人时，`kokkoro.json` 中的 `bots` 为空数组。
+5. 添加机器人时，输入机器人的 `AppID` 和 `ClientSecret`。
+6. 使用 `WebHook` 并添加机器人时，输入 WebHook 路径，默认值为 `/callback`。
+
+### 启动项目
+
+创建完成后，进入项目目录并安装依赖：
+
+```shell
+cd kokkoro-app
+
+bun install
+bun start
+```
+
+将 `kokkoro-app` 替换为你输入的项目名称。

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-kokkoro",
-  "version": "0.0.0",
-  "description": "The project scaffolding tool for the Kokkoro QQ bot framework.",
+  "version": "0.1.0",
+  "description": "The project creation tool for the Kokkoro QQ bot framework.",
   "keywords": [
     "bot",
     "kokkoro",
@@ -20,12 +20,16 @@
   "license": "MIT",
   "author": "Yuki <admin@yuki.sh>",
   "type": "module",
+  "exports": "./src/project.ts",
   "bin": {
     "create-kokkoro": "./src/index.ts"
   },
   "files": [
     "src"
   ],
+  "dependencies": {
+    "komut": "^0.2.0"
+  },
   "peerDependencies": {
     "typescript": "^6.0.3"
   }

package/src/index.ts

@@ -1 +1,16 @@
 #!/usr/bin/env bun
+
+import { argv } from 'bun';
+
+import { input } from 'komut/prompts';
+
+import { createProject } from './project';
+
+const name = input('项目名称', { default: 'kokkoro-app' });
+
+if (name === null) {
+  throw new Error('已取消创建项目。');
+}
+const isForced = argv.includes('--force');
+
+await createProject(name, isForced);

package/src/project.ts

@@ -0,0 +1,155 @@
+import { Glob, write } from 'bun';
+import { mkdir } from 'node:fs/promises';
+import { basename, join, resolve } from 'node:path';
+
+import { input, select } from 'komut/prompts';
+
+type Protocol = 'websocket' | 'webhook';
+
+async function hasEntries(directory: string): Promise<boolean> {
+  try {
+    const entries = new Glob('*').scan({
+      cwd: directory,
+      dot: true,
+      onlyFiles: false,
+    });
+    const iterator = entries[Symbol.asyncIterator]();
+    const { done } = await iterator.next();
+
+    return !done;
+  } catch (error) {
+    if (error instanceof Error && 'code' in error && error.code === 'ENOENT') {
+      return false;
+    }
+    throw error;
+  }
+}
+
+function prompt(message: string, defaultValue?: string): string {
+  const value = input(message, { default: defaultValue });
+
+  if (value === null) {
+    throw new Error('已取消创建项目。');
+  }
+  return value;
+}
+
+function promptRequired(message: string): string {
+  while (true) {
+    const value = prompt(message);
+
+    if (value) {
+      return value;
+    }
+    console.error(`${message}不能为空。`);
+  }
+}
+
+function promptPort(): number {
+  while (true) {
+    const port = Number(prompt('服务端口', '3000'));
+
+    if (Number.isInteger(port) && port >= 0 && port <= 65535) {
+      return port;
+    }
+    console.error('服务端口必须是 0 到 65535 之间的整数。');
+  }
+}
+
+function promptProtocol(): Protocol {
+  const choice = select('QQ 服务接入方式', [
+    { label: 'WebSocket', value: 'websocket' },
+    { label: 'WebHook', value: 'webhook' },
+  ]);
+
+  if (choice === null) {
+    throw new Error('已取消创建项目。');
+  }
+  return <Protocol>choice.value;
+}
+
+function promptWebHookPath(): string {
+  while (true) {
+    const path = prompt('WebHook 路径', '/callback');
+
+    if (path.startsWith('/')) {
+      return path;
+    }
+    console.error('WebHook 路径必须以 / 开头。');
+  }
+}
+
+function promptBots(protocol: Protocol) {
+  const choice = select('是否添加机器人', [
+    { label: '是', value: 'yes' },
+    { label: '否', value: 'no' },
+  ]);
+
+  if (choice === null) {
+    throw new Error('已取消创建项目。');
+  }
+
+  if (choice.value === 'no') {
+    return [];
+  }
+  const bot = {
+    appId: promptRequired('机器人 AppID'),
+    clientSecret: promptRequired('机器人 ClientSecret'),
+  };
+
+  return protocol === 'webhook' ? [{ ...bot, webhook: { path: promptWebHookPath() } }] : [bot];
+}
+
+/** 在指定目录创建 Kokkoro 项目。 */
+export async function createProject(directory: string, isForced = false): Promise<void> {
+  if ((await hasEntries(directory)) && !isForced) {
+    throw new Error(`目标目录不是空目录。如需继续，请使用 --force 选项覆盖模板文件。\n${directory}`);
+  }
+  const port = promptPort();
+  const protocol = promptProtocol();
+  const bots = promptBots(protocol);
+  const name = basename(resolve(directory));
+  const manifest = {
+    name,
+    private: true,
+    type: 'module',
+    scripts: {
+      start: 'bun run main.ts',
+    },
+    dependencies: {
+      kokkoro: '^3.0.0',
+    },
+    devEngines: {
+      runtime: {
+        name: 'bun',
+        onFail: 'warn',
+      },
+      packageManager: {
+        name: 'bun',
+        onFail: 'warn',
+      },
+    },
+  };
+  const config = {
+    $schema: 'https://kokkoro.js.org/schema.json',
+    protocol,
+    server: { port },
+    bots,
+  };
+  const pluginsDirectory = join(directory, 'plugins');
+
+  await mkdir(pluginsDirectory, { recursive: true });
+  await Promise.all([
+    write(join(directory, 'package.json'), `${JSON.stringify(manifest, null, 2)}\n`),
+    write(join(directory, 'kokkoro.json'), `${JSON.stringify(config, null, 2)}\n`),
+    write(join(directory, 'main.ts'), "import { run } from 'kokkoro';\n\nawait run();\n"),
+  ]);
+
+  console.log('\n项目创建完成，请依次运行以下命令：\n');
+
+  if (directory !== '.') {
+    console.log(`  cd ${directory}`);
+  }
+  console.log('  bun install');
+  console.log('  bun start');
+}