jj.js 0.8.8 → 0.9.0

package/lib/utils/date.js

@@ -1,40 +1,51 @@
-function format(fmt, date) {
-    (typeof date === 'string' || typeof date === 'number') && (date = new Date(parseInt(date + '000')));
-	  date = date || new Date();
-    let ret;
-    let opt = {
-        "Y+": date.getFullYear().toString(),        // 年
-        "y+": date.getFullYear().toString().slice(2),// 年
-        "m+": (date.getMonth() + 1).toString(),     // 月
-        "d+": date.getDate().toString(),            // 日
-        "H+": date.getHours().toString(),           // 时
-        "h+": (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString(),// 时
-        "i+": date.getMinutes().toString(),         // 分
-        "s+": date.getSeconds().toString()          // 秒
-    };
-    for (let k in opt) {
-        ret = new RegExp("(" + k + ")").exec(fmt);
-        if (ret) {
-            fmt = fmt.replace(ret[1], (ret[1].length == 1) ? (opt[k]) : (opt[k].padStart(ret[1].length, "0")))
-        };
-    };
-    return fmt;
-}
-
-function before(time) {
-    time -= 0;
-    let difTime = new Date().getTime() / 1000 - time;
-    let { h, m } = { h: parseInt(difTime / 3600), m: parseInt(difTime / 60) };
-    let msg = "";
-    if (h < 1) {
-        msg = `${m}分钟前`;
-    } else if (h >= 1 && h <= 24) {
-        msg = `${h}小时前`;
-    } else if (h > 24) {
-        h = parseInt(h / 24)
-        msg = `${h}天前`;
-    }
-    return msg;
-}
-
+/**
+ * @function
+ * @param {string} fmt - 格式化模板
+ * @param {(number|Date)} [date] - 时间戳或Date实例
+ * @returns {string} - 格式化后时间
+ */
+function format(fmt, date) {
+    (typeof date === 'string' || typeof date === 'number') && (date = new Date(parseInt(date + '000')));
+	  date = date || new Date();
+    let ret;
+    let opt = {
+        "Y+": date.getFullYear().toString(),        // 年
+        "y+": date.getFullYear().toString().slice(2),// 年
+        "m+": (date.getMonth() + 1).toString(),     // 月
+        "d+": date.getDate().toString(),            // 日
+        "H+": date.getHours().toString(),           // 时
+        "h+": (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString(),// 时
+        "i+": date.getMinutes().toString(),         // 分
+        "s+": date.getSeconds().toString()          // 秒
+    };
+    for (let k in opt) {
+        ret = new RegExp("(" + k + ")").exec(fmt);
+        if (ret) {
+            fmt = fmt.replace(ret[1], (ret[1].length == 1) ? (opt[k]) : (opt[k].padStart(ret[1].length, "0")))
+        };
+    };
+    return fmt;
+}
+
+/**
+ * @function - 获取多长时间前
+ * @param {number} time - 时间戳
+ * @returns {string} - 例如5分钟前
+ */
+function before(time) {
+    time -= 0;
+    let difTime = Date.now() / 1000 - time;
+    let { h, m } = { h: difTime / 3600, m: difTime / 60 };
+    let msg = "";
+    if (h < 1) {
+        msg = `${m}分钟前`;
+    } else if (h >= 1 && h <= 24) {
+        msg = `${h}小时前`;
+    } else if (h > 24) {
+        h = h / 24
+        msg = `${h}天前`;
+    }
+    return msg;
+}
+
 module.exports = {format, before};

package/lib/utils/error.js

@@ -1,5 +1,10 @@
 const fs = require('./fs.js');
 
+/**
+ * @function - 解析Error数据
+ * @param {Error} err - 错误对象
+ * @returns {object} - 解析后数据
+ */
 function parseError(err) {
     let msg = err.message;
     let stack = err.stack.replace(/(\r\n)/g, "\n").split("\n");
@@ -18,7 +23,7 @@ function parseError(err) {
     let begin = row - 10;
     let end = row + 10;
     let nth = 0;
-    let code = '';
+    let code = [];
     if(begin < 0) {
         end -= begin;
         begin = 0;
@@ -26,8 +31,7 @@ function parseError(err) {
     if(file_path == 'anonymous' || !file_path || !fs.isFileSync(file_path)) {
         code = stack;
     } else {
-        code = require('fs').readFileSync(file_path);
-        code = code.toString().replace(/(\r\n)/g, "\n").split("\n");
+        code = require('fs').readFileSync(file_path).toString().replace(/(\r\n)/g, "\n").split("\n");
         if(begin < 0) {
             end -= begin;
             begin = 0;
@@ -43,7 +47,7 @@ function parseError(err) {
         nth = row - begin;
     }
     
-    return data = {
+    return {
         msg,
         code,
         stack,

package/lib/utils/fs.js

@@ -1,78 +1,78 @@
-const fs = require('fs');
-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)
-        });
-    }
-});
-
-//(写入类)
-['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 || '');
-            });
-        });
-    }
-});
-
-//(判断类)
-fsFun.isFileSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isFile();}
-fsFun.isDirSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isDirectory();}
-
-['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);
-            });
-        });
-    }
-});
-
-//(多级目录生成)
-fsFun.mkdirs = async function (dirname) {
-    if(await fsFun.isDir(dirname)) {
-        return true;
-    } else {
-        if(await fsFun.mkdirs(pt.dirname(dirname))) {
-            await fsFun.mkdir(dirname);
-            return true;
-        }
-    }
-}
-
+const fs = require('fs');
+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)
+        });
+    }
+});
+
+//(写入类)
+['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 || '');
+            });
+        });
+    }
+});
+
+//(判断类)
+fsFun.isFileSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isFile();}
+fsFun.isDirSync = (path) => {return fs.existsSync(path) && fs.statSync(path).isDirectory();}
+
+['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);
+            });
+        });
+    }
+});
+
+//(多级目录生成)
+fsFun.mkdirs = async function (dirname) {
+    if(await fsFun.isDir(dirname)) {
+        return true;
+    } else {
+        if(await fsFun.mkdirs(pt.dirname(dirname))) {
+            await fsFun.mkdir(dirname);
+            return true;
+        }
+    }
+}
+
 module.exports = fsFun;

