chanjs 1.0.29 → 1.0.31

package/README.md

@@ -1,96 +1,99 @@
-# <center>Chan.js mvc框架</center>
 
-Chan.js 基于express 纯js研发的轻量级mvc框架。基于函数式编程思想，性能优越，代码清晰，流程易读，可持续维护高。
+# Chan.js
 
-## 特性
+Chan.js is a lightweight MVC framework developed in pure JavaScript based on Express. It embodies functional programming concepts, offering superior performance, clear code, and easy-to-follow processes that ensure high maintainability.
 
-- 基于express
-- 支持es6语法
-- 模块化
-  - 支持多模块路由
-  - 支持多模块视图
-  - 支持多模块控制器
-  - 支持多模块服务
-- 插件化
-- 轻量级（核心代码300行内）
-- 长期维护
+## features
 
-## 规范 遵循约定优于配置
+- Built on top of Express
+- Supports ES6 syntax
+- Modular Design
+  - Supports multiple module routes
+  - Supports multiple module views
+  - Supports multiple module controllers
+  - Supports multiple module services
+- Plugin-based architecture
+- Lightweight (core code within 300 lines)
+- Long-term maintenance
+
+## Conventions Over Configuration
 
 ```code
 |- app
-    |- config 配置
-    |- module 模块1
-        |- module1 模块1
-            |- controller 控制器
-            |- service 服务模型
-            |- view 视图模板
-            |- router.js 路由
-        |- module2 模块2
-            |- controller 控制器
-            |- service 服务模型
-            |- view 视图模板
-            |- router.js路由
-    |- extend 扩展
-    |- middleware 中间件
-    |- plugin 插件
-        |- plus-module1 插件1
-            |- controller 控制器
-            |- service 服务模型
-            |- view 视图模板
-            |- router.js 路由
-        |- module2 插件2
-            |- controller 控制器
-            |- service 服务模型
-            |- view 视图模板
-            |- router.js路由
-    |- public 静态文件
+    |- config 
+    |- module 
+        |- module1 
+            |- controller 
+            |- service 
+            |- view 
+            |- router.js 
+        |- module2 
+            |- controller 
+            |- service 
+            |- view 
+            |- router.js
+    |- extend 
+    |- middleware 
+    |- plugin 
+        |- plus-module1 
+            |- controller 
+            |- service 
+            |- view 
+            |- router.js 
+        |- module2 
+            |- controller 
+            |- service 
+            |- view 
+            |- router.js
+    |- public 
 |- index.js
 ```
 
-### 初始化流程
+### Initialization Process
 
-- 初始化
-- 加载配置
-- 加载模块
-  - 加载service
-  - 加载controller
-  - 加载router
-- 加载extend
-- 加载plugin
-  - 加载service
-  - 加载controller
-  - 加载router
-- beforeStart() 挂在从数据库获取的配置合并到配置文件中
-- run() 启动服务
+- Initialization
+- Load configuration
+- Load modules
+  - Load services
+  - Load controllers
+  - Load routers
+- Load extensions
+- Load plugins
+  - Load services
+  - Load controllers
+  - Load routers
+- beforeStart() Hook to merge configurations from the database into the configuration
+- run() Start the server
 
-### 官网
+### Official Website
 
-基于Chanjs开发的cms系统
-网址：<https://www.chancms.top>
+A CMS system developed with Chan.js
+Website：<https://www.chancms.top>
   
-### 特点
+### Highlights
 
-- 配置文件
-- 多模块mvc
-- 插件mvc
-- 支持cors跨域配置
-- mysql数据库支持
-- 路由控制
-- art-template模板
-- 静态资源
-- cookie
-- 日志功能
+- Configuration files
+- Multi-module MVC structure
+- Plugin MVC support
+- CORS cross-origin configuration support
+- MySQL database support
+- Route control
+- Art-template template engine
+- Static resources management
+- Cookie handling
+- Logging capabilities
 
-### 运行
+### run
 
 ```javascript
 const Chanjs = require("chanjs");
 const chan = new Chanjs();
-//加载中间件
+// Load middleware
 chan.beforeStart(fn);
-//扫描模块
+// Scan modules
 chan.start();
-//启动服务
+// Start the server
 chan.run();
 ```
