jj.js 1.0.0-rc.2 → 1.0.0-rc.3

package/README.md

@@ -37,9 +37,23 @@ jj.js 是一个模仿 ThinkPHP5 设计的轻量级 Node.js MVC 框架。基于 P
 npm i jj.js
 ```
 
-> **运行环境要求**：Node.js >= 18
+> **运行环境要求**：Node.js >= 20.19.0
 
-### Hello World
+### 方式一：CLI 初始化（推荐）
+
+```bash
+# 创建项目（交互式选择模板）
+npx jj.js init myapp
+
+# 进入项目并启动
+cd myapp
+npm install
+npm start
+```
+
+### 方式二：手动创建
+
+#### Hello World
 
 **1. 创建控制器** `./app/controller/index.js`
 

package/bin/jj.js

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+
+const templates = {
+    hello: 'Hello World 示例项目',
+    todo: 'Todo List 完整示例项目'
+};
+
+function showHelp() {
+    console.log(`
+jj.js - 轻量级 Node.js MVC 框架
+
+用法:
+  npx jj.js init <project-name>
+
+示例:
+  npx jj.js init myapp
+`);
+}
+
+function selectTemplate() {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+
+        console.log('\n请选择项目模板:');
+        const templateList = Object.entries(templates);
+        templateList.forEach(([name, desc], index) => {
+            console.log(`  ${index + 1}. ${name.padEnd(10)} - ${desc}`);
+        });
+
+        rl.question('\n请输入序号 (1): ', (answer) => {
+            rl.close();
+            const index = parseInt(answer) - 1;
+            if (index >= 0 && index < templateList.length) {
+                resolve(templateList[index][0]);
+            } else {
+                resolve('hello'); // 默认选择第一个
+            }
+        });
+    });
+}
+
+function copyDir(src, dest) {
+    if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+    }
+    
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    
+    for (const entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+        
+        if (entry.isDirectory()) {
+            copyDir(srcPath, destPath);
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+
+function initProject(template, projectName) {
+    if (!templates[template]) {
+        console.error(`错误: 未知的模板 "${template}"`);
+        console.log('\n可用模板:');
+        for (const [name, desc] of Object.entries(templates)) {
+            console.log(`  ${name.padEnd(10)} ${desc}`);
+        }
+        process.exit(1);
+    }
+    
+    const projectPath = path.resolve(process.cwd(), projectName || template + '-app');
+    
+    if (fs.existsSync(projectPath)) {
+        console.error(`错误: 目录 "${projectName}" 已存在`);
+        process.exit(1);
+    }
+    
+    console.log(`正在创建 ${templates[template]}...`);
+    
+    // 复制模板文件
+    const templatePath = path.join(__dirname, '..', 'templates', template);
+    copyDir(templatePath, projectPath);
+    
+    // 更新 package.json 中的项目名称
+    const pkgPath = path.join(projectPath, 'package.json');
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+        pkg.name = projectName || template + '-app';
+        fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+    }
+    
+    console.log(`\n✓ 项目创建成功: ${projectPath}`);
+    console.log('\n下一步:');
+    console.log(`  cd ${projectName || template + '-app'}`);
+    console.log('  npm install');
+    console.log('  npm start');
+}
+
+// 解析命令行参数
+const args = process.argv.slice(2);
+const command = args[0];
+
+if (!command || command === 'help' || command === '--help' || command === '-h') {
+    showHelp();
+    process.exit(0);
+}
+
+if (command === 'init') {
+    const projectName = args[1];
+    
+    if (!projectName) {
+        console.error('错误: 请指定项目名称');
+        showHelp();
+        process.exit(1);
+    }
+    
+    // 交互式选择模板
+    selectTemplate().then(template => {
+        initProject(template, projectName);
+    });
+} else {
+    console.error(`错误: 未知的命令 "${command}"`);
+    showHelp();
+    process.exit(1);
+}

package/lib/controller.js

@@ -14,12 +14,12 @@ class Controller extends Middleware
     /**
      * 初始化方法，在控制器方法执行前自动执行
      * @protected
-     * @returns {any} - 返回Bool值false，则不会执行控制器及后续方法
+     * @returns {('__EXIT__'|any)} - 如果返回__EXIT__，则不会执行控制器及后续方法
      */
     _init() {}
 
     /**
-     * 结束方法，在控制器方法执行后自动执行。如果控制器方法返回Bool值false，则不会执行此方法
+     * 结束方法，在控制器方法执行后自动执行。如果控制器方法返回__EXIT__，则不会执行此方法
      * @protected
      */
     _end() {}

package/lib/mvc.js

@@ -106,8 +106,8 @@ async function mvc(ctx, next) {
     await compose(middlewares)(ctx, async () => {
         let result;
         typeof $controller['_init'] == 'function' && (result = await $controller['_init']());
-        result !== false && (result = await $controller[action]());
-        result !== false && typeof $controller['_end'] == 'function' && await $controller['_end']();
+        result !== '__EXIT__' && (result = await $controller[action]());
+        result !== '__EXIT__' && typeof $controller['_end'] == 'function' && await $controller['_end']();
     });
 }
 

package/lib/request.js

@@ -194,7 +194,7 @@ class Request extends Context
      * @returns {*}
      */
     header(key, default_value='') {
-        return this.ctx.headers[key] || default_value;
+        return this._getValue(this.ctx.headers[key], default_value);
     }
 
     /**
@@ -212,7 +212,7 @@ class Request extends Context
      * @returns {*}
      */
     _getValue(value, default_value) {
-        return value === undefined ? default_value : typeof value === 'number' ? Number(value) : value;
+        return value === undefined ? default_value : typeof default_value === 'number' ? Number(value) : value;
     }
 }
 

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "jj.js",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "A super simple lightweight NodeJS MVC framework（一个超级简单轻量的NodeJS MVC框架）",
   "main": "jj.js",
+  "bin": {
+    "init": "./bin/jj.js"
+  },
   "scripts": {
     "demo": "node ./tests/_demo/server.js",
     "test": "node --test"

package/templates/hello/app/controller/index.js

@@ -0,0 +1,9 @@
+const { Controller } = require('jj.js');
+
+class IndexController extends Controller {
+    index() {
+        this.$show('Hello World!');
+    }
+}
+
+module.exports = IndexController;

package/templates/hello/config/app.js

@@ -0,0 +1,8 @@
+/**
+ * @module config
+ * @type {import('jj.js').AppConfig}
+ */
+module.exports = {
+    app_debug: true,
+    static_dir: 'static'
+};

package/templates/hello/jsconfig.json

@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "checkJs": true
+    },
+    "exclude": ["node_modules"]
+}

package/templates/hello/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "hello-app",
+  "version": "1.0.0",
+  "description": "A jj.js Hello World application",
+  "main": "server.js",
+  "scripts": {
+    "start": "node server.js"
+  },
+  "dependencies": {
+    "jj.js": "*"
+  }
+}

package/templates/hello/server.js

@@ -0,0 +1,8 @@
+const { App, Logger } = require('jj.js');
+
+const port = 3000;
+const app = new App();
+
+app.listen(port, () => {
+    Logger.system(`Hello World 应用已启动: http://localhost:${port}`);
+});

