colored-table 0.0.2 → 0.1.0

package/src/build/index.cjs

@@ -0,0 +1,56 @@
+'use strict';
+
+var colorPen = require('color-pen');
+var buildBody = require('./buildBody.cjs');
+var buildHeader = require('./buildHeader.cjs');
+var computerMaxLen = require('./computerMaxLen.cjs');
+var global = require('../global.cjs');
+
+/**  渲染  */
+function render(table, fontSize) {
+    /**  获取每一行最大宽度的元素的宽度组成的数组  */
+    const lineLen = computerMaxLen.computerMaxLen(table);
+    /**  是否有表头  */
+    let hasHeader = false;
+    let buildStr = '';
+    // 构建表头
+    if (table.header) {
+        hasHeader = true;
+        buildStr += buildHeader.buildHeader(table.header, lineLen);
+    }
+    buildStr += buildBody.buildBody(table.body, lineLen, hasHeader);
+    /**  彩色数组  */
+    const colorTextArr = colorPen.colorText(buildStr);
+    if (global.browserEnv) {
+        const strList = colorTextArr[0].split('%c');
+        const result = colorTextArr.map((e, i) => {
+            if (i > 0) {
+                /**  构建最小的单位的组  */
+                const doubleByteCharNumber = [...strList[i]].reduce((v, e) => {
+                    if (colorPen.strInTerminalLength(e) > 1) {
+                        global.data.emojiRegex.lastIndex = 0;
+                        if (e.match(global.data.emojiRegex))
+                            return v - (global.data.emojiLength - 2);
+                        return v + (2 - global.data.chineseLength);
+                    }
+                    return v;
+                }, 0);
+                const newStr = e +
+                    "font-family: Consolas,Monaco,Courier,'Courier New','等宽字体',monospace; font-size:" +
+                    fontSize +
+                    'px;word-spacing:normal;padding:0;margin:0;padding-right:' +
+                    doubleByteCharNumber * fontSize +
+                    'px';
+                return newStr;
+            }
+            return e;
+        });
+        /// 渲染表格
+        console.log(...result);
+    }
+    else {
+        console.log(...colorTextArr);
+    }
+}
+
+exports.render = render;

package/src/build/index.mjs

@@ -0,0 +1,54 @@
+import { colorText, strInTerminalLength } from 'color-pen';
+import { buildBody } from './buildBody.mjs';
+import { buildHeader } from './buildHeader.mjs';
+import { computerMaxLen } from './computerMaxLen.mjs';
+import { browserEnv, data } from '../global.mjs';
+
+/**  渲染  */
+function render(table, fontSize) {
+    /**  获取每一行最大宽度的元素的宽度组成的数组  */
+    const lineLen = computerMaxLen(table);
+    /**  是否有表头  */
+    let hasHeader = false;
+    let buildStr = '';
+    // 构建表头
+    if (table.header) {
+        hasHeader = true;
+        buildStr += buildHeader(table.header, lineLen);
+    }
+    buildStr += buildBody(table.body, lineLen, hasHeader);
+    /**  彩色数组  */
+    const colorTextArr = colorText(buildStr);
+    if (browserEnv) {
+        const strList = colorTextArr[0].split('%c');
+        const result = colorTextArr.map((e, i) => {
+            if (i > 0) {
+                /**  构建最小的单位的组  */
+                const doubleByteCharNumber = [...strList[i]].reduce((v, e) => {
+                    if (strInTerminalLength(e) > 1) {
+                        data.emojiRegex.lastIndex = 0;
+                        if (e.match(data.emojiRegex))
+                            return v - (data.emojiLength - 2);
+                        return v + (2 - data.chineseLength);
+                    }
+                    return v;
+                }, 0);
+                const newStr = e +
+                    "font-family: Consolas,Monaco,Courier,'Courier New','等宽字体',monospace; font-size:" +
+                    fontSize +
+                    'px;word-spacing:normal;padding:0;margin:0;padding-right:' +
+                    doubleByteCharNumber * fontSize +
+                    'px';
+                return newStr;
+            }
+            return e;
+        });
+        /// 渲染表格
+        console.log(...result);
+    }
+    else {
+        console.log(...colorTextArr);
+    }
+}
+
+export { render };