+
+This framework is designed for developers who seek a balance between simplicity and functionality, providing a robust foundation for building web applications with ease.

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "chanjs",
-  "version": "1.0.29",
-  "description": "chanjs基于express 纯js研发的轻量级mvc框架。",
+  "version": "1.0.31",
+  "description": "Chanjs is a lightweight MVC framework developed based on express MySQL and pure JavaScript.",
   "main": "core/chan.js",
   "module": "core/chan.js",
   "keywords": [
     "\"chanjs\"",
     "\"express mvc\"",
+    "\"express mysql\"",
+    "\"express knex\"",
     "\"chancms\"",
     "\"nodejs\""
   ],
@@ -24,7 +26,8 @@
     "mysql2": "^3.11.0",
     "dayjs": "^1.11.12"
   },
-  "__npminstall_done": true,
-  "_from": "chanjs@1.0.22",
-  "_resolved": "https://registry.npmmirror.com/chanjs/-/chanjs-1.0.22.tgz"
+  "homepage": "https://www.npmjs.com/package/chanjs",
+  "files": [
+    "README.md"
+  ]
 }

package/core/lib/config/config.js

@@ -1,45 +0,0 @@
-const path = require('path');
-
-/**
- * @description 根目录
- */
-const ROOT_PATH = process.cwd();
-// 读取package.json文件
-const {version='1.0.0',author='明空'} = require(path.join(ROOT_PATH, 'package.json'));
-
-/**
- * @description 程序目录
- */
-const APP_PATH = path.join(ROOT_PATH, 'app');
-
-let config = {
-  JSON_LIMIT:"100kb",
-  logger : {
-    level: 'dev',
-  },
-  version,
-  author,
-  env:'dev',
-  template:'default',
-  views:[], //模板路径
-  static:[{  //静态文件路径
-    prefix: "/public/",
-    dir: ["app/public"],
-    maxAge: 0,
-  }],
-  database:{
-    client: "mysql2",
-    host: "localhost",
-    port: "3306",
-    user: "root",
-    password: "123456",
-    database: "chancms",
-    charset: "utf8mb4",
-  }
-}
-
-module.exports = {
-  ROOT_PATH,
-  APP_PATH, 
-  ...config
-}

package/core/lib/controller/controller.js

@@ -1,25 +0,0 @@
-/**
- * @description
- * 控制器基类
- */
-class Controller {
-  constructor() {}
-
-  download(res, file) {
-    res.download(file);
-  }
-
-  success(res, data = null) {
-    res.json({ code: 200, msg: "success", data: data });
-  }
-
-  fail(res, msg = "操作失败，请稍后再试") {
-    res.json({ code: 400, msg: msg });
-  }
-
-  error(res, msg) {
-    res.json({ code: 500, msg: msg });
-  }
-}
-
-module.exports = Controller;

package/core/lib/extend/helper.js

@@ -1,78 +0,0 @@
-const knex = require('knex');
-
-/**
- * @description 实例化一个类，并将该类的所有方法绑定到一个新的对象上。
- * @param {Function} className - 需要实例化的类。
- *@returns {Object} 包含绑定方法的对象。
- */
-function bindClass(className) {
-  let obj = {};
-  const cls = new className();
-  Object.getOwnPropertyNames(cls.constructor.prototype).forEach(
-    (methodName) => {
-      if (
-        methodName !== "constructor" &&
-        typeof cls[methodName] === "function"
-      ) {
-        obj[methodName] = cls[methodName].bind(cls);
-      }
-    }
-  );
-  return obj;
-}
-
-
- function createKnex(opt) {
-    let config = {
-        host:"localhost",
-        port:"3306",
-        client:"mysql2",
-        charset:"utf8mb4",
-        debug:false,
-        ...opt
-    };
-    return knex({
-      client: config.client,
-      connection: {
-        host:config.host,
-        port:config.port,
-        user:config.user,
-        password:config.password,
-        database:config.database,
-        charset:config.charset,
-      },
-      debug: config.debug,
-      //默认为{min: 2, max: 10}
-      pool: { 
-        min: 0,
-        max: 2,
-      },
-      log: {
-        warn(message) {
-          console.error("[knex warn]", message);
-        },
-        error(message) {
-          console.error("[knex error]", message);
-        },
-      },
-    });
-}
-/**
- * 
- * @param {*} module 模块目录
- * @returns Array 
- * @description 将web模块放到最后加载
- */
-function loadWebToEnd(module=[]){
-  const index = module.indexOf('web');
-  if (index !== -1) {
-      const web = module.splice(index, 1);
-      module.push(web[0]);
-  }
-  return module;
-}
-module.exports = {
-    bindClass,
-    createKnex,
-    loadWebToEnd
-};