package/templates/todo/app/controller/index.js

@@ -0,0 +1,9 @@
+const { Controller } = require('jj.js');
+
+class IndexController extends Controller {
+    index() {
+        this.$redirect('/todo');
+    }
+}
+
+module.exports = IndexController;

package/templates/todo/app/controller/todo.js

@@ -0,0 +1,45 @@
+const { Controller } = require('jj.js');
+
+class TodoController extends Controller {
+    async index() {
+        const db = this.$db;
+        // 确保表存在
+        await db.execute(`
+            CREATE TABLE IF NOT EXISTS todo_todo (
+                id INTEGER PRIMARY KEY AUTOINCREMENT,
+                title TEXT NOT NULL DEFAULT '',
+                completed INTEGER NOT NULL DEFAULT 0,
+                add_time INTEGER NOT NULL DEFAULT 0
+            )
+        `);
+        const todos = await db.table('todo').order('id', 'desc').select();
+        this.$assign('todos', todos);
+        await this.$fetch('todo/index');
+    }
+
+    async add() {
+        const title = this.$request.post('title');
+        if (title) {
+            const db = this.$db;
+            await db.table('todo').insert({ title, completed: 0, add_time: Date.now() });
+        }
+        this.$redirect('/todo');
+    }
+
+    async toggle() {
+        const id = this.$request.query('id');
+        const completed = this.$request.query('completed', 0);
+        const db = this.$db;
+        await db.table('todo').where({ id }).update({ completed: completed ? 0 : 1 });
+        this.$redirect('/todo');
+    }
+
+    async delete() {
+        const id = this.$request.query('id');
+        const db = this.$db;
+        await db.table('todo').where({ id }).delete();
+        this.$redirect('/todo');
+    }
+}
+
+module.exports = TodoController;

