jj.js 0.9.0 → 0.11.0

package/lib/types.js

@@ -1,286 +1,236 @@
-//------------------系统核心库------------------
-/**
- * @typedef {Object} Core
- * @property {typeof import('./app')} App
- * @property {typeof import('./cache')} Cache
- * @property {typeof import('./context')} Context
- * @property {typeof import('./controller')} Controller
- * @property {typeof import('./cookie')} Cookie
- * @property {typeof import('./db')} Db
- * @property {typeof import('./logger')} Logger
- * @property {typeof import('./middleware')} Middleware
- * @property {typeof import('./model')} Model
- * @property {typeof import('./pagination')} Pagination
- * @property {typeof import('./response')} Response
- * @property {typeof import('./upload')} Upload
- * @property {typeof import('./url')} Url
- * @property {typeof import('./view')} View
- * @property {Utils} utils
- */
-
-
-//------------------系统App配置---------------------
-/**
- * @typedef {Object} AppConfig - 系统配置
- * @property {boolean} [app_debug=true] - 调试模式
- * @property {boolean} [app_multi=false] - 是否开启多应用
- * @property {string} [default_app=app] - 默认应用
- * @property {string} [default_controller=index] - 默认控制器
- * @property {string} [default_action=index] - 默认方法
- * @property {string} [common_app=common] - 公共应用，存放公共模型及逻辑
- * @property {string} [controller_folder=controller] - 控制器目录名
- * @property {(string|boolean)} [static_dir=''] - 静态文件目录，相对于应用根目录，为空或false时，关闭静态访问
- * @property {(string|boolean|null|object)} [koa_body=null] - koa-body配置参数，为''、null、false时，关闭koa-body
- * @property {string} [base_dir] - 应用根目录（会自动计算）
- */
-
-/**
- * @typedef {Object} ViewConfig - 模板配置
- * @property {string} [view_folder=view] - 模板目录名
- * @property {string} [view_depr='/'] - 模版文件名分割符，'/'代表二级目录
- * @property {string} [view_ext='.htm'] - 模版文件后缀
- * @property {string} [view_engine=art-template] - 默认模版引擎，字符串或引擎类
- * @property {object} [view_filte={}] - 模版函数
- */
-
-/**
- * @typedef {Object} DbConfigItem - 数据库参数
- * @property {string} [type=mysql] - 数据库类型
- * @property {string} [host='127.0.0.1'] - 服务器地址
- * @property {string} [database=jj] - 数据库名
- * @property {string} [user=root] - 数据库用户名
- * @property {string} [password=''] - 数据库密码
- * @property {string} [port=''] - 数据库连接端口
- * @property {string} [charset=utf8] - 数据库编码默认采用utf8
- * @property {string} [prefix=jj_] - 数据库表前缀
- */
-
-/**
- * @typedef {object} DbConfig - 数据库配置
- * @property {DbConfigItem} default - 数据库参数
- */
-
-/**
- * @callback LogHandle - 日志驱动
- * @param {string} level - 日志级别
- * @param {array} args - 日志数据，支持多个，支持对象
- */
-
-/**
- * @typedef {object} LogConfig - 日志配置
- * @property {array} [log_level] - 允许输出的日志级别
- * @property {LogHandle} [log_handle] - 日志驱动
- */
-
-/**
- * @typedef {Object} CacheConfig - 缓存配置
- * @property {number} [cache_time='60 * 60 * 24'] - 缓存时间，默认1天，为空或false则为10年
- * @property {number} [clear_time=undefined] - 缓存自动清理周期，undefined: 清理一次, 0: 关闭自动清理, >0: 为周期时间，单位秒
- */
-
-/**
- * @typedef {Object} PageConfig - 分页配置
- * @property {string} [page_key=page] - 分页标识
- * @property {string} [key_origin=query] - page_key来源
- * @property {number} [page_size=10] - page_key来源
- * @property {number} [page_length=5] - page_key来源
- * @property {string} [url_page] - page_key来源
- * @property {string} [url_index] - page_key来源
- * @property {string} [index_tpl] - 首页模板
- * @property {string} [end_tpl] - 末页模板
- * @property {string} [prev_tpl] - 上一页模板
- * @property {string} [next_tpl] - 下一页模板
- * @property {string} [list_tpl] - 数字页模板
- * @property {string} [active_tpl] - 当前页模板
- * @property {string} [info_tpl] - 分页信息模板
- * @property {string} [template] - 渲染模板
- */
-
-/**
- * @typedef {Object} RouteConfigItem - 路由配置
- * @property {string} [method=all] - 请求方法，支持['all', 'get', 'put', 'post', 'patch', 'delete', 'del']
- * @property {string} url - 请求url，支持变量正则，详细参考@koa/router
- * @property {(string|Middleware)} path - 响应地址(支持智能解析)或中间件函数，如果为中间件函数，则不会再执行后续代码
- * @property {string} [type='AppConfig.controller_folder'] - 响应类型，即path对应的类型，支持controller、middleware、view(ViewConfig.view_folder)
- * @property {string} [name] - 路由命名，命一个名字后，可以使用Url类反向编译路由url
- */
-
-/**
- * @typedef {RouteConfigItem[]} RouteConfig - 路由配置
- */
-
-/**
- * @typedef {import('cookies').SetOption} CookieConfig - Cookie配置，一般不用设置
- */
-
-/**
- * @typedef {Object} TplConfig - 跳转、调试模板配置
- * @property {string} [jump] - 跳转模板，默认require('./tpl/jump')
- * @property {string} [exception] - 调试异常输出模板，默认require('./tpl/exception')
- */
-
-/**
- * @typedef {Object} Config - 系统配置
- * @property {AppConfig} [app]
- * @property {ViewConfig} [view]
- * @property {DbConfig} [db]
- * @property {LogConfig} [log]
- * @property {CacheConfig} [cache]
- * @property {PageConfig} [page]
- * @property {RouteConfig} [routes]
- * @property {CookieConfig} [cookie]
- * @property {TplConfig} [tpl]
- */
-
-
-//------------------分页类--------------------
-/**
- * @typedef {typeof import('./pagination')} Pagination - 分页类
- * @typedef {typeof import('./pagination').prototype} PaginationInstance - 分页类实例
- */
-
-
-//------------------数据库类--------------------
-/**
- * @typedef {import('mysql').Pool} Pool - 连接池
- * @typedef {import('mysql').PoolConfig} PoolConfig - 连接池配置
- * @typedef {import('mysql').PoolConnection} PoolConnection - 连接池连接
- * @typedef {import('mysql').QueryOptions} QueryOptions - 查询参数
- * @typedef {import('mysql').OkPacket} OkPacket - 数据库查询结果
- * @typedef {Object} RowData - 单条数据
- * @typedef {Array<RowData>} ListData - 多条数据
- * @typedef {Object} FieldInfo - 字段信息
- * @property {string} Field
- * @property {string} Type
- * @property {string} Null
- * @property {string} Key
- * @property {string} Default
- * @property {string} Extra
- * @typedef {Map<Pool>} PoolMap
- */
-
-
-//------------------上传类--------------------
-/**
- * @typedef {Object} UploadData
- * @property {string} [filename]
- * @property {string} [extname]
- * @property {string} [savename]
- * @property {string} [filepath]
- * @property {string} [name]
- * @property {number} [size]
- * @property {string} [mimetype]
- * @property {string} [hash]
- * /
- * 
-/**
- * @typedef {Object} ValidateRule
- * @property {number} [size] - 文件大小
- * @property {string} [ext] - 文件名后缀，多个用','隔开
- * @property {string} [type] - 文件mimetype，多个用','隔开
- */
-
-
-//------------------系统工具--------------------
-/**
- * @typedef {Object} Utils
- * @property {typeof import('./utils/date')} date
- * @property {typeof import('./utils/error')} error
- * @property {typeof import('./utils/fs')} fs
- * @property {typeof import('./utils/md5')} md5
- * @property {typeof import('./utils/str')} str
- */
-
+const path = require('path');
+const fsPromises = require('fs').promises;
+const {app: cfg_app} = require('./config');
+const toHump = require('./utils/str').toHump;
+const Logger = require('./logger');
+
+/**
+ * watch
+ */
+function start() {
+    const watch = require('watch');
+    const filter = function(f, stat) {
+        const static_dir = cfg_app.static_dir ? path.join(cfg_app.base_dir, cfg_app.static_dir) : '';
+        return (!~f.indexOf('.') || /\.js(on)?$/.test(f)) && !~f.indexOf('types.js') && (static_dir && !~f.indexOf(static_dir));
+    };
+
+    let prevFile = {file: null,action: null,stat: null};
+    watch.watchTree(cfg_app.base_dir, {ignoreDotFiles: true, ignoreDirectoryPattern: /node_modules/, filter}, (f, curr, prev) => {
+        if(typeof f == "object" && prev === null && curr === null) {
+            // Finished walking the tree
+            Object.keys(f).forEach(file => {
+                Logger.system("wacth:", file);
+            });
+        } else if(prev === null) {
+            // f is a new file
+            if(prevFile.file != f || prevFile.action != "created") {
+                prevFile = {file: f, action: "created", stat: curr};
+                createFile(f);
+            }
+        } else if(curr.nlink === 0) {
+            // f was removed
+            if(prevFile.file != f || prevFile.action != "removed") {
+                prevFile = { file: f, action: "removed", stat: curr };
+                createFile(f);
+            }
+        } else {
+            // f was changed
+            if(prevFile.file === null) {
+                createFile(f);
+            } else {
+                // stat might return null, so catch errors
+                try {
+                    if (prevFile.stat.mtime.getTime() !== curr.mtime.getTime()) {
+                        createFile(f);
+                    }
+                } catch(e) {
+                    createFile(f);
+                }
+            }
+        }
+    });
+}
 