package/core/lib/index.js

@@ -1,41 +0,0 @@
-const express = require("express");
-const cookieParser = require("cookie-parser");
-const favicon = require("serve-favicon");
-const morgan = require("morgan");
-const path = require("path");
-const template = require("./middleware/template.js");
-module.exports = async function (app, config) {
-  const { logger, APP_PATH, cookieKey, static, JSON_LIMIT, appName, version } =
-    config;
-  //日志
-  app.use(morgan(logger.level));
-
-  // favicon 图标
-  app.use(favicon(path.join(APP_PATH, "public/favicon.ico")));
-
-  //cookie
-  app.use(cookieParser(cookieKey));
-
-  //解析接口 json & url
-  app.use(express.json({ limit: JSON_LIMIT }));
-  app.use(express.urlencoded({ extended: false }));
-
-  //配置模板引擎
-  template(app, config);
-
-  //使用静态资源 ,
-  if (static.length > 0) {
-    static.forEach((item) => {
-      const { prefix, dir, maxAge } = item;
-      app.use(prefix, express.static(dir, { maxAge: maxAge || 0 }));
-    });
-  }
-
-  //设置头信息
-  app.use((req, res, next) => {
-    res.setHeader("Create-By", "Chanjs");
-    res.setHeader("X-Powered-By", appName);
-    res.setHeader(appName, version);
-    next();
-  });
-};

package/core/lib/middleware/template.js

@@ -1,38 +0,0 @@
-const path = require("path");
-const template = require("art-template");
-const dayjs = require("dayjs");
-
-// 注册 dateFormat 函数
-template.defaults.imports.dateFormat = function (date, format) {
-  if (!date) {
-    return "";
-  }
-  // 如果传入的是一个 Date 对象，转换为 dayjs 对象
-  if (
-    date instanceof Date ||
-    typeof date === "string" ||
-    typeof date === "number"
-  ) {
-    date = dayjs(date);
-  } else {
-    return "";
-  }
-  return date.format(format);
-};
-
-module.exports = (app, config) => {
-  const { APP_PATH, views, env } = config;
-  //默认home view
-  const home = path.join(APP_PATH, `modules/web/view`);
-  //合并插件中的view
-  const all = [...views, home];
-
-  app.set("view options", {
-    debug: env === "dev",
-    cache: env === "prd",
-    minimize: true,
-  });
-  app.set("view engine", "html");
-  app.set("views", all);
-  app.engine(".html", require("express-art-template"));
-};

package/core/lib/service/service.js

