create-forkly 0.1.1

package/dist/index.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+/** create-forkly — Forkly 项目脚手架 CLI */
+import { cac } from 'cac';
+import * as p from '@clack/prompts';
+import { mkdirSync, readFileSync, readdirSync, statSync, writeFileSync } from 'node:fs';
+import { resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { execSync } from 'node:child_process';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const templateDir = resolve(__dirname, '../template');
+function copyDir(src, dest, replaces) {
+    mkdirSync(dest, { recursive: true });
+    for (const entry of readdirSync(src)) {
+        const srcPath = resolve(src, entry);
+        const destPath = resolve(dest, entry);
+        if (statSync(srcPath).isDirectory()) {
+            copyDir(srcPath, destPath, replaces);
+        }
+        else {
+            let content = readFileSync(srcPath, 'utf-8');
+            for (const [k, v] of Object.entries(replaces)) {
+                content = content.replace(new RegExp(k, 'g'), v);
+            }
+            writeFileSync(destPath, content);
+        }
+    }
+}
+const cli = cac('create-forkly');
+cli.command('[dir]', 'Create a new Forkly project')
+    .action(async (dir = '.') => {
+    p.intro('Forkly Project Scaffolder');
+    const projectName = await p.text({
+        message: 'Project name:',
+        placeholder: 'my-forkly-app',
+        defaultValue: dir === '.' ? 'my-forkly-app' : dir,
+    });
+    if (p.isCancel(projectName)) {
+        p.cancel('Cancelled');
+        process.exit(0);
+    }
+    const useTypeScript = await p.confirm({
+        message: 'Use TypeScript?',
+        initialValue: true,
+    });
+    if (p.isCancel(useTypeScript)) {
+        p.cancel('Cancelled');
+        process.exit(0);
+    }
+    const targetDir = resolve(process.cwd(), dir === '.' ? projectName : dir);
+    const replaces = { 'forkly-app': projectName };
+    p.log.step('Copying template files...');
+    copyDir(templateDir, targetDir, replaces);
+    // 更新 package.json 中的项目名
+    const pkgPath = resolve(targetDir, 'package.json');
+    const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+    pkg.name = projectName;
+    writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+    if (!useTypeScript) {
+        // 如果不用 TS，移除 tsconfig，把 .ts 文件改为 .js
+        p.log.step('Setting up JavaScript project...');
+    }
+    p.log.step('Installing dependencies...');
+    try {
+        execSync('npm install', { cwd: targetDir, stdio: 'inherit' });
+    }
+    catch {
+        p.log.warn('npm install failed. You can run it manually.');
+    }
+    p.outro(`Done! Run:\n  cd ${projectName}\n  npm run dev`);
+});
+cli.help();
+cli.version('0.1.1');
+cli.parse();

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "create-forkly",
+  "version": "0.1.1",
+  "description": "CLI to scaffold a new Forkly project",
+  "type": "module",
+  "bin": {
+    "create-forkly": "./dist/index.js"
+  },
+  "files": ["dist/", "template/"],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@clack/prompts": "^0.10.1",
+    "cac": "^6.7.14"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "tsx": "^4.22.4",
+    "typescript": "^5.8.0"
+  }
+}

package/template/app.ts

@@ -0,0 +1,33 @@
+/** Forkly 应用入口 — 启动 App 并注册钩子与定时任务 */
+import { App } from 'forkly';
+
+const app = new App({
+  port: 3000,
+  workers: 4,
+});
+
+// 注册全局日志回调
+app.onLog((level, message) => {
+  console.log(`[${level.toUpperCase()}] ${message}`);
+});
+
+// 注册全局前置钩子
+app.beforeRequest(async (router) => {
+  router.state.startTime = Date.now();
+});
+
+// 注册全局后置钩子
+app.afterResponse(async (router) => {
+  const elapsed = Date.now() - ((router.state.startTime as number) ?? 0);
+  console.log(`${router.request.method} ${router.request.pathname} ${router.response.status} ${elapsed}ms`);
+});
+
+// 注册定时任务：每天凌晨 3 点清理过期 session
+app.schedule('0 3 * * *', async () => {
+  console.log('Running daily cleanup...');
+});
+
+// 启动应用
+app.start().then(() => {
+  console.log('Forkly app started');
+});

package/template/config/default.json

@@ -0,0 +1,7 @@
+{
+  "port": 3000,
+  "workers": 4,
+  "session": { "secret": "your-secret-key-change-me", "maxAge": 86400000 },
+  "errorFormat": "json",
+  "logger": { "level": "info" }
+}

package/template/config/errors.json

@@ -0,0 +1,11 @@
+{
+  "NOT_FOUND": { "zh": "资源未找到", "en": "Not Found" },
+  "VALIDATION_ERROR": { "zh": "参数校验失败", "en": "Validation Error" },
+  "INTERNAL_ERROR": { "zh": "服务器内部错误", "en": "Internal Server Error" },
+  "TIMEOUT": { "zh": "请求超时", "en": "Request Timeout" },
+  "UNAUTHORIZED": { "zh": "未授权", "en": "Unauthorized" },
+  "FORBIDDEN": { "zh": "禁止访问", "en": "Forbidden" },
+  "TOO_MANY_REQUESTS": { "zh": "请求频繁，请稍后再试", "en": "Too Many Requests" },
+  "USER_NOT_FOUND": { "zh": "用户不存在", "en": "User Not Found" },
+  "INVALID_INPUT": { "zh": "输入参数无效", "en": "Invalid Input" }
+}