package/src/core.cjs

@@ -0,0 +1,51 @@
+'use strict';
+
+var createHeaderProto = require('./proto/createHeaderProto.cjs');
+var parse = require('./parse/parse.cjs');
+var parseRow = require('./parse/parseRow.cjs');
+var index = require('./build/index.cjs');
+
+/**  构建一个用于控制台的表格  */
+function table(options) {
+    /**  构建初始化配置的表单  */
+    const [tableEle, tablePro] = parse.parse(options);
+    let fontSize = 12;
+    /**
+     * 核心技能
+     *
+     *  这里将构建表格
+     *
+     *
+     */
+    const core = () => index.render(tableEle, fontSize);
+    Object.setPrototypeOf(core, this);
+    Object.defineProperties(core, {
+        addRow: {
+            value: (data) => {
+                tableEle.body.push(parseRow.parseRow(data, tablePro));
+                return core;
+            },
+            configurable: false,
+            writable: false,
+            enumerable: false,
+        },
+        setHeader: {
+            value: (data) => {
+                tableEle.header = parseRow.parseRow(data, createHeaderProto.createHeaderProto(tablePro));
+                return core;
+            },
+            configurable: false,
+            writable: false,
+            enumerable: false,
+        },
+        setFontSize: {
+            value: (_fontSize) => {
+                fontSize = _fontSize;
+                return core;
+            },
+        },
+    });
+    return core;
+}
+
+exports.table = table;

package/src/core.mjs

@@ -0,0 +1,49 @@
+import { createHeaderProto } from './proto/createHeaderProto.mjs';
+import { parse } from './parse/parse.mjs';
+import { parseRow } from './parse/parseRow.mjs';
+import { render } from './build/index.mjs';
+
+/**  构建一个用于控制台的表格  */
+function table(options) {
+    /**  构建初始化配置的表单  */
+    const [tableEle, tablePro] = parse(options);
+    let fontSize = 12;
+    /**
+     * 核心技能
+     *
+     *  这里将构建表格
+     *
+     *
+     */
+    const core = () => render(tableEle, fontSize);
+    Object.setPrototypeOf(core, this);
+    Object.defineProperties(core, {
+        addRow: {
+            value: (data) => {
+                tableEle.body.push(parseRow(data, tablePro));
+                return core;
+            },
+            configurable: false,
+            writable: false,
+            enumerable: false,
+        },
+        setHeader: {
+            value: (data) => {
+                tableEle.header = parseRow(data, createHeaderProto(tablePro));
+                return core;
+            },
+            configurable: false,
+            writable: false,
+            enumerable: false,
+        },
+        setFontSize: {
+            value: (_fontSize) => {
+                fontSize = _fontSize;
+                return core;
+            },
+        },
+    });
+    return core;
+}
+
+export { table };

package/src/ele/rowEle.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+var aJsTools = require('a-js-tools');
+
+/**  构建行 原始类  */
+const RowEleClass = aJsTools.createConstructor(function (proto) {
+    this.data = [];
+    Object.setPrototypeOf(this, proto);
+    return this;
+});
+
+exports.RowEleClass = RowEleClass;

package/src/ele/rowEle.mjs

@@ -0,0 +1,10 @@
+import { createConstructor } from 'a-js-tools';
+
+/**  构建行 原始类  */
+const RowEleClass = createConstructor(function (proto) {
+    this.data = [];
+    Object.setPrototypeOf(this, proto);
+    return this;
+});
+
+export { RowEleClass };

package/src/ele/tableEle.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+var aJsTools = require('a-js-tools');
+
+/** TableEleClass 类，原始构建类   */
+const TableEleClass = aJsTools.createConstructor(function (proto) {
+    this.body = [];
+    this.header = undefined;
+    Object.setPrototypeOf(this, proto);
+    return this;
+});
+
+exports.TableEleClass = TableEleClass;

package/src/ele/tableEle.mjs

