ph-utils 0.13.1 → 0.14.0

package/lib/config.d.ts

@@ -0,0 +1,33 @@
+/** 配置信息 */
+export declare let config: Record<string, any>;
+/**
+ * 解析环境变量;
+ * 同时读取多个环境变量文件: .env, .env.local, .env.[development|test|production];
+ * 根据运行环境变量 `NODE_ENV` 读取不同的环境变量文件;
+ * 同时支持手动通过运行命令指定 `NODE_ENV` 值, 不指定默认为: production
+ *
+ * ```bash
+ * node test.js --NODE_ENV development
+ * // or
+ * node test.js -n development
+ * ```
+ *
+ * ```js
+ * // test.js
+ * parseEnvs();
+ * ```
+ *
+ * @returns
+ */
+export declare function parseEnv(envFiles?: string[]): Record<string, string>;
+/**
+ * 解析配置文件并合并内容。
+ *
+ * @param files - 要解析的配置文件列表，默认为 ["config.json", "config.local.json"]。
+ * @param runParseEnv - 是否运行环境变量解析，默认为 true。
+ * @returns 合并后的配置对象。
+ *
+ * 该函数会根据当前环境加载相应的配置文件，并将其内容合并到最终的配置对象中。
+ * 如果指定的文件列表中不包含环境特定的配置文件，则会自动添加。
+ */
+export declare function parseConfig(files?: string[], runParseEnv?: boolean): Record<string, any>;

package/lib/config.js

@@ -0,0 +1,99 @@
+import { parseEnv as readEnv, parseArgs } from "node:util";
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+/** 配置信息 */
+export let config = {};
+/**
+ * 解析环境变量;
+ * 同时读取多个环境变量文件: .env, .env.local, .env.[development|test|production];
+ * 根据运行环境变量 `NODE_ENV` 读取不同的环境变量文件;
+ * 同时支持手动通过运行命令指定 `NODE_ENV` 值, 不指定默认为: production
+ *
+ * ```bash
+ * node test.js --NODE_ENV development
+ * // or
+ * node test.js -n development
+ * ```
+ *
+ * ```js
+ * // test.js
+ * parseEnvs();
+ * ```
+ *
+ * @returns
+ */
+export function parseEnv(envFiles = [".env", ".env.local"]) {
+    // development, test, production
+    const files = [...envFiles];
+    let nodeEnv = process.env.NODE_ENV;
+    const { values } = parseArgs({
+        options: {
+            NODE_ENV: {
+                type: "string",
+                short: "n",
+            },
+        },
+        strict: false,
+    });
+    if (values.NODE_ENV != null && typeof values.NODE_ENV === "string") {
+        nodeEnv = values.NODE_ENV;
+    }
+    if (nodeEnv == null) {
+        nodeEnv = "production";
+    }
+    process.env.NODE_ENV = nodeEnv;
+    const envFile = `.env.${nodeEnv}`;
+    if (!files.includes(envFile)) {
+        files.push(envFile);
+    }
+    let envParsed = {};
+    for (let i = 0, len = files.length; i < len; i++) {
+        const file = join(process.cwd(), files[i]);
+        try {
+            const envContent = readFileSync(file, {
+                encoding: "utf-8",
+            });
+            const envValue = readEnv(envContent);
+            for (const key in envValue) {
+                process.env[key] = envValue[key];
+                envParsed[key] = envValue[key];
+            }
+            // eslint-disable-next-line
+        }
+        catch (err) { }
+    }
+    return envParsed;
+}
+/**
+ * 解析配置文件并合并内容。
+ *
+ * @param files - 要解析的配置文件列表，默认为 ["config.json", "config.local.json"]。
+ * @param runParseEnv - 是否运行环境变量解析，默认为 true。
+ * @returns 合并后的配置对象。
+ *
+ * 该函数会根据当前环境加载相应的配置文件，并将其内容合并到最终的配置对象中。
+ * 如果指定的文件列表中不包含环境特定的配置文件，则会自动添加。
+ */
+export function parseConfig(files = ["config.json", "config.local.json"], runParseEnv = true) {
+    let d = [...files];
+    if (runParseEnv) {
+        parseEnv();
+    }
+    const envConfigPath = `config.${process.env.NODE_ENV}.json`;
+    if (!d.includes(envConfigPath)) {
+        d.push(envConfigPath);
+    }
+    for (let i = 0, len = d.length; i < len; i++) {
+        const filePath = join(process.cwd(), d[i]);
+        try {
+            const content = readFileSync(filePath, {
+                encoding: "utf-8",
+            });
+            let contentJson = JSON.parse(content);
+            config = { ...config, ...contentJson };
+            // eslint-disable-next-line
+        }
+        catch (err) { }
+    }
+    return config;
+}