@@ -1,190 +0,0 @@
-class BaseService {
-  /**
-   * @description 构造函数
-   * @param {*} knex - knex实例
-   * @param {*} model - 模型名称
-   */
-  constructor(knex, model = "") {
-    this.knex = knex;
-    this.model = model;
-  }
-
-  /**
-   * @description 查找所有符合条件的记录
-   * @param {*} query - 查询条件，例如：{name: 'test', age: 18}
-   * @returns {Promise} 返回符合条件的记录
-   */
-  query(query) {
-    return this.knex(this.model).where(query);
-  }
-
-  /**
-   * @description 查询表所有记录，慎用
-   * @returns {Promise} 返回所有记录
-   */
-  all() {
-    return this.knex(this.model).select();
-  }
-
-  /**
-   * @description 查询指定id的记录
-   * @param {*} id
-   * @returns {Promise} 返回指定id的记录
-   */
-  findById(id) {
-    return this.knex(this.model).where("id", id).first();
-  }
-
-  /**
-   * @description 查询分页数据
-   * @param {*} current
-   * @param {*} pageSize
-   * @param {*} query
-   * @returns {Promise} 返回分页数据
-   */
-  async findListAndQuery(current = 1, pageSize = 10, query = {}) {
-    const offset = (current - 1) * pageSize;
-
-    let countQuery = this.knex(this.model).count("* as total");
-    let dataQuery = this.knex(this.model);
-
-    // 应用查询条件
-    for (const key in query) {
-      dataQuery = dataQuery.where(key, query[key]);
-      countQuery = countQuery.where(key, query[key]);
-    }
-
-    // 获取总记录数
-    const total = await countQuery.first();
-
-    // 获取分页数据
-    const data = await dataQuery.offset(offset).limit(pageSize);
-
-    return { data, total: parseInt(total.total, 10) };
-  }
-
-  /**
-   * @description 查询指定id的记录
-   * @param {*} id - 记录id
-   * @returns {Promise} 返回指定id的记录
-   */
-  findOneById(id) {
-    return this.knex(this.model).where("id", id).select();
-  }
-
-  /**
-   * @description 查询指定条件的记录
-   * @param {Object} query - {<key>:<value>}
-   * @returns {Promise} 返回指定条件的记录
-   */
-  findOne(query) {
-    return this.knex(this.model).where(query).first();
-  }
-
-  /**
-   * @description 更新指定id的记录
-   * @param {*} id - 记录id
-   * @param {*} params - {<key>:<value>}
-   * @returns {Promise} 返回更新后的记录
-   */
-  findOneAndUpdate(id, params) {
-    return this.knex(this.model).where("id", id).update(params).returning("*");
-  }
-
-  /**
-   * @description 查询指定条件的记录数量
-   * @param {*} query - {<key>:<value>}
-   * @returns {Promise} 返回指定条件的记录数量
-   */
-  count(query) {
-    return this.knex(this.model).where(query).count("* as total").first();
-  }
-
-  /**
-   * @description 插入一条记录
-   * @param {*} params - {<key>:<value>}
-   * @returns {Promise} 返回插入后的记录
-   */
-  insert(params) {
-    return this.knex(this.model).insert(params);
-  }
-
-  /**
-   * @description 插入多条记录
-   * @param {*} records - [{<key>:<value>}, {<key>:<value>}, ...]
-   * @returns {Promise} 返回插入后的记录
-   */
-  insertMany(records) {
-    return this.knex(this.model).insert(records);
-  }
-
-  /**
-   * @description 更新指定id的记录
-   * @param {*} id - 记录id
-   * @param {*} params - {<key>:<value>}
-   * @returns {Promise} 返回更新后的记录
-   */
-  updateById(id, params) {
-    return this.knex(this.model).where("id", id).update(params);
-  }
-
-  /**
-   * @description 更新数据
-   * @param {*} query - {<key>:<value>}
-   * @param {*} update - {<key>:<value>}
-   * @returns {Promise<*>} - 返回更新后的数据
-   */
-  update(query, update) {
-    return this.knex(this.model).where(query).update(update);
-  }
-
-  /**
-   * @description 查询并更新
-   * @param {*} query - {<key>:<value>}
-   * @param {*} update - {<key>:<value>}
-   * @returns {Promise<*>} - 返回更新后的记录
-   */
-  findAndModify(query, update) {
-    return this.knex(this.model).where(query).update(update);
-  }
-
-  /**
-   *
-   * @param {*} id - id
-   * @param {*} update - {<key>:<value>}
-   * @returns {Promise<*>} - 返回更新后的记录
-   */
-  findByIdAndUpdate(id, update) {
-    return this.knex(this.model).where("id", id).update(update);
-  }
-
-  /**
-   * @description 根据条件更新记录
-   * @param {*} query - {<key>:<value>}
-   * @param {*} update - {<key>:<value>}
-   * @returns {Promise} - 返回更新后的记录
-   */
-  findOneAndUpdate(query, update) {
-    return this.knex(this.model).where(query).update(update);
-  }
-
-  /**
-   * @description 根据id删除一条记录
-   * @param {*} id - 记录id
-   * @returns {Promise} - 返回删除的记录
-   */
-  findByIdAndRemove(id) {
-    return this.knex(this.model).where("id", id).del();
-  }
-
-  /**
-   * @description 根据条件删除一条记录
-   * @param {*} query
-   * @returns {Promise} - 返回删除的记录
-   */
-  findOneAndRemove(query) {
-    return this.knex(this.model).where(query).del();
-  }
-}
-
-module.exports = BaseService;

package/publish.bat

@@ -1,4 +0,0 @@
-npm config set proxy null
-npm cache clean --force
-npm config set registry http://registry.npmmirror.com
-npm publish