@yannick-z/modulo 0.2.0 → 0.3.1

package/src/tools/json.ts

@@ -1,11 +1,65 @@
-import picocolors from 'picocolors';
+import picocolors from "picocolors";
+import { readFileSync, writeFileSync } from "node:fs";
 
-export function jsonparse<T>(input: string) {
-  try {
-    if (input) {
-      return JSON.parse(input) as T;
-    }
-  } catch (e) {
-    console.error(picocolors.red(`JSON.parse failed\n${e}`));
-  }
+/**
+ * 解析 JSON 字符串
+ * @param input JSON 字符串
+ * @param defaultValue 解析失败或输入为空时的默认值（可选）
+ * @returns 解析后的对象或默认值
+ */
+export function jsonparse<T>(input: string, defaultValue?: T): T | undefined {
+	try {
+		if (input) {
+			return JSON.parse(input) as T;
+		}
+		return defaultValue;
+	} catch (e) {
+		console.error(picocolors.red(`JSON.parse failed\n${e}`));
+		return defaultValue;
+	}
+}
+
+/**
+ * 更新 JSON 文件
+ * @param path 文件路径
+ * @param updater 更新函数，接收当前数据并返回新数据
+ * @param createIfNotExist 如果文件不存在是否创建（默认 false）
+ * @returns 是否更新成功
+ */
+export function update_json_file<T = any>(
+	path: string,
+	updater: (data: T) => T,
+	createIfNotExist = false,
+): boolean {
+	try {
+		let data: T;
+		try {
+			const content = readFileSync(path, "utf-8");
+			const parsed = jsonparse<T>(content);
+			if (!parsed) {
+				if (createIfNotExist) {
+					data = {} as T;
+				} else {
+					console.error(picocolors.red(`Failed to parse JSON file: ${path}`));
+					return false;
+				}
+			} else {
+				data = parsed;
+			}
+		} catch (error: any) {
+			if (error.code === "ENOENT" && createIfNotExist) {
+				data = {} as T;
+			} else {
+				console.error(picocolors.red(`Failed to read file: ${path}`));
+				return false;
+			}
+		}
+
+		const newData = updater(data);
+		writeFileSync(path, JSON.stringify(newData, null, 2) + "\n");
+		return true;
+	} catch (e) {
+		console.error(picocolors.red(`Failed to update JSON file: ${path}\n${e}`));
+		return false;
+	}
 }

package/src/tools/log.ts

@@ -0,0 +1,58 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import picocolors from "picocolors";
+
+const logFile = path.join(process.cwd(), "modulo.debug.log");
+let index = 0;
+
+/**
+ * 调试日志函数
+ *
+ * 仅在 process.env.DEBUG 开启或 CLI 参数包含 --debug/--verbose 时输出。
+ * - --verbose: 直接输出到控制台
+ * - --debug: 输出日志文件到当前目录的 modulo.debug.log，并在控制台打印序号
+ *
+ * @param hint 日志标题或提示信息
+ * @param params 日志内容（可以是任意对象）
+ */
+export function debug_log(hint: string, ...params: unknown[]) {
+	const argv_debug = process.env.DEBUG || process.argv.includes("--debug");
+	const argv_verbose =
+		process.argv.includes("--verbose") || process.argv.includes("-v");
+
+	if (!argv_debug && !argv_verbose) {
+		return;
+	}
+
+	const timestamp = new Date().toISOString();
+	const sn = String(index++).padStart(3, "0");
+	const logEntry = `--------------\n${sn} [${timestamp}] ${hint}\n${params
+		.map((p: unknown) =>
+			typeof p === "object" ? JSON.stringify(p, null, 2) : String(p),
+		)
+		.join("\n")}\n---------------\n\n`;
+
+	if (argv_verbose) {
+		console.log(logEntry);
+	}
+
+	if (argv_debug) {
+		// 打印序列号方便debug
+		console.log(picocolors.blue(`\ndebug log ${sn}`));
+
+		fs.appendFileSync(logFile, logEntry);
+	}
+}
+
+// Logger utility
+export const logger = {
+	info: (msg: string) => console.log(picocolors.cyan(msg)),
+	success: (msg: string) => console.log(picocolors.green(msg)),
+	warn: (msg: string) => console.log(picocolors.yellow(msg)),
+	error: (msg: string) => console.log(picocolors.red(msg)),
+	debug: (msg: string) => {
+		if (process.env.DEBUG) {
+			console.log(picocolors.gray(`[DEBUG] ${msg}`));
+		}
+	},
+};

package/src/tools/merge-user-config.ts

@@ -1,21 +1,21 @@
 import { PANIC_IF } from "./panic.ts";
 
 export function merge_user_config(target: any, input: any) {
-  for (const key in input) {
-    const from = input[key];
-    const to = target[key];
-    if (typeof from !== typeof to || !(key in target)) {
-      target[key] = from;
-      continue;
-    } else {
-      if (Array.isArray(to)) {
-        PANIC_IF(!Array.isArray(from));
-        target[key] = [...to, ...from];
-      } else if (typeof to === "object") {
-        merge_user_config(to, from);
-      } else {
-        target[key] = from;
-      }
-    }
-  }
+	for (const key in input) {
+		const from = input[key];
+		const to = target[key];
+		if (typeof from !== typeof to || !(key in target)) {
+			target[key] = from;
+			continue;
+		} else {
+			if (Array.isArray(to)) {
+				PANIC_IF(!Array.isArray(from));
+				target[key] = [...to, ...from];
+			} else if (typeof to === "object") {
+				merge_user_config(to, from);
+			} else {
+				target[key] = from;
+			}
+		}
+	}
 }

package/src/tools/omit-root-path.ts

@@ -1,11 +1,21 @@
-const root_path = process.cwd();
-export function omit_root_path(path: string) {
-  // return relative path
-  return path.replace(root_path, "");
+import { relative } from "node:path";
+
+/**
+ * 获取相对于根目录的路径
+ * @param path 绝对路径
+ * @returns 相对路径（以 / 开头）
+ */
+export function omit_root_path(path: string): string {
+	const rel = relative(process.cwd(), path);
+	// 保持输出格式一致，添加前导 /
+	return rel.startsWith("/") ? rel : `/${rel}`;
 }
 
+/**
+ * 批量处理入口文件路径
+ */
 export function omit_root_path_for_entries(entries: Record<string, string>) {
-  return Object.fromEntries(
-    Object.entries(entries).map(([key, value]) => [key, omit_root_path(value)])
-  );
+	return Object.fromEntries(
+		Object.entries(entries).map(([key, value]) => [key, omit_root_path(value)]),
+	);
 }

package/src/tools/panic.ts

@@ -1,11 +1,15 @@
-import { exit } from 'node:process';
-import pc from 'picocolors';
+import { exit } from "node:process";
+import pc from "picocolors";
 
-const alert = '! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !';
+const alert = "! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !";
 
-export function PANIC_IF(status = false, msg = `SOMETHING'S WRONG`, halt = true): asserts status is false {
-  if (status) {
-    console.log(pc.bgRed(pc.white(`\n${alert}\n\n${msg}\n\n${alert}`)), '\n');
-    halt && exit(1);
-  }
+export function PANIC_IF(
+	status = false,
+	msg = `SOMETHING'S WRONG`,
+	halt = true,
+): asserts status is false {
+	if (status) {
+		console.log(pc.bgRed(pc.white(`\n${alert}\n\n${msg}\n\n${alert}`)), "\n");
+		halt && exit(1);
+	}
 }

package/src/tools/string.ts

@@ -1,3 +1,14 @@
-export function first_letter_upper(str: string) {
-  return `${str[0].toUpperCase()}${str.slice(1).toLowerCase()}`;
+/**
+ * 首字母大写，其余小写
+ * @param str 输入字符串
+ * @returns 格式化后的字符串
+ */
+export function capitalize(str: string): string {
+	if (!str) return "";
+	return `${str.charAt(0).toUpperCase()}${str.slice(1).toLowerCase()}`;
 }
+
+/**
+ * @deprecated Use capitalize instead
+ */
+export const first_letter_upper = capitalize;

package/src/type/guard.ts

@@ -1,11 +1,30 @@
+import {
+	type EnvExternalUrl,
+	type ConfigExternalUrl,
+	type ImportExternal,
+} from "../config/type.ts";
+
 export function is_string(data: unknown): data is string {
-  return typeof data === "string";
+	return typeof data === "string";
 }
 
 export function is_true_string(data: unknown): data is string {
-  return typeof data === "string" && !!data;
+	return typeof data === "string" && !!data;
 }
 
 export function is_record(data: unknown): data is Record<string, unknown> {
-  return !!data && typeof data === "object";
+	return !!data && typeof data === "object";
+}
+
+export function is_env_external(data: unknown): data is EnvExternalUrl {
+	return is_record(data) && is_string(data.dev) && is_string(data.prd);
+}
+
+export function is_url_config(data: unknown): data is ConfigExternalUrl {
+	return is_env_external(data) || is_string(data);
+}
+
+export function is_import_external(data: unknown): data is ImportExternal {
+	// 没有global的一概作为import的依赖
+	return is_record(data) && is_url_config(data.url) && !is_string(data.global);
 }

package/tsconfig.json

@@ -1,11 +1,11 @@
 {
-  "compilerOptions": {
-    "allowImportingTsExtensions": true,
-    "allowJs": true,
-    "noEmit": true,
-    "outDir": "./dist",
-    "rootDir": "./"
-  },
-  "extends": "../../tsconfig.base.json",
-  "include": ["./src/**/*", "./rslib.config.ts", "./types/*"]
+	"compilerOptions": {
+		"allowImportingTsExtensions": true,
+		"allowJs": true,
+		"noEmit": true,
+		"outDir": "./dist",
+		"rootDir": "./"
+	},
+	"extends": "../../tsconfig.base.json",
+	"include": ["./src/**/*", "./rslib.config.ts", "./types/*"]
 }