-//------------------系统Context--------------------
 /**
- * @typedef {import('koa').Context} Context
- * @typedef {import('koa').Middleware} Middleware
+ * createTypesFile
  */
+async function createFile(f) {
+    if(this._f == f) {
+        return;
+    }
+    if(this._f) {
+        delete require.cache[require.resolve(this._f)];
+    }
+    this._f = f;
 
+    const f_info = f.replace(cfg_app.base_dir + path.sep, '').split(path.sep);
+    if(f_info[0] && f_info[0] != cfg_app.common_app && !~f_info[0].indexOf('.')) {
+        this._APP = f_info[0];
+    }
 
-//------------------Ctx系统基类--------------------
-class Ctx {
-    constructor() {
-        /**
-         * @desc 系统缓存类
-         * @type {typeof import('./cache')}
-         */
-        this.$cache;
-
-        /**
-         * @type {typeof import('./context').prototype}
-         */
-        this.$context;
+    const ignore = ['node_modules', 'docker', 'package-lock.json', 'types.js', '.git', '.gitignore'];
+    ignore.push(path.basename(module.parent.parent.parent.filename));
+    cfg_app.static_dir && ignore.push(path.join(cfg_app.base_dir, cfg_app.static_dir));
 
-        /**
-         * @type {typeof import('./controller').prototype}
-         */
-        this.$controller;
+    const node_list = await getNodeList('.', ignore);
+    calcNodeList(node_list, this._APP);
 
-        /**
-         * @type {typeof import('./cookie').prototype}
-         */
-        this.$cookie;
+    const types_tpl = require('./tpl/types');
+    const types_str = types_tpl.replace('__TYPES__', createTypes(node_list)).replace('__PROPERTY__', createProps(node_list));
+    fsPromises.writeFile('types.js', types_str).then(_ => {
+        Logger.system('createTypes success:', path.join(cfg_app.base_dir, 'types.js'));
+    }).catch(err => {
+        Logger.system('createTypes error:', err);
+    });
+}
 
-        /**
-         * @type {typeof import('./db').prototype}
-         */
-        this.$db;
+// 生成类型定义
+function createTypes(node_list, base_type = '') {
+    let types = '';
+    let props = '';
+    Object.entries(node_list).forEach(([path, node]) => {
+        const type_name = toHump(base_type + '_' + node.node_name);
+        if(node.file_type == 'dir') {
+            types += createTypes(node.children, type_name);
+        } else {
+            if(!node.is_class) {
+                types += `/**\n * @typedef {typeof import('${path}')} ${type_name}\n */\n\n`;
+            } else {
+                types += `/**\n * @typedef {typeof import('${path}')} ${type_name}Class\n`;
+                types += ` * @typedef {typeof import('${path}').prototype} ${type_name}Instance\n`;
+                types += ` * @typedef {(${type_name}Class & ${type_name}Instance)} ${type_name}\n */\n\n`;
+            }
+        }
+
+        props += ` * @property {${type_name}} ${node.node_name} - ${path}\n`;
+    });
+
+    if(base_type) {
+        types += `/**\n * @typedef {object} ${base_type}\n${props} */\n\n`;
+    }
 
-        /**
-         * @type {typeof import('./logger')}
-         */
-        this.$logger;
+    return types;
+}
 
-        /**
-         * @type {typeof import('./middleware').prototype}
-         */
-        this.$middleware;
+// 生成智能属性
+function createProps(node_list) {
+    let props = '';
 
-        /**
-         * @type {typeof import('./model').prototype}
-         */
-        this.$model;
+    Object.entries(node_list).forEach(([path, node]) => {
+        const type_name = toHump('_' + node.node_name);
+        if(type_name != 'Config') {
+            props += `\n    /** @type {${type_name}} */\n    $${node.node_name}\n`;
+        }
+    });
 
-        /**
-         * @type {typeof import('./pagination').prototype}
-         */
-        this.$pagination;
+    let type_config = 'JJConfig';
+    if(node_list['./config']) {
+        type_config = '(JJConfig & Config)';
+    }
+    props += `\n    /** @type {${type_config}} */\n    $config\n`;
 
-        /**
-         * @type {typeof import('./response').prototype}
-         */
-        this.$response;
+    return props;
+}
 
-        /**
-         * @type {typeof import('./upload').prototype}
-         */
-        this.$upload;
+// 获取节点对象
+async function getNodeList(dir, ignore=['node_modules', 'docker', 'package-lock.json', '.git', '.gitignore']) {
+    const isClass = require('is-class');
+    const files = await fsPromises.readdir(path.join(cfg_app.base_dir, dir), {withFileTypes: true});
+    const type_list = {};
+    for(const dirent of files) {
+        const file_name = dirent.name;
+        const file_path = dir + '/' + file_name;
+        const node_name = path.parse(file_name).name;
+        const abs_path = path.join(cfg_app.base_dir, file_path);
+        if(ignore.filter(n => abs_path.includes(n)).length) {
+            continue;
+        }
+
+        const file_type = dirent.isFile() ? 'file' : dirent.isDirectory() ? 'dir' : '';
+        const regFile = /.+\.js(on)?$/.test(file_name);
+        const regDir = !file_name.includes('.');
+        if(file_type == 'file' && !regFile) {
+            continue;
+        }
+        if(file_type == 'dir' && !regDir) {
+            continue;
+        }
+
+        if(file_type == 'file') {
+            try {
+                // @ts-ignore
+                type_list[file_path] = {node_name, file_name, file_type, is_class: isClass(require(abs_path))};
+            } catch(e) {
+                // 包含语法错误时，require会出错
+            }
+        } else if(file_type == 'dir') {
+            type_list[file_path] = {node_name, file_name, file_type, children: await getNodeList(file_path, ignore)};;
+        }
+
+    };
+    return type_list;
+}
 
-        /**
-         * @type {typeof import('./url').prototype}
-         */
-        this.$url;
+// 复制子节点
+function copyNodeList(node_list) {
+    const copy_node_list = {};
+    Object.entries(node_list).forEach(([path, node]) => {
+        copy_node_list[path] = {...node};
+        if(node.children) {
+            copy_node_list[path].children = copyNodeList(node.children);
+        }
+    });
+    return copy_node_list;
+}
 
-        /**
-         * @type {typeof import('./view').prototype}
-         */
-        this.$view;
+// 处理common库
+function calcNodeList(node_list, _APP) {
+    // 处理common
+    const node_common = './' + cfg_app.common_app;
+    if(cfg_app.common_app && node_list[node_common] && node_list[node_common].children) {
+        const children = copyNodeList(node_list[node_common].children);
+        Object.entries(children).forEach(([path, node]) => {
+            node_list[path] = node;
+        });
+    }
 
-        /**
-         * @type {Utils}
-         */
-        this.$utils;
+    // 处理app
+    const node_app = './' + _APP;
+    if(_APP && node_list[node_app] && node_list[node_app].children) {
+        Object.entries(node_list[node_app].children).forEach(([path, node]) => {
+            const path_common = path.replace(node_app, node_common);
+            if(!node_list[path_common]) {
+                node_list[path] = node;
+            } else if(node_list[path_common].file_type == 'file') {
+                delete node_list[path_common];
+                node_list[path] = node;
+            } else if(node.children) {
+                Object.entries(node.children).forEach(([p, n]) => {
+                    const p_commmon = p.replace(node_app, node_common);
+                    node_list[path_common].children[p_commmon] && delete node_list[path_common].children[p_commmon];
+                    node_list[path_common].children[p] = n;
+                });
+            }
+        });
+    }
 
-        /**
-         * @type {import('./config')}
-         */
-        this.$config;
+    // 特殊处理view和response
+    const node_view = './' + _APP + '/view';
+    const common_view = './' + cfg_app.common_app + '/view';
+    if(node_list[node_view] && !node_list[node_view].is_class) {
+        delete node_list[node_view];
+    }
+    if(node_list[common_view] && !node_list[common_view].is_class) {
+        delete node_list[common_view];
+    }
+    const node_response = './' + _APP + '/response';
+    const common_response = './' + cfg_app.common_app + '/response';
+    if(node_list[node_response] && !node_list[node_response].is_class) {
+        delete node_list[node_response];
+    }
+    if(node_list[common_response] && !node_list[common_response].is_class) {
+        delete node_list[common_response];
     }
 }
 
-/**
- * @module Types
- */
-module.exports = Ctx;
+module.exports = start;

package/lib/upload.js

@@ -7,8 +7,8 @@ const {app: cfg_app} = require('./config');
 /**
  * @typedef {import('formidable').Files} Files
  * @typedef {import('formidable').File} File
- * @typedef {import('./types').UploadData} UploadData
- * @typedef {import('./types').ValidateRule} ValidateRule
+ * @typedef {import('../types').UploadData} UploadData
+ * @typedef {import('../types').ValidateRule} ValidateRule
  */
 
 /**

package/lib/utils/fs.js

@@ -1,78 +1,69 @@
 const fs = require('fs');
+const fsPromises = require('fs').promises;
 const pt = require('path');
-const fsFun = {};
 
-//(读取类)
-['mkdir', 'rmdir', 'readdir', 'readFile', 'copyFile', 'unlink', 'exists', 'stat'].forEach(function (item) {
-    fsFun[item] = function (pathname, copypath) {
-        return new Promise(function (resolve, reject) {
-            let arg = [function (err, data) {
-                if (item === 'exists') {
-                    return resolve(err);
-                }
-                if (err) {
-                    return reject(err);
-                }
-                resolve(data || true);
-            }];
-            item === 'readFile' ? arg.unshift(copypath || 'utf8') : null;
-            item === 'copyFile' ? arg.unshift(copypath || '') : null;
-            fs[item](pathname, ...arg)
-        });
+// 是否存在
+const exists = async path => {
+    try {
+        await fsPromises.stat(path);
+        return true;
+    } catch(err) {
+        if(err.code === 'ENOENT') {
+            return false;
+        }
+        throw err;
     }
-});
+}
 
-//(写入类)
-['writeFile', 'appendFile'].forEach(function (item) {
-    fsFun[item] = function (pathname, content, charset='utf8') {
-        if (typeof content !== 'string') {
-            content = JSON.stringify(content)
-        };
-        return new Promise(function (resolve, reject) {
-            fs[item](pathname, content, charset, function(err, data){
-                if (err) {
-                    return reject(err);
-                }
-                resolve(data || '');
-            });
-        });
+// 是否文件
+const isFile = async path => {
+    try {
+        const stats = await fsPromises.stat(path);
+        return stats.isFile();
+    } catch(err) {
+        if(err.code === 'ENOENT') {
+            return false;
+        }
+        throw err;
     }
-});
-
-//(判断类)
-fsFun.isFileSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isFile();}
-fsFun.isDirSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isDirectory();}
+}
+const isFileSync = path => {
+    return fs.existsSync(path) && fs.statSync(path).isFile();
+}
 
-['isFile', 'isDir'].forEach(function (item) {
-    fsFun[item] = function (pathname) {
-        return new Promise(function (resolve, reject) {
-            fsFun.exists(pathname).then((result) => {
-                if (!result) {
-                    resolve(result);
-                } else {
-                    fsFun.stat(pathname).then((result) => {
-                        resolve(item === 'isFile' ? result.isFile() : result.isDirectory());
-                    }).catch((error) => {
-                        reject(error);
-                    });
-                }
-            }).catch((error) => {
-                reject(error);
-            });
-        });
+// 是否目录
+const isDir = async path => {
+    try {
+        const stats = await fsPromises.stat(path);
+        return stats.isDirectory();
+    } catch(err) {
+        if(err.code === 'ENOENT') {
+            return false;
+        }
+        throw err;
     }
-});
+}
+const isDirSync = path => {
+    return fs.existsSync(path) && fs.statSync(path).isDirectory();
+}
 
-//(多级目录生成)
-fsFun.mkdirs = async function (dirname) {
-    if(await fsFun.isDir(dirname)) {
+// 生成多级目录
+const mkdirs = async function (dirname) {
+    if(await isDir(dirname)) {
         return true;
     } else {
-        if(await fsFun.mkdirs(pt.dirname(dirname))) {
-            await fsFun.mkdir(dirname);
+        if(await mkdirs(pt.dirname(dirname))) {
+            await fsPromises.mkdir(dirname);
             return true;
         }
     }
 }
 
-module.exports = fsFun;
+module.exports = {
+    exists,
+    isFile,
+    isFileSync,
+    isDir,
+    isDirSync,
+    mkdirs
+};

package/lib/utils/utils.js

@@ -2,7 +2,7 @@
  * jj.js内置工具集<br/>
  * {date, error, fs, md5, str}
  * @module utils
- * @type {import('../types').Utils}
+ * @type {import('../../types').Utils}
  */
 module.exports = new Proxy({}, {
     get: (target, prop) => {