package/lib/dom.d.ts

@@ -21,7 +21,7 @@ export declare function $(selector: string | HTMLElement, dom?: DocumentContext)
 /**
  * 创建一个 HTML 元素，支持通过标签名或 HTML 字符串创建。
  * @param tag - 元素标签名或 HTML 字符串。
- * @param option - 元素的属性、样式、文本内容等配置。
+ * @param option - 元素的属性、样式、文本内容等配置。所有不是指定的属性，都会通过 setAttribute 设置
  * @param ctx - 元素的父级文档上下文。
  * @returns 创建的 HTML 元素。
  */

package/lib/dom.js

@@ -18,7 +18,7 @@ export function $(selector, dom) {
 /**
  * 创建一个 HTML 元素，支持通过标签名或 HTML 字符串创建。
  * @param tag - 元素标签名或 HTML 字符串。
- * @param option - 元素的属性、样式、文本内容等配置。
+ * @param option - 元素的属性、样式、文本内容等配置。所有不是指定的属性，都会通过 setAttribute 设置
  * @param ctx - 元素的父级文档上下文。
  * @returns 创建的 HTML 元素。
  */

package/lib/server.d.ts

@@ -16,23 +16,3 @@ export declare function exec(command: string, args?: string[], options?: SpawnOp
     stdout: string;
     stderr: string;
 }>;
-/**
- * 解析环境变量;
- * 同时读取多个环境变量文件: .env, .env.local, .env.[development|test|production];
- * 根据运行环境变量 `NODE_ENV` 读取不同的环境变量文件;
- * 同时支持手动通过运行命令指定 `NODE_ENV` 值, 不指定默认为: production
- *
- * ```bash
- * node test.js --NODE_ENV development
- * // or
- * node test.js -n development
- * ```
- *
- * ```js
- * // test.js
- * parseEnvs();
- * ```
- *
- * @returns
- */
-export declare function parseEnvs(): Record<string, string>;

package/lib/server.js

@@ -1,6 +1,5 @@
 import { execFile } from "node:child_process";
-import { parseEnv, parseArgs, promisify } from "node:util";
-import { readFileSync } from "node:fs";
+import { promisify } from "node:util";
 const execFilePromise = promisify(execFile);
 /**
  * 执行命令
@@ -28,59 +27,3 @@ export function exec(command, ...params) {
     }
     return execFilePromise(cmd, argvs, opts);
 }
-/**
- * 解析环境变量;
- * 同时读取多个环境变量文件: .env, .env.local, .env.[development|test|production];
- * 根据运行环境变量 `NODE_ENV` 读取不同的环境变量文件;
- * 同时支持手动通过运行命令指定 `NODE_ENV` 值, 不指定默认为: production
- *
- * ```bash
- * node test.js --NODE_ENV development
- * // or
- * node test.js -n development
- * ```
- *
- * ```js
- * // test.js
- * parseEnvs();
- * ```
- *
- * @returns
- */
-export function parseEnvs() {
-    // development, test, production
-    const files = [".env", ".env.local"];
-    let nodeEnv = process.env.NODE_ENV;
-    const { values } = parseArgs({
-        options: {
-            NODE_ENV: {
-                type: "string",
-                short: "n",
-            },
-        },
-        strict: false,
-    });
-    if (values.NODE_ENV != null && typeof values.NODE_ENV === "string") {
-        nodeEnv = values.NODE_ENV;
-    }
-    if (nodeEnv == null) {
-        nodeEnv = "production";
-    }
-    process.env.NODE_ENV = nodeEnv;
-    files.push(`.env.${nodeEnv}`);
-    let envParsed = {};
-    for (let i = 0, len = files.length; i < len; i++) {
-        const file = files[i];
-        try {
-            const envContent = readFileSync(file, { encoding: "utf-8" });
-            const envValue = parseEnv(envContent);
-            envParsed = { ...envParsed, ...envValue };
-            // eslint-disable-next-line
-        }
-        catch (err) { }
-    }
-    for (const key in envParsed) {
-        process.env[key] = envParsed[key];
-    }
-    return envParsed;
-}

package/package.json

@@ -68,7 +68,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.13.1",
+  "version": "0.14.0",
   "type": "module",
   "repository": {
     "type": "git",