ph-utils 0.5.0 → 0.6.0

package/lib/file.d.ts

@@ -1,14 +1,14 @@
 /**
  * 读取文件内容为JSON格式
  * @param filepath 读取的文件路径
- * @param errIsNull 读取失败时，是否返回 null，默认为 false[抛出异常]
+ * @param defaultValue 读取失败时，提供默认值, 如果不提供传参数则[抛出异常]
  *
- * @example <caption>1. 文件不存在时, 返回null，而不是 catch</caption>
+ * @example <caption>1. 文件不存在时, 默认为: null</caption>
  * await readJSON("./not-exists.json", true);
  *
  * @returns Promise<unknown>
  */
-export declare function readJSON<T>(filepath: string, errIsNull?: boolean): Promise<T>;
+export declare function readJSON<T>(filepath: string, defaultValue?: T): Promise<T>;
 /**
  * 写入 JSON 格式的数据到文件
  * @param file 待写入的文件

package/lib/file.js

@@ -4,19 +4,19 @@ import fs from "node:fs";
 /**
  * 读取文件内容为JSON格式
  * @param filepath 读取的文件路径
- * @param errIsNull 读取失败时，是否返回 null，默认为 false[抛出异常]
+ * @param defaultValue 读取失败时，提供默认值, 如果不提供传参数则[抛出异常]
  *
- * @example <caption>1. 文件不存在时, 返回null，而不是 catch</caption>
+ * @example <caption>1. 文件不存在时, 默认为: null</caption>
  * await readJSON("./not-exists.json", true);
  *
  * @returns Promise<unknown>
  */
-export function readJSON(filepath, errIsNull = false) {
+export function readJSON(filepath, defaultValue) {
     return new Promise((resolve, reject) => {
         fs.readFile(path.resolve(filepath), "utf-8", (err, data) => {
             if (err) {
-                if (errIsNull) {
-                    resolve(null);
+                if (defaultValue !== undefined) {
+                    resolve(defaultValue);
                 }
                 else {
                     reject(err);

package/lib/server.d.ts

@@ -1,32 +1,10 @@
+/// <reference types="node" />
+import type { SpawnOptions } from "node:child_process";
 /**
  * 执行命令
- * @param cmd 执行的命令
- * @returns
+ * @param command 待执行的命令
+ * @param args    命令参数
  */
-export declare function exec(cmd: string): Promise<string>;
-interface SpawnCmdOptions {
-    /** 命令运行目录 */
-    cwd?: string;
-    /** 每一行的输出 */
-    data?: (lineText?: string) => void;
-    /** 错误输出 */
-    error?: (err: Error) => void;
-    /** 最终结果 */
-    finally?: (err?: Error) => void;
-}
-/**
- * 执行 spawn 命令
- * @param command 执行的命令: 例如: git
- * @param args    命令参数: ['clone', 'https://xxxx.git']
- * @param options 参数
- */
-export declare function spawnCmd(command: string, args?: string[], options?: SpawnCmdOptions): void;
-/**
- * 执行 spawn 命令
- * @param command 执行的命令: 例如: git
- * @param args    命令参数: ['clone', 'https://xxxx.git']
- * @param options 参数
- * @returns
- */
-export declare function spawnPromise(command: string, args?: string[], options?: SpawnCmdOptions): Promise<unknown>;
-export {};
+export declare function exec(command: string, args?: string[]): Promise<string>;
+export declare function exec(command: string, options?: SpawnOptions): Promise<string>;
+export declare function exec(command: string, args?: string[], options?: SpawnOptions): Promise<string>;

package/lib/server.js

@@ -1,77 +1,52 @@
-import { exec as execCmd, spawn } from 'child_process';
-import { isBlank } from './index.js';
+import { spawn } from "node:child_process";
 /**
  * 执行命令
  * @param cmd 执行的命令
  * @returns
  */
-export function exec(cmd) {
+export function exec(command, ...params) {
     return new Promise((resolve, reject) => {
-        execCmd(cmd, (err, stdout, stderr) => {
-            if (err) {
-                reject(err);
+        let argvs = [];
+        const commandItems = command.split(" ");
+        const cmd = commandItems.shift();
+        if (commandItems.length > 0) {
+            argvs = commandItems;
+        }
+        let opts = undefined;
+        if (params[0] != null) {
+            if (params[0] instanceof Array) {
+                argvs.push(...params[0]);
+                if (params[1] != null) {
+                    opts = params[1];
+                }
             }
             else {
-                if (!isBlank(stderr) && stderr.indexOf('error') !== -1) {
-                    reject(new Error(stderr));
-                }
-                else {
-                    resolve((isBlank(stdout) ? stderr : stdout).trim());
-                }
+                opts = params[0];
             }
-        });
-    });
-}
-/**
- * 执行 spawn 命令
- * @param command 执行的命令: 例如: git
- * @param args    命令参数: ['clone', 'https://xxxx.git']
- * @param options 参数
- */
-export function spawnCmd(command, args, options) {
-    const spawnClient = spawn(command, args, { cwd: options?.cwd });
-    let err;
-    spawnClient.stdout.on('data', (chunk) => {
-        if (options?.data != null && typeof options.data === 'function') {
-            options.data(chunk);
-        }
-    });
-    spawnClient.stderr.on('error', (error) => {
-        err = error;
-        if (options?.error && typeof options.error === 'function') {
-            options.error(error);
-        }
-    });
-    spawnClient.on('error', (error) => {
-        err = error;
-        if (options?.error && typeof options.error === 'function') {
-            options.error(error);
         }
-    });
-    spawnClient.on('close', () => {
-        if (options?.finally && typeof options.finally === 'function') {
-            options.finally(err);
-        }
-    });
-}
-/**
- * 执行 spawn 命令
- * @param command 执行的命令: 例如: git
- * @param args    命令参数: ['clone', 'https://xxxx.git']
- * @param options 参数
- * @returns
- */
-export function spawnPromise(command, args, options) {
-    return new Promise((resolve, reject) => {
-        options = options || {};
-        options.finally = (err) => {
-            if (err == null) {
-                resolve(1);
+        const prs = spawn(cmd, argvs, opts);
+        let msg = [];
+        let error;
+        prs.stderr.on("data", (chunk) => {
+            msg.push(chunk.toString("utf-8"));
+        });
+        prs.stdout.on("data", (chunk) => {
+            msg.push(chunk.toString("utf-8"));
+        });
+        prs.on("error", (err) => {
+            error = err;
+        });
+        prs.on("close", (code, signal) => {
+            if (code === 0) {
+                resolve(msg.join("\n"));
             }
             else {
-                reject(err);
+                if (error == null) {
+                    error = new Error(msg[msg.length - 1]);
+                }
+                error.errno = code;
+                reject(error);
             }
-        };
-        spawnCmd(command, args, options);
+        });
     });
 }

package/package.json

@@ -52,7 +52,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.5.0",
+  "version": "0.6.0",
   "type": "module",
   "repository": {
     "type": "git",