package/lib/utils/md5.js

@@ -1,7 +1,9 @@
-let crypto;
-module.exports = (str) => {
-    if(!crypto) {
-        crypto = require('crypto');
-    }
-    return crypto.createHash('md5').update(str).digest('hex');
-}
+/**
+ * @function - md5
+ * @param {string} str
+ * @returns {string}
+ */
+function md5(str) {
+    return require('crypto').createHash('md5').update(str).digest('hex');
+}
+module.exports = md5;

package/lib/utils/str.js

@@ -1,11 +1,21 @@
-function toHump(name) {
-    return name.replace(/\_(\w)/g, function(all, letter){
-        return letter.toUpperCase();
-    });
-}
-
-function toLine(name) {
-    return name.replace(/(?!^)([A-Z])/g, "_$1").toLowerCase();
-}
-
+/**
+ * @function - 转为驼峰
+ * @param {string} name
+ * @returns {string}
+ */
+function toHump(name) {
+    return name.replace(/\_(\w)/g, function(all, letter){
+        return letter.toUpperCase();
+    });
+}
+
+/**
+ * @function - 转为下划线
+ * @param {string} name
+ * @returns {string}
+ */
+function toLine(name) {
+    return name.replace(/(?!^)([A-Z])/g, "_$1").toLowerCase();
+}
+
 module.exports = {toHump, toLine};

package/lib/utils/utils.js

