@anjianshi/utils 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/.eslintrc.cjs +6 -0
  2. package/README.md +1 -0
  3. package/build-cleanup.cjs +10 -0
  4. package/env-browser/device.d.ts +24 -0
  5. package/env-browser/device.js +49 -0
  6. package/env-browser/global.d.ts +11 -0
  7. package/env-browser/global.js +14 -0
  8. package/env-browser/load-script.d.ts +5 -0
  9. package/env-browser/load-script.js +13 -0
  10. package/env-browser/logging.d.ts +18 -0
  11. package/env-browser/logging.js +49 -0
  12. package/env-browser/manage-vconsole.d.ts +16 -0
  13. package/env-browser/manage-vconsole.js +38 -0
  14. package/env-node/index.d.ts +17 -0
  15. package/env-node/index.js +45 -0
  16. package/env-node/logging.d.ts +64 -0
  17. package/env-node/logging.js +159 -0
  18. package/index.d.ts +3 -0
  19. package/index.js +3 -0
  20. package/init-dayjs.d.ts +2 -0
  21. package/init-dayjs.js +7 -0
  22. package/lang/async.d.ts +19 -0
  23. package/lang/async.js +34 -0
  24. package/lang/index.d.ts +5 -0
  25. package/lang/index.js +5 -0
  26. package/lang/object.d.ts +5 -0
  27. package/lang/object.js +31 -0
  28. package/lang/string.d.ts +17 -0
  29. package/lang/string.js +59 -0
  30. package/lang/time.d.ts +10 -0
  31. package/lang/time.js +18 -0
  32. package/lang/types.d.ts +98 -0
  33. package/lang/types.js +41 -0
  34. package/logging/adapt.d.ts +5 -0
  35. package/logging/adapt.js +38 -0
  36. package/logging/formatters.d.ts +10 -0
  37. package/logging/formatters.js +22 -0
  38. package/logging/index.d.ts +43 -0
  39. package/logging/index.js +72 -0
  40. package/package.json +43 -0
  41. package/src/.eslintrc.cjs +8 -0
  42. package/src/env-browser/.eslintrc.cjs +6 -0
  43. package/src/env-browser/device.ts +60 -0
  44. package/src/env-browser/global.ts +20 -0
  45. package/src/env-browser/load-script.ts +13 -0
  46. package/src/env-browser/logging.ts +58 -0
  47. package/src/env-browser/manage-vconsole.ts +54 -0
  48. package/src/env-node/.eslintrc.cjs +4 -0
  49. package/src/env-node/index.ts +46 -0
  50. package/src/env-node/logging.ts +202 -0
  51. package/src/index.ts +3 -0
  52. package/src/init-dayjs.ts +8 -0
  53. package/src/lang/async.ts +47 -0
  54. package/src/lang/index.ts +5 -0
  55. package/src/lang/object.ts +28 -0
  56. package/src/lang/string.ts +62 -0
  57. package/src/lang/time.ts +19 -0
  58. package/src/lang/types.ts +138 -0
  59. package/src/logging/adapt.ts +40 -0
  60. package/src/logging/formatters.ts +23 -0
  61. package/src/logging/index.ts +87 -0
  62. package/src/url.ts +153 -0
  63. package/url.d.ts +28 -0
  64. package/url.js +116 -0