package/template/config/production.json

@@ -0,0 +1,6 @@
+{
+  "port": 8080,
+  "session": { "secret": "production-secret-change-me" },
+  "errorFormat": "json",
+  "logger": { "level": "warn" }
+}

package/template/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "forkly-app",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "tsx watch app.ts",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "forkly": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "tsx": "^4.22.4",
+    "typescript": "^5.8.0"
+  }
+}

package/template/pages/hello.ts

@@ -0,0 +1,19 @@
+/** Hello 路由 — GET /hello?name=world，含 dataType 校验 */
+import { Router } from 'forkly';
+
+export class HelloRouter extends Router {
+  static channel = 'async' as const;
+  static dataType = {
+    query: { name: 'string' },
+  } as const;
+
+  async get() {
+    const name = this.request.query.name ?? 'World';
+    return { message: `Hello, ${name}!` };
+  }
+
+  async post() {
+    const { name } = this.request.body as { name?: string } ?? {};
+    return { message: `Hello, ${name ?? 'World'}! (POST)` };
+  }
+}

package/template/pages/index.ts

@@ -0,0 +1,14 @@
+/** 首页路由 — GET / */
+import { Router } from 'forkly';
+
+export class IndexRouter extends Router {
+  static channel = 'async' as const;
+
+  async get() {
+    return {
+      message: 'Welcome to Forkly!',
+      version: '0.1.0',
+      timestamp: Date.now(),
+    };
+  }
+}

package/template/pages/users/[id].ts

@@ -0,0 +1,35 @@
+/** 动态路由示例 — GET /users/:id */
+import { Router } from 'forkly';
+
+// 模拟数据库
+const users: Record<string, { name: string; email: string }> = {
+  '1': { name: 'Alice', email: 'alice@example.com' },
+  '2': { name: 'Bob', email: 'bob@example.com' },
+};
+
+export class UserRouter extends Router {
+  static channel = 'async' as const;
+
+  async get() {
+    const id = this.request.params.id;
+    const user = users[id];
+    if (!user) { this.resError('USER_NOT_FOUND'); return; }
+    return { id, ...user };
+  }
+
+  async put() {
+    const id = this.request.params.id;
+    const body = this.request.body as { name?: string; email?: string };
+    if (!users[id]) { this.resError('USER_NOT_FOUND'); return; }
+    if (body.name) users[id].name = body.name;
+    if (body.email) users[id].email = body.email;
+    return { id, ...users[id], updated: true };
+  }
+
+  async delete() {
+    const id = this.request.params.id;
+    if (!users[id]) { this.resError('USER_NOT_FOUND'); return; }
+    delete users[id];
+    return { deleted: true, id };
+  }
+}

package/template/public/index.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="zh">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Forkly App</title>
+  <style>
+    body { font-family: system-ui, sans-serif; max-width: 640px; margin: 80px auto; padding: 0 20px; color: #333; }
+    h1 { font-size: 2rem; margin-bottom: 0.5rem; }
+    code { background: #f4f4f4; padding: 2px 6px; border-radius: 4px; font-size: 0.9em; }
+    .card { border: 1px solid #e0e0e0; border-radius: 8px; padding: 20px; margin: 16px 0; }
+  </style>
+</head>
+<body>
+  <h1>Forkly</h1>
+  <p>A multi-process Node.js backend framework — minimal, fast, production-ready.</p>
+  <div class="card">
+    <p>Visit <code>/hello?name=forkly</code> to try the API</p>
+    <p>Visit <code>/users/1</code> to try dynamic routing</p>
+  </div>
+</body>
+</html>

package/template/tasks/cleanup.ts

@@ -0,0 +1,26 @@
+/** 定时清理任务 — 每天凌晨 3 点执行，清理过期日志 */
+import { Task } from 'forkly';
+import { readdir, unlink, stat } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+const LOG_DIR = resolve(process.cwd(), 'logs');
+const MAX_AGE_MS = 7 * 24 * 60 * 60 * 1000; // 7 天
+
+export const cleanupTask = new Task('0 3 * * *', async () => {
+  try {
+    const files = await readdir(LOG_DIR);
+    const now = Date.now();
+    let deleted = 0;
+    for (const file of files) {
+      const filePath = resolve(LOG_DIR, file);
+      const info = await stat(filePath);
+      if (now - info.mtimeMs > MAX_AGE_MS) {
+        await unlink(filePath);
+        deleted++;
+      }
+    }
+    console.log(`Cleanup: deleted ${deleted} old log files`);
+  } catch {
+    // 日志目录可能不存在
+  }
+});

package/template/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": ".",
+    "strict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}