@@ -0,0 +1,11 @@
+import { createConstructor } from 'a-js-tools';
+
+/** TableEleClass 类，原始构建类   */
+const TableEleClass = createConstructor(function (proto) {
+    this.body = [];
+    this.header = undefined;
+    Object.setPrototypeOf(this, proto);
+    return this;
+});
+
+export { TableEleClass };

package/src/global.cjs

@@ -0,0 +1,53 @@
+'use strict';
+
+var aJsTools = require('a-js-tools');
+
+/**  浏览器环境  */
+const browserEnv = !aJsTools.isNode();
+const data = {
+    emojiLength: 2.08,
+    emojiRegex: /[\u{1F600}-\u{1F64F}\u{1F300}-\u{1F5FF}\u{1F680}-\u{1F6FF}\u{1F900}-\u{1F9FF}]/gu,
+    chineseLength: 1.8,
+    /**  中文的正则  */
+    chineseRegex: /[\u4E00-\u9FFF]/g,
+};
+/**  全局的属性  */
+class ColoredTableGlobalData {
+    align = 'left';
+    color = '';
+    bgColor = '';
+    bold = false;
+    underline = false;
+    italic = false;
+    border = {
+        left: {
+            color: undefined,
+            style: 'simple',
+        },
+        right: {
+            color: undefined,
+            style: 'simple',
+        },
+        top: {
+            color: undefined,
+            style: 'simple',
+        },
+        bottom: {
+            color: undefined,
+            style: 'simple',
+        },
+    };
+}
+/**
+ *
+ * 全局 table 配置
+ *
+ * 若没有其他特殊说名，将使用该数据作为最终的渲染依据
+ *
+ * 即为默认属性
+ */
+const globalData = new ColoredTableGlobalData();
+
+exports.browserEnv = browserEnv;
+exports.data = data;
+exports.globalData = globalData;

package/src/global.mjs

@@ -0,0 +1,49 @@
+import { isNode } from 'a-js-tools';
+
+/**  浏览器环境  */
+const browserEnv = !isNode();
+const data = {
+    emojiLength: 2.08,
+    emojiRegex: /[\u{1F600}-\u{1F64F}\u{1F300}-\u{1F5FF}\u{1F680}-\u{1F6FF}\u{1F900}-\u{1F9FF}]/gu,
+    chineseLength: 1.8,
+    /**  中文的正则  */
+    chineseRegex: /[\u4E00-\u9FFF]/g,
+};
+/**  全局的属性  */
+class ColoredTableGlobalData {
+    align = 'left';
+    color = '';
+    bgColor = '';
+    bold = false;
+    underline = false;
+    italic = false;
+    border = {
+        left: {
+            color: undefined,
+            style: 'simple',
+        },
+        right: {
+            color: undefined,
+            style: 'simple',
+        },
+        top: {
+            color: undefined,
+            style: 'simple',
+        },
+        bottom: {
+            color: undefined,
+            style: 'simple',
+        },
+    };
+}
+/**
+ *
+ * 全局 table 配置
+ *
+ * 若没有其他特殊说名，将使用该数据作为最终的渲染依据
+ *
+ * 即为默认属性
+ */
+const globalData = new ColoredTableGlobalData();
+
+export { browserEnv, data, globalData };

package/src/lines.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+const lines = {
+    fine: {
+        lt: '┌',
+        ct: '┬',
+        rt: '┐',
+        lc: '├',
+        c: '┼',
+        rc: '┤',
+        lb: '└',
+        cb: '┴',
+        rb: '┘',
+        l: '─',
+        v: '│',
+    },
+};
+
+exports.lines = lines;

package/src/lines.mjs

@@ -0,0 +1,17 @@
+const lines = {
+    fine: {
+        lt: '┌',
+        ct: '┬',
+        rt: '┐',
+        lc: '├',
+        c: '┼',
+        rc: '┤',
+        lb: '└',
+        cb: '┴',
+        rb: '┘',
+        l: '─',
+        v: '│',
+    },
+};
+
+export { lines };

package/src/parse/parse.cjs