@@ -1,11 +1,17 @@
-module.exports = new Proxy({}, {
-    get: (target, prop) => {
-        if(prop in target || typeof prop == 'symbol' || prop == 'inspect') {
-            return target[prop];
-        }
-        if(prop == 'type') {
-            return para => Object.prototype.toString.call(para).slice(8,-1);
-        }
-        return require('./' + prop);
-    }
+/**
+ * jj.js内置工具集<br/>
+ * {date, error, fs, md5, str}
+ * @module utils
+ * @type {import('../types').Utils}
+ */
+module.exports = new Proxy({}, {
+    get: (target, prop) => {
+        if(prop in target || typeof prop == 'symbol' || prop == 'inspect') {
+            return target[prop];
+        }
+        if(prop == 'type') {
+            return para => Object.prototype.toString.call(para).slice(8, -1);
+        }
+        return require('./' + prop);
+    }
 });

package/lib/view.js

@@ -4,32 +4,61 @@ const {app: cfg_app, view: cfg_view} = require('./config');
 const {toLine} = require('./utils/str');
 const Context = require('./context');
 
+/**
+ * @extends Context
+ */
 class View extends Context
 {
+    /**
+     * Initialize a new `View`
+     * @public
+     * @param {import('./types').Context} ctx
+     */
     constructor(ctx) {
         super(ctx);
         this._data = {};
         this.setEngine(cfg_view.view_engine);
     }
     
-    // 加载文件
+    /**
+     * 获取文件内容
+     * @public
+     * @param {string} [template]
+     * @returns {Promise<string>}
+     */
     async load(template) {
         const file_name = this.parseTplName(template);
         return await readFile(file_name);
     }
 
-    // 渲染内容
+    /**
+     * 渲染(解析数据)内容
+     * @public
+     * @param {string} content
+     * @returns {Promise<string>}
+     */
     async render(content) {
         return this._engine.render(content, this._data);
     }
 
-    // 渲染文件
+    /**
+     * 渲染(解析数据)文件
+     * @public
+     * @param {string} [template]
+     * @returns {Promise<string>}
+     */
     async fetch(template) {
         const file_name = this.parseTplName(template);
         return await this._engine(file_name, this._data || {});
     }
 
-    //赋值模版数据
+    /**
+     * 模版数据赋值
+     * @public
+     * @param {(string|object)} name
+     * @param {*} [value]
+     * @returns {this}
+     */
     assign(name, value) {
         if(typeof name == 'string') {
             this._data[name] = value;
@@ -39,13 +68,25 @@ class View extends Context
         return this;
     }
 
-    //获取模版数据
+    /**
+     * 获取模版数据
+     * @public
+     * @param {string} [name]
+     * @returns {object}
+     */
     data(name) {
         if(name) return this._data[name];
         else return this._data;
     }
 
-    //解析模板地址
+    /**
+     * 解析模板地址
+     * @public
+     * @param {string} [template] - 默认当前请求方法名，支持智能解析
+     * @param {string} [view_folder] - 模板文件夹名字
+     * @param {string} [view_depr] - 模板文件分隔符
+     * @returns {string}
+     */
     parsePath(template=this.ctx.ACTION, view_folder, view_depr) {
         !view_folder && (view_folder = cfg_view.view_folder);
         !view_depr && (view_depr = cfg_view.view_depr);
@@ -58,10 +99,15 @@ class View extends Context
             }
         }
         path.extname(view_file) || (view_file += cfg_view.view_ext);
-        return path.join(this.$config.app.base_dir, view_file);
+        return path.join(cfg_app.base_dir, view_file);
     }
 
-    //解析模板名字
+    /**
+     * 解析模板名字
+     * @public
+     * @param {string} [template] - 默认当前请求方法名，支持智能解析
+     * @returns {string}
+     */
     parseTplName(template) {
         let file_name = this.parsePath(template, this._folder, this._depr);
         let is_file = isFileSync(file_name);
@@ -76,7 +122,12 @@ class View extends Context
         return file_name;
     }
 
-    // 设置模版引擎
+    /**
+     * 设置模版引擎
+     * @public
+     * @param {(string|object)} engine 
+     * @returns {this}
+     */
     setEngine(engine) {
         this._engine = typeof engine == 'string' ? require(engine) : engine;
         this._engine.defaults.debug = cfg_app.app_debug;
@@ -87,7 +138,13 @@ class View extends Context
         return this;
     }
 
-    //设置模版函数
+    /**
+     * 设置模版函数
+     * @public
+     * @param {(string|object)} fun_obj - 函数名字或者包含多个函数的对象
+     * @param {*} [fun] - 函数
+     * @returns {this}
+     */
     setFilter(fun_obj, fun) {
         if(typeof fun_obj === 'string') {
             fun_obj = {[fun_obj]: fun};
@@ -99,13 +156,23 @@ class View extends Context
         return this;
     }
 
-    //设置模版目录
+    /**
+     * 设置模板目录
+     * @public
+     * @param {string} view_folder - 文件夹名字
+     * @returns {this}
+     */
     setFolder(view_folder) {
         this._folder = view_folder;
         return this;
     }
 
-    //设置文件分割符
+    /**
+     * 设置文件分割符
+     * @public
+     * @param {string} view_depr - 文件分隔符（默认'/'，不分二级目录，可以设置为'_'或其他）
+     * @returns {this}
+     */
     setDepr(view_depr) {
         this._depr = view_depr;
         return this;

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "jj.js",
-  "version": "0.8.8",
-  "description": "A simple and lightweight MVC framework built on nodejs+koa2",
+  "version": "0.9.0",
+  "description": "A super simple lightweight NodeJS MVC framework（一个超级简单轻量的NodeJS MVC框架）",
   "main": "jj.js",
-  "scripts": {
-  },
+  "scripts": {},
   "repository": {
     "type": "git",
     "url": "git+https://github.com/yafoo/jj.js.git"
@@ -21,13 +20,16 @@
   },
   "homepage": "https://github.com/yafoo/jj.js#readme",
   "dependencies": {
-    "@koa/router": "^10.1.1",
+    "@koa/router": "^12.0.1",
     "art-template": "^4.13.2",
     "escape-html": "^1.0.3",
     "is-class": "0.0.9",
-    "koa": "^2.13.4",
+    "koa": "^2.15.0",
     "koa-body": "^5.0.0",
     "koa-static": "^5.0.0",
     "mysql": "^2.18.1"
+  },
+  "engines": {
+    "node": ">= 12.17.0"
   }
 }