package/templates/todo/app/view/todo/index.htm

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Todo List - jj.js</title>
+    <style>
+        * { margin: 0; padding: 0; box-sizing: border-box; }
+        body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; background: #f5f5f5; padding: 20px; }
+        .container { max-width: 600px; margin: 0 auto; }
+        h1 { text-align: center; color: #333; margin-bottom: 30px; }
+        .add-form { display: flex; gap: 10px; margin-bottom: 20px; }
+        .add-form input { flex: 1; padding: 12px; border: 1px solid #ddd; border-radius: 6px; font-size: 16px; }
+        .add-form button { padding: 12px 24px; background: #4CAF50; color: white; border: none; border-radius: 6px; cursor: pointer; font-size: 16px; }
+        .add-form button:hover { background: #45a049; }
+        .todo-list { list-style: none; }
+        .todo-item { display: flex; align-items: center; gap: 12px; padding: 15px; background: white; border-radius: 8px; margin-bottom: 10px; box-shadow: 0 2px 4px rgba(0,0,0,0.1); }
+        .todo-item.completed .todo-text { text-decoration: line-through; color: #999; }
+        .todo-text { flex: 1; font-size: 16px; }
+        .todo-actions { display: flex; gap: 8px; }
+        .btn { padding: 6px 12px; border: none; border-radius: 4px; cursor: pointer; font-size: 14px; }
+        .btn-toggle { background: #2196F3; color: white; }
+        .btn-delete { background: #f44336; color: white; }
+        .empty { text-align: center; color: #999; padding: 40px; }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <h1>📝 Todo List</h1>
+        
+        <form class="add-form" action="/todo/add" method="POST">
+            <input type="text" name="title" placeholder="添加新任务..." required>
+            <button type="submit">添加</button>
+        </form>
+
+        {{if todos.length === 0}}
+        <div class="empty">暂无任务，添加一个吧！</div>
+        {{else}}
+        <ul class="todo-list">
+            {{each todos todo}}
+            <li class="todo-item {{if todo.completed}}completed{{/if}}">
+                <span class="todo-text">{{todo.title}}</span>
+                <div class="todo-actions">
+                    <a href="/todo/toggle?id={{todo.id}}&completed={{todo.completed}}" class="btn btn-toggle">
+                        {{if todo.completed}}撤销{{else}}完成{{/if}}
+                    </a>
+                    <a href="/todo/delete?id={{todo.id}}" class="btn btn-delete" onclick="return confirm('确定删除吗？')">删除</a>
+                </div>
+            </li>
+            {{/each}}
+        </ul>
+        {{/if}}
+    </div>
+</body>
+</html>

package/templates/todo/config/app.js

@@ -0,0 +1,9 @@
+/**
+ * @module config
+ * @type {import('jj.js').AppConfig}
+ */
+module.exports = {
+    app_debug: true,
+    static_dir: 'static',
+    koa_body: {}
+};

package/templates/todo/config/db.js

@@ -0,0 +1,17 @@
+const path = require('path');
+const fs = require('fs');
+
+const dataDir = path.join(__dirname, '../data');
+if(!fs.existsSync(dataDir)) fs.mkdirSync(dataDir, { recursive: true });
+
+/**
+ * @module config
+ * @type {import('jj.js').DbConfig}
+ */
+module.exports = {
+    default: {
+        type: 'sqlite',
+        database: path.join(dataDir, 'todo.db'),
+        prefix: 'todo_'
+    }
+};

package/templates/todo/jsconfig.json

@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "checkJs": true
+    },
+    "exclude": ["node_modules"]
+}

package/templates/todo/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "todo-app",
+  "version": "1.0.0",
+  "description": "A jj.js Todo List application",
+  "main": "server.js",
+  "scripts": {
+    "start": "node server.js"
+  },
+  "dependencies": {
+    "jj.js": "*"
+  }
+}

package/templates/todo/server.js

@@ -0,0 +1,8 @@
+const { App, Logger } = require('jj.js');
+
+const port = 3000;
+const app = new App();
+
+app.listen(port, () => {
+    Logger.system(`Todo 应用已启动: http://localhost:${port}`);
+});