@@ -0,0 +1,44 @@
+'use strict';
+
+var aTypeOfJs = require('a-type-of-js');
+var global = require('../global.cjs');
+var setPro = require('../proto/setPro.cjs');
+var tableEle = require('../ele/tableEle.cjs');
+var parseRow = require('./parseRow.cjs');
+var createHeaderProto = require('../proto/createHeaderProto.cjs');
+
+/**  表格的  */
+class TableProto {
+}
+/**
+ *
+ * 解析并转化（可选）参数为定值属性
+ *
+ */
+function parse(options) {
+    // 初始化时可为空（undefined）
+    if (aTypeOfJs.isUndefined(options)) {
+        options = {};
+    }
+    // 数组参数转化为对象
+    if (aTypeOfJs.isArray(options)) {
+        options = {
+            body: options,
+        };
+    }
+    /**  表格的原型属性  */
+    const tableProto = new TableProto();
+    // 将在 options 上配置的属性配置到原型上
+    setPro.setPro(tableProto, options);
+    Object.setPrototypeOf(tableProto, global.globalData);
+    // 创建表格
+    const table = new tableEle.TableEleClass(tableProto);
+    // 解析表头
+    if (options.header)
+        table.header = parseRow.parseRow(options.header, createHeaderProto.createHeaderProto(tableProto));
+    /**  解析表干  */
+    options.body?.forEach(e => table.body.push(parseRow.parseRow(e, tableProto)));
+    return [table, tableProto];
+}
+
+exports.parse = parse;

package/src/parse/parse.mjs

@@ -0,0 +1,42 @@
+import { isUndefined, isArray } from 'a-type-of-js';
+import { globalData } from '../global.mjs';
+import { setPro } from '../proto/setPro.mjs';
+import { TableEleClass } from '../ele/tableEle.mjs';
+import { parseRow } from './parseRow.mjs';
+import { createHeaderProto } from '../proto/createHeaderProto.mjs';
+
+/**  表格的  */
+class TableProto {
+}
+/**
+ *
+ * 解析并转化（可选）参数为定值属性
+ *
+ */
+function parse(options) {
+    // 初始化时可为空（undefined）
+    if (isUndefined(options)) {
+        options = {};
+    }
+    // 数组参数转化为对象
+    if (isArray(options)) {
+        options = {
+            body: options,
+        };
+    }
+    /**  表格的原型属性  */
+    const tableProto = new TableProto();
+    // 将在 options 上配置的属性配置到原型上
+    setPro(tableProto, options);
+    Object.setPrototypeOf(tableProto, globalData);
+    // 创建表格
+    const table = new TableEleClass(tableProto);
+    // 解析表头
+    if (options.header)
+        table.header = parseRow(options.header, createHeaderProto(tableProto));
+    /**  解析表干  */
+    options.body?.forEach(e => table.body.push(parseRow(e, tableProto)));
+    return [table, tableProto];
+}
+
+export { parse };

package/src/parse/parseCell.cjs

@@ -0,0 +1,27 @@
+'use strict';
+
+var aTypeOfJs = require('a-type-of-js');
+var setPro = require('../proto/setPro.cjs');
+
+/**  解析为单元格  */
+function parseCell(data, parentPro) {
+    // 空值直接返回空
+    if (aTypeOfJs.isUndefined(data)) {
+        return undefined;
+    }
+    // 直接值转化为对象值，方便后续统一处理
+    if (aTypeOfJs.isType(data, i => !aTypeOfJs.isPlainObject(i))) {
+        data = {
+            content: data,
+        };
+    }
+    /**  单元格的属性  */
+    const cell = {
+        content: data.content,
+    }; // 其他的属性在下面的 `setPro` 中进行给值
+    setPro.setPro(cell, data); // 构建属性的值
+    Object.setPrototypeOf(cell, parentPro);
+    return cell;
+}
+
+exports.parseCell = parseCell;

package/src/parse/parseCell.mjs

@@ -0,0 +1,25 @@
+import { isUndefined, isType, isPlainObject } from 'a-type-of-js';
+import { setPro } from '../proto/setPro.mjs';
+
+/**  解析为单元格  */
+function parseCell(data, parentPro) {
+    // 空值直接返回空
+    if (isUndefined(data)) {
+        return undefined;
+    }
+    // 直接值转化为对象值，方便后续统一处理
+    if (isType(data, i => !isPlainObject(i))) {
+        data = {
+            content: data,
+        };
+    }
+    /**  单元格的属性  */
+    const cell = {
+        content: data.content,
+    }; // 其他的属性在下面的 `setPro` 中进行给值
+    setPro(cell, data); // 构建属性的值
+    Object.setPrototypeOf(cell, parentPro);
+    return cell;
+}
+
+export { parseCell };