package/.eslintrc.cjs ADDED
@@ -0,0 +1,6 @@
1
+ /* eslint-env node */
2
+ module.exports = {
3
+ root: true,
4
+ extends: ['./node_modules/@anjianshi/presets/eslint-base.js'],
5
+ rules: {},
6
+ }
package/README.md ADDED
@@ -0,0 +1 @@
1
+ # Common JavaScript Utils
@@ -0,0 +1,10 @@
1
+ /* eslint-env node */
2
+ const child_process = require('child_process')
3
+ const fs = require('fs')
4
+ const path = require('path')
5
+
6
+ const base = path.resolve(__dirname, './')
7
+ const dist = path.join(base, 'dist')
8
+
9
+ const items = fs.readdirSync(dist)
10
+ child_process.execSync(`rm -rf ${items.join(' ')}`, { shell: true })
@@ -0,0 +1,24 @@
1
+ /**
2
+ * 自动计算最合适的 rem 大小,应用到页面样式上。
3
+ *
4
+ * rem 的意义是对于大屏幕,适当地同步放大界面元素,以提供更饱满的显示效果。
5
+ * 不过也不是所有地方都原封不动地大就好了,所以还要配合 media query 来实现最佳效果。
6
+ */
7
+ export declare function autoRem(): void;
8
+ /**
9
+ * 当前设备是否是全面屏
10
+ * 页面刚加载时可能取不到 offsetHeight,因此通过一个函数而不是常量来提供此值
11
+ */
12
+ export declare function isFullScreen(): boolean;
13
+ /**
14
+ * 当前是否是 iOS 设备
15
+ */
16
+ export declare const isIOS: boolean;
17
+ /**
18
+ * 当前是否是移动设备
19
+ */
20
+ export declare const isMobile: boolean;
21
+ /**
22
+ * 当前是否是微信内部浏览器
23
+ */
24
+ export declare const isWechat: boolean;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * 自动计算最合适的 rem 大小,应用到页面样式上。
3
+ *
4
+ * rem 的意义是对于大屏幕,适当地同步放大界面元素,以提供更饱满的显示效果。
5
+ * 不过也不是所有地方都原封不动地大就好了,所以还要配合 media query 来实现最佳效果。
6
+ */
7
+ export function autoRem() {
8
+ const resizeEvt = 'orientationchange' in window ? 'orientationchange' : 'resize';
9
+ /**
10
+ * 计算规则:
11
+ * - 微信标准的 375px 宽度下,1rem 为 50px(这个比例的来由是这样的:移动端通常像素比 >= 2,这个 375px 的实际渲染像素是 750px,也就是实际渲染 750px 的情况下,1rem 为 100px)。
12
+ * - 在平板等特大屏幕下,限制 rem 的最大值为 75px,再大就夸张了。
13
+ * - 竖屏时取宽度来适配 rem,横屏时取高度来适配,以保证屏幕朝向不同时,界面元素的放大比例是一致的(这应该更符合人的认知:对于一个同样大小的屏幕,无论什么朝向,上面的文字应该是一样大的)。
14
+ * 注意:此计算方式仅适合“不能任意调整浏览器大小的”移动设备,对于浏览器窗口可能任意尺寸、比例的桌面端,还是应该始终按照宽度来适配。
15
+ *
16
+ * 从 px 到 rem 的换算:
17
+ * 原 px 单位的值换算成 rem,只要除以 50 即可。例如 12px 变成 0.24rem。
18
+ */
19
+ function updateRem() {
20
+ const { clientWidth, clientHeight } = document.documentElement;
21
+ const refSize = Math.min(clientWidth, clientHeight);
22
+ const rem = Math.min((refSize / 750) * 100, 75);
23
+ document.documentElement.style.fontSize = `${rem}px`;
24
+ }
25
+ window.addEventListener(resizeEvt, updateRem, false);
26
+ document.addEventListener('DOMContentLoaded', updateRem, false);
27
+ }
28
+ /**
29
+ * 当前设备是否是全面屏
30
+ * 页面刚加载时可能取不到 offsetHeight,因此通过一个函数而不是常量来提供此值
31
+ */
32
+ export function isFullScreen() {
33
+ const rate = document.documentElement.offsetHeight / document.documentElement.offsetWidth;
34
+ const limit = window.screen.height === window.screen.availHeight ? 1.8 : 1.65; // 临界判断值
35
+ return rate > limit;
36
+ }
37
+ /**
38
+ * 当前是否是 iOS 设备
39
+ */
40
+ export const isIOS = /iPad|iPhone|iPod/.test(navigator.userAgent);
41
+ /**
42
+ * 当前是否是移动设备
43
+ */
44
+ export const isMobile = /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(navigator.userAgent || navigator.vendor) ||
45
+ /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test((navigator.userAgent || navigator.vendor).substr(0, 4));
46
+ /**
47
+ * 当前是否是微信内部浏览器
48
+ */
49
+ export const isWechat = /micromessenger/i.test(navigator.userAgent);
@@ -0,0 +1,11 @@
1
+ /**
2
+ * 通过此模块注册全局变量以便于调试
3
+ */
4
+ declare global {
5
+ interface Window {
6
+ app: {
7
+ [key: string]: unknown;
8
+ };
9
+ }
10
+ }
11
+ export default function registerGlobal(key: string, content: unknown): void;
@@ -0,0 +1,14 @@
1
+ /**
2
+ * 通过此模块注册全局变量以便于调试
3
+ */
4
+ // web-worker 环境下不存在 window 变量,无法执行注册
5
+ let hasWindow = false;
6
+ try {
7
+ window.app = {};
8
+ hasWindow = true;
9
+ }
10
+ catch (e) { } // eslint-disable-line no-empty
11
+ export default function registerGlobal(key, content) {
12
+ if (hasWindow)
13
+ window.app[key] = content;
14
+ }
@@ -0,0 +1,5 @@
1
+ /**
2
+ * 加载脚本文件
3
+ * 返回 Promise,成功则 resolve,失败 reject
4
+ */
5
+ export default function loadScript(url: string): Promise<void>;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * 加载脚本文件
3
+ * 返回 Promise,成功则 resolve,失败 reject
4
+ */
5
+ export default async function loadScript(url) {
6
+ return new Promise((resolve, reject) => {
7
+ const script = document.createElement('script');
8
+ script.src = url;
9
+ script.onload = () => resolve();
10
+ script.onerror = err => reject(err);
11
+ window.document.head.appendChild(script);
12
+ });
13
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * 针对浏览器环境定制 logging
3
+ */
4
+ import { type Logger, type LogInfo, LogHandler } from '../logging/index.js';
5
+ export * from '../logging/index.js';
6
+ /**
7
+ * 实现向浏览器 console 输出日志
8
+ */
9
+ export declare class ConsoleHandler extends LogHandler {
10
+ log(info: LogInfo): void;
11
+ private static readonly colors;
12
+ private static readonly colorMap;
13
+ static getColor(name: string): string;
14
+ }
15
+ /**
16
+ * 预设的初始化行为
17
+ */
18
+ export declare function initLogger(logger?: Logger): void;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * 针对浏览器环境定制 logging
3
+ */
4
+ import { logger as defaultLogger, LogLevel, LogHandler, formatters, } from '../logging/index.js';
5
+ export * from '../logging/index.js';
6
+ /**
7
+ * 实现向浏览器 console 输出日志
8
+ */
9
+ export class ConsoleHandler extends LogHandler {
10
+ log(info) {
11
+ const color = (value = 'black') => `color: ${value};`;
12
+ const prefix = '%c' + [formatters.time(info), info.logger].map((v) => (v ? `[${v}]` : '')).join('');
13
+ const prefixColor = info.logger ? color(ConsoleHandler.getColor(info.logger)) : color();
14
+ const values = [prefix, prefixColor, ...info.args];
15
+ if (info.level === LogLevel.Debug)
16
+ console.debug(...values);
17
+ else if (info.level === LogLevel.Info)
18
+ console.log(...values);
19
+ else if (info.level === LogLevel.Warning)
20
+ console.warn(...values);
21
+ else
22
+ console.error(...values);
23
+ }
24
+ // 按顺序给各主题分配颜色(取自 http://chriskempson.com/projects/base16/)
25
+ static colors = [
26
+ '#dc9656',
27
+ '#7cafc2',
28
+ '#ba8baf',
29
+ '#a16946',
30
+ '#ab4642',
31
+ '#86c1b9',
32
+ '#a1b56c',
33
+ '#f7ca88',
34
+ ];
35
+ static colorMap = new Map();
36
+ static getColor(name) {
37
+ if (!ConsoleHandler.colorMap.has(name)) {
38
+ const nextIndex = ConsoleHandler.colorMap.size % ConsoleHandler.colors.length;
39
+ ConsoleHandler.colorMap.set(name, ConsoleHandler.colors[nextIndex]);
40
+ }
41
+ return ConsoleHandler.colorMap.get(name);
42
+ }
43
+ }
44
+ /**
45
+ * 预设的初始化行为
46
+ */
47
+ export function initLogger(logger = defaultLogger) {
48
+ logger.addHandler(new ConsoleHandler());
49
+ }
@@ -0,0 +1,16 @@
1
+ import { type default as VConsole } from 'vconsole';
2
+ export declare function registerVConsoleLib(lib: new () => VConsole): void;
3
+ /**
4
+ * 管理 VConsole 实例
5
+ */
6
+ declare global {
7
+ interface Window {
8
+ VConsole: VConsole | null;
9
+ }
10
+ }
11
+ export declare function isVConsoleEnabled(): boolean;
12
+ export declare function detectVConsole(): void;
13
+ export declare function enableVConsole(): void;
14
+ export declare function disableVConsole(): void;
15
+ export declare function runVConsole(): undefined;
16
+ export declare function destoryVConsole(): void;
@@ -0,0 +1,38 @@
1
+ /**
2
+ * 注册 VConsole 代码
3
+ * 此类库自己并不加载 VConsole,需使用者自行通过依赖或者 CDN 加载 VConsole 然后传给此类库
4
+ */
5
+ let VConsoleLib;
6
+ export function registerVConsoleLib(lib) {
7
+ VConsoleLib = lib;
8
+ }
9
+ window.VConsole = null;
10
+ export function isVConsoleEnabled() {
11
+ return localStorage.getItem('vconsole') === '1';
12
+ }
13
+ export function detectVConsole() {
14
+ if (isVConsoleEnabled()) {
15
+ runVConsole();
16
+ }
17
+ }
18
+ export function enableVConsole() {
19
+ localStorage.setItem('vconsole', '1');
20
+ runVConsole();
21
+ }
22
+ export function disableVConsole() {
23
+ localStorage.setItem('vconsole', '0');
24
+ destoryVConsole();
25
+ }
26
+ export function runVConsole() {
27
+ if (window.VConsole !== null)
28
+ return;
29
+ if (VConsoleLib === undefined)
30
+ return void console.warn('尚未传入 VConsole 对象,无法启动');
31
+ window.VConsole = new VConsoleLib();
32
+ }
33
+ export function destoryVConsole() {
34
+ if (!window.VConsole)
35
+ return;
36
+ window.VConsole.destroy();
37
+ window.VConsole = null;
38
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * 确认一个路径是否存在且是文件
3
+ */
4
+ export declare function isFileExists(filepath: string): Promise<boolean>;
5
+ /**
6
+ * 确认一个路径是否存在且是文件夹
7
+ */
8
+ export declare function isDirectoryExists(dirpath: string): Promise<boolean>;
9
+ /**
10
+ * 返回当前文件的绝对路径
11
+ * 需要传入当前文件的 ImportMeta 对象(可通过 import.meta 取得)
12
+ */
13
+ export declare function getFilePath(fileUrl: string | ImportMeta): string;
14
+ /**
15
+ * 返回文件所处目录的绝对路径
16
+ */
17
+ export declare function getFileDir(fileUrl: string | ImportMeta): string;
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Node 环境下的工具函数
3
+ */
4
+ import * as fs from 'node:fs';
5
+ import * as path from 'node:path';
6
+ import { fileURLToPath } from 'node:url';
7
+ /**
8
+ * 确认一个路径是否存在且是文件
9
+ */
10
+ export async function isFileExists(filepath) {
11
+ try {
12
+ const res = await fs.promises.stat(filepath);
13
+ return res.isFile();
14
+ }
15
+ catch (e) {
16
+ return false;
17
+ }
18
+ }
19
+ /**
20
+ * 确认一个路径是否存在且是文件夹
21
+ */
22
+ export async function isDirectoryExists(dirpath) {
23
+ try {
24
+ const res = await fs.promises.stat(dirpath);
25
+ return res.isDirectory();
26
+ }
27
+ catch (e) {
28
+ return false;
29
+ }
30
+ }
31
+ /**
32
+ * 返回当前文件的绝对路径
33
+ * 需要传入当前文件的 ImportMeta 对象(可通过 import.meta 取得)
34
+ */
35
+ export function getFilePath(fileUrl) {
36
+ if (typeof fileUrl !== 'string')
37
+ fileUrl = fileUrl.url;
38
+ return fileURLToPath(new URL(fileUrl));
39
+ }
40
+ /**
41
+ * 返回文件所处目录的绝对路径
42
+ */
43
+ export function getFileDir(fileUrl) {
44
+ return path.dirname(getFilePath(fileUrl));
45
+ }
@@ -0,0 +1,64 @@
1
+ import chalk from 'chalk';
2
+ import { type Logger, type LogInfo, LogHandler } from '../logging/index.js';
3
+ export * from '../logging/index.js';
4
+ /**
5
+ * 向 console 输出日志
6
+ */
7
+ export declare class ConsoleHandler extends LogHandler {
8
+ log(info: LogInfo): void;
9
+ static readonly consoleMethods: {
10
+ 1: {
11
+ (...data: any[]): void;
12
+ (message?: any, ...optionalParams: any[]): void;
13
+ };
14
+ 2: {
15
+ (...data: any[]): void;
16
+ (message?: any, ...optionalParams: any[]): void;
17
+ };
18
+ 3: {
19
+ (...data: any[]): void;
20
+ (message?: any, ...optionalParams: any[]): void;
21
+ };
22
+ 4: {
23
+ (...data: any[]): void;
24
+ (message?: any, ...optionalParams: any[]): void;
25
+ };
26
+ };
27
+ static readonly levelColors: {
28
+ 1: chalk.Chalk;
29
+ 2: chalk.Chalk;
30
+ 3: chalk.Chalk;
31
+ 4: chalk.Chalk;
32
+ };
33
+ private static readonly loggerColors;
34
+ private static readonly loggerColorMap;
35
+ static getLoggerColor(logger: string): "green" | "yellow" | "blue" | "magenta" | "cyan" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright";
36
+ }
37
+ /**
38
+ * 写入文件日志
39
+ */
40
+ export interface FileHandlerOptions {
41
+ dir: string;
42
+ filePrefix: string;
43
+ maxLength: number;
44
+ flushLength: number;
45
+ flushInterval: number;
46
+ }
47
+ export declare class FileHandler extends LogHandler {
48
+ readonly options: FileHandlerOptions;
49
+ constructor(options?: Partial<FileHandlerOptions>);
50
+ log(info: LogInfo): void;
51
+ protected stringifyDataItem(item: unknown): string;
52
+ private buffer;
53
+ private bufferSize;
54
+ protected pushBuffer(...strings: string[]): void;
55
+ protected flush(): void;
56
+ protected initFlush(): void;
57
+ get filepath(): string;
58
+ protected initLogDir(): void;
59
+ protected write(content: string): void;
60
+ }
61
+ /**
62
+ * 预设的初始化行为
63
+ */
64
+ export declare function initLogger(logger?: Logger): void;
@@ -0,0 +1,159 @@
1
+ /**
2
+ * 针对 Node.js 环境定制 logging
3
+ * 注意:使用此模块需要 chalk 依赖
4
+ */
5
+ import fs from 'node:fs';
6
+ import path from 'node:path';
7
+ import { fileURLToPath } from 'node:url';
8
+ import chalk from 'chalk';
9
+ import dayjs from 'dayjs';
10
+ import { logger as defaultLogger, LogLevel, LogHandler, formatters, } from '../logging/index.js';
11
+ export * from '../logging/index.js';
12
+ /**
13
+ * 向 console 输出日志
14
+ */
15
+ export class ConsoleHandler extends LogHandler {
16
+ log(info) {
17
+ const { logger, level, args } = info;
18
+ const method = ConsoleHandler.consoleMethods[level];
19
+ const levelColor = ConsoleHandler.levelColors[level];
20
+ const levelName = formatters.level(info);
21
+ const loggerColor = chalk[ConsoleHandler.getLoggerColor(logger)];
22
+ const prefix = [
23
+ chalk.white(`[${formatters.time(info)}]`),
24
+ levelColor(`[${levelName}]`),
25
+ loggerColor(`[${logger}]`),
26
+ ].join('');
27
+ method(prefix, ...args);
28
+ }
29
+ static consoleMethods = {
30
+ [LogLevel.Debug]: console.debug.bind(console),
31
+ [LogLevel.Info]: console.info.bind(console),
32
+ [LogLevel.Warning]: console.warn.bind(console),
33
+ [LogLevel.Error]: console.error.bind(console),
34
+ };
35
+ static levelColors = {
36
+ [LogLevel.Debug]: chalk.whiteBright,
37
+ [LogLevel.Info]: chalk.white,
38
+ [LogLevel.Warning]: chalk.yellowBright,
39
+ [LogLevel.Error]: chalk.redBright,
40
+ };
41
+ // 可供 logger 选择的颜色
42
+ static loggerColors = [
43
+ 'green',
44
+ 'yellow',
45
+ 'blue',
46
+ 'magenta',
47
+ 'cyan',
48
+ 'greenBright',
49
+ 'yellowBright',
50
+ 'blueBright',
51
+ 'magentaBright',
52
+ 'cyanBright',
53
+ ];
54
+ static loggerColorMap = new Map();
55
+ static getLoggerColor(logger) {
56
+ if (!ConsoleHandler.loggerColorMap.has(logger)) {
57
+ const color = ConsoleHandler.loggerColors[ConsoleHandler.loggerColorMap.size % ConsoleHandler.loggerColors.length];
58
+ ConsoleHandler.loggerColorMap.set(logger, color);
59
+ }
60
+ return ConsoleHandler.loggerColorMap.get(logger);
61
+ }
62
+ }
63
+ export class FileHandler extends LogHandler {
64
+ options;
65
+ constructor(options) {
66
+ super();
67
+ const dirname = path.dirname(fileURLToPath(new URL(import.meta.url)));
68
+ this.options = {
69
+ dir: path.resolve(dirname, 'logs'),
70
+ filePrefix: '',
71
+ maxLength: 10000,
72
+ flushLength: 100000,
73
+ flushInterval: 1000,
74
+ ...(options ?? {}),
75
+ };
76
+ this.initLogDir();
77
+ this.initFlush();
78
+ }
79
+ // Format log content
80
+ log(info) {
81
+ const { logger, args } = info;
82
+ const prefix = [
83
+ `[${formatters.datetime(info)}]`,
84
+ `[${formatters.level(info)}]`,
85
+ logger ? `[${logger}]` : '',
86
+ ].join('') + ' ';
87
+ const itemStrings = [];
88
+ let totalLength = prefix.length;
89
+ for (const item of args) {
90
+ const itemString = this.stringifyDataItem(item);
91
+ // 截断过长的日志内容 Truncate overly long log messages
92
+ if (totalLength + itemString.length < this.options.maxLength) {
93
+ itemStrings.push((totalLength === prefix.length ? '' : ' ') + itemString);
94
+ totalLength += itemString.length;
95
+ }
96
+ else {
97
+ itemStrings.push(itemString.slice(0, this.options.maxLength - totalLength) + ' [too long, sliced]');
98
+ break;
99
+ }
100
+ }
101
+ this.pushBuffer(prefix, ...itemStrings, '\n');
102
+ }
103
+ stringifyDataItem(item) {
104
+ if (typeof item === 'string')
105
+ return item;
106
+ if (item instanceof Error)
107
+ return item.stack ?? String(item);
108
+ try {
109
+ const json = JSON.stringify(item);
110
+ return json ?? String(json);
111
+ }
112
+ catch (e) {
113
+ return String(item);
114
+ }
115
+ }
116
+ // Handle buffer
117
+ buffer = [];
118
+ bufferSize = 0;
119
+ pushBuffer(...strings) {
120
+ this.buffer.push(...strings);
121
+ this.bufferSize = strings.reduce((sum, v) => sum + v.length, this.bufferSize);
122
+ if (this.options.flushInterval === 0 || this.bufferSize >= this.options.flushLength)
123
+ this.flush();
124
+ }
125
+ flush() {
126
+ if (this.buffer.length) {
127
+ const content = this.buffer.join('');
128
+ this.buffer = [];
129
+ this.bufferSize = 0;
130
+ this.write(content);
131
+ }
132
+ }
133
+ initFlush() {
134
+ if (this.options.flushInterval !== 0) {
135
+ setInterval(() => this.flush(), this.options.flushInterval);
136
+ }
137
+ }
138
+ // 文件系统交互 File system interaction
139
+ get filepath() {
140
+ const { dir, filePrefix } = this.options;
141
+ return path.join(dir, `${filePrefix ? `${filePrefix}-` : ''}${dayjs().format('YYYY-MM-DD')}.log`);
142
+ }
143
+ initLogDir() {
144
+ if (!fs.existsSync(this.options.dir))
145
+ fs.mkdirSync(this.options.dir);
146
+ }
147
+ write(content) {
148
+ fs.appendFile(this.filepath, content, error => {
149
+ if (error)
150
+ console.error('[logger] write failed: ' + String(error));
151
+ });
152
+ }
153
+ }
154
+ /**
155
+ * 预设的初始化行为
156
+ */
157
+ export function initLogger(logger = defaultLogger) {
158
+ logger.addHandler(new ConsoleHandler());
159
+ }
package/index.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export * from './lang/index.js';
2
+ export * from './url.js';
3
+ export * from './logging/index.js';
package/index.js ADDED
@@ -0,0 +1,3 @@
1
+ export * from './lang/index.js';
2
+ export * from './url.js';
3
+ export * from './logging/index.js';
@@ -0,0 +1,2 @@
1
+ import 'dayjs/locale/zh-cn.js';
2
+ export declare function initDayJs(): void;
package/init-dayjs.js ADDED
@@ -0,0 +1,7 @@
1
+ import { extend, locale } from 'dayjs';
2
+ import objectSupport from 'dayjs/plugin/objectSupport.js';
3
+ import 'dayjs/locale/zh-cn.js';
4
+ export function initDayJs() {
5
+ extend(objectSupport);
6
+ locale('zh-cn');
7
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * 异步行为相关函数
3
+ */
4
+ /**
5
+ * 返回一个指定毫秒后 resolve 的 Promise
6
+ * 若指定了 resolveValue,则 Promise 最终会解析出此值
7
+ */
8
+ declare function sleep(ms: number): Promise<void>;
9
+ declare function sleep<T>(ms: number, resolveValue: T): Promise<T>;
10
+ export { sleep };
11
+ /**
12
+ * 给 Promise 增加时限。
13
+ * - 若 silent 为 false,超时时 reject 一个 TimeoutError
14
+ * - 若 silent 为 true,则超时后,promise 永远不会 resolve 或 reject
15
+ */
16
+ export declare function timeout<T>(promise: Promise<T>, timeoutMS: number, silent?: boolean): Promise<T>;
17
+ export declare class TimeoutError extends Error {
18
+ isTimeout: boolean;
19
+ }
package/lang/async.js ADDED
@@ -0,0 +1,34 @@
1
+ /**
2
+ * 异步行为相关函数
3
+ */
4
+ async function sleep(ms, resolveValue) {
5
+ return new Promise(resolve => {
6
+ setTimeout(() => resolve(resolveValue), ms);
7
+ });
8
+ }
9
+ export { sleep };
10
+ /**
11
+ * 给 Promise 增加时限。
12
+ * - 若 silent 为 false,超时时 reject 一个 TimeoutError
13
+ * - 若 silent 为 true,则超时后,promise 永远不会 resolve 或 reject
14
+ */
15
+ export async function timeout(promise, timeoutMS, silent = false) {
16
+ return new Promise((resolve, reject) => {
17
+ let isTimeout = false;
18
+ setTimeout(() => {
19
+ isTimeout = true;
20
+ if (!silent)
21
+ reject(new TimeoutError('timeout'));
22
+ }, timeoutMS);
23
+ promise.then(result => {
24
+ if (!isTimeout)
25
+ resolve(result);
26
+ }, error => {
27
+ if (!isTimeout)
28
+ reject(error);
29
+ });
30
+ });
31
+ }
32
+ export class TimeoutError extends Error {
33
+ isTimeout = true;
34
+ }
@@ -0,0 +1,5 @@
1
+ export * from './types.js';
2
+ export * from './string.js';
3
+ export * from './object.js';
4
+ export * from './time.js';
5
+ export * from './async.js';
package/lang/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export * from './types.js';
2
+ export * from './string.js';
3
+ export * from './object.js';
4
+ export * from './time.js';
5
+ export * from './async.js';
@@ -0,0 +1,5 @@
1
+ /**
2
+ * 对两个对象进行浅比较
3
+ * 代码取自 react-addons-shallow-compare 包
4
+ */
5
+ export declare function shallowEqual(objA: unknown, objB: unknown): boolean;