package/src/parse/parseRow.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+var aTypeOfJs = require('a-type-of-js');
+var rowEle = require('../ele/rowEle.cjs');
+var setPro = require('../proto/setPro.cjs');
+var parseCell = require('./parseCell.cjs');
+
+/**  表格的行原型  */
+class RowProto {
+}
+/**
+ * 解析行
+ *
+ * @param data 行数据
+ * @param parentPro 父级的属性参数
+ */
+function parseRow(data, parentPro) {
+    // 数组转化为对，方便后续统一处理
+    if (aTypeOfJs.isArray(data))
+        data = { data };
+    /**  表格的原型属性  */
+    const rowProto = new RowProto();
+    setPro.setPro(rowProto, data); // 设置已配置的属性
+    /**  行数据  */
+    const result = new rowEle.RowEleClass(rowProto);
+    Object.setPrototypeOf(rowProto, parentPro);
+    data.data?.forEach(e => {
+        if (e)
+            result.data.push(parseCell.parseCell(e, rowProto));
+    });
+    return result;
+}
+
+exports.RowProto = RowProto;
+exports.parseRow = parseRow;

package/src/parse/parseRow.mjs

@@ -0,0 +1,32 @@
+import { isArray } from 'a-type-of-js';
+import { RowEleClass } from '../ele/rowEle.mjs';
+import { setPro } from '../proto/setPro.mjs';
+import { parseCell } from './parseCell.mjs';
+
+/**  表格的行原型  */
+class RowProto {
+}
+/**
+ * 解析行
+ *
+ * @param data 行数据
+ * @param parentPro 父级的属性参数
+ */
+function parseRow(data, parentPro) {
+    // 数组转化为对，方便后续统一处理
+    if (isArray(data))
+        data = { data };
+    /**  表格的原型属性  */
+    const rowProto = new RowProto();
+    setPro(rowProto, data); // 设置已配置的属性
+    /**  行数据  */
+    const result = new RowEleClass(rowProto);
+    Object.setPrototypeOf(rowProto, parentPro);
+    data.data?.forEach(e => {
+        if (e)
+            result.data.push(parseCell(e, rowProto));
+    });
+    return result;
+}
+
+export { RowProto, parseRow };

package/src/proto/createHeaderProto.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+var parseRow = require('../parse/parseRow.cjs');
+
+/** 表头  */
+class HeaderProto extends parseRow.RowProto {
+    border = {
+        left: {
+            style: 'bold',
+            color: undefined,
+        },
+        right: {
+            style: 'bold',
+            color: undefined,
+        },
+        top: {
+            style: 'bold',
+            color: undefined,
+        },
+        bottom: {
+            style: 'bold',
+            color: undefined,
+        },
+    };
+}
+/**  设置 header 的原型  */
+function createHeaderProto(tableProto) {
+    const headerProto = new HeaderProto();
+    Object.setPrototypeOf(headerProto, tableProto);
+    return headerProto;
+}
+
+exports.createHeaderProto = createHeaderProto;

package/src/proto/createHeaderProto.mjs

@@ -0,0 +1,31 @@
+import { RowProto } from '../parse/parseRow.mjs';
+
+/** 表头  */
+class HeaderProto extends RowProto {
+    border = {
+        left: {
+            style: 'bold',
+            color: undefined,
+        },
+        right: {
+            style: 'bold',
+            color: undefined,
+        },
+        top: {
+            style: 'bold',
+            color: undefined,
+        },
+        bottom: {
+            style: 'bold',
+            color: undefined,
+        },
+    };
+}
+/**  设置 header 的原型  */
+function createHeaderProto(tableProto) {
+    const headerProto = new HeaderProto();
+    Object.setPrototypeOf(headerProto, tableProto);
+    return headerProto;
+}
+
+export { createHeaderProto };