@xiping/node-utils 1.0.61 → 1.0.62

package/README.md

@@ -0,0 +1,45 @@
+# @xiping/node-utils
+
+Node.js 通用工具库，提供目录树、路径、SRT→VTT 字幕转换、FFmpeg 视频处理、文件信息与图片处理等能力。
+
+```bash
+npm install @xiping/node-utils
+```
+
+## 使用案例
+
+```typescript
+import {
+  buildDirectoryTree,
+  getParentDirectory,
+  convertSrtFileToVttFile,
+  getVideoInfo,
+  getThumbnail,
+  getFileConfig,
+  convertImage,
+  checkFFmpegAvailability,
+} from '@xiping/node-utils';
+
+// 目录树
+const tree = buildDirectoryTree('/path/to/dir');
+
+// 路径
+const parent = getParentDirectory('/Users/documents/folder');
+
+// SRT 转 VTT
+convertSrtFileToVttFile('/path/to/subtitle.srt');
+
+// 视频信息与缩略图（需系统安装 ffmpeg）
+if (checkFFmpegAvailability()) {
+  const info = getVideoInfo('/path/to/video.mp4');
+  const thumb = await getThumbnail('/path/to/video.mp4', { frames: 30 });
+}
+
+// 文件配置（含视频元数据）
+const config = getFileConfig('/path/to/file.mp4');
+
+// 图片格式转换
+await convertImage(inputPath, outputPath, 'webp', { quality: 80 });
+```
+
+更多说明见 [src/ffmpeg/README.md](./src/ffmpeg/README.md)、[src/image/README.md](./src/image/README.md)、[src/srt-to-vtt/README.md](./src/srt-to-vtt/README.md)。

package/lib/src/ffmpeg/README.md

@@ -18,8 +18,7 @@
 
 ### 依赖包
 
-- Node.js
-- [shelljs](https://www.npmjs.com/package/shelljs)
+- Node.js（使用内置 `child_process.spawnSync` 调用 ffmpeg/ffprobe，兼容 Electron、跨平台）
 - [sharp](https://www.npmjs.com/package/sharp)（仅缩略图功能需要）
 
 ### 系统要求

package/lib/src/ffmpeg/check.js

@@ -1,7 +1,7 @@
-import shell from "shelljs";
+import { runSync } from "./runSync.js";
 // 检查 ffmpeg 可用性
 export function checkFFmpegAvailability() {
-    const result = shell.exec('ffmpeg -version', { silent: true });
+    const result = runSync("ffmpeg", ["-version"]);
     return result.code === 0;
 }
 /**
@@ -9,6 +9,6 @@ export function checkFFmpegAvailability() {
  * @returns 是否可用
  */
 export function isFfprobeAvailable() {
-    const result = shell.exec("ffprobe -version", { silent: true });
+    const result = runSync("ffprobe", ["-version"]);
     return result.code === 0;
 }

package/lib/src/ffmpeg/cutVideo.js

@@ -1,5 +1,5 @@
-import shell from "shelljs";
 import * as fs from "fs";
+import { runSync } from "./runSync.js";
 import * as path from "node:path";
 import * as os from "node:os";
 import { checkFFmpegAvailability } from "./check.js";
@@ -40,7 +40,12 @@ function normalizeTimeFormat(time) {
 // 获取视频时长
 function getDurationInSeconds(videoPath) {
     log('Getting video duration', { videoPath });
-    const result = shell.exec(`ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 "${videoPath}"`, { silent: true });
+    const result = runSync("ffprobe", [
+        "-v", "error",
+        "-show_entries", "format=duration",
+        "-of", "default=noprint_wrappers=1:nokey=1",
+        videoPath,
+    ]);
     if (result.code !== 0) {
         throw new Error(`FFprobe failed to get duration: ${result.stderr}`);
     }
@@ -104,20 +109,6 @@ function timeToSeconds(timeStr) {
     }
     throw new Error(`Invalid time format: ${timeStr}`);
 }
-// 构建 FFmpeg 命令
-function buildFFmpegCommand(inputPath, outputPath, startTime, duration, options) {
-    const { overwrite = false } = options;
-    // 使用 copy 模式，保持原视频编码和质量
-    let command = `ffmpeg -ss ${startTime} -i "${inputPath}" -t ${duration}`;
-    // 复制视频和音频流，不重新编码
-    command += ' -c copy';
-    // 其他设置
-    command += ' -avoid_negative_ts make_zero';
-    command += ' -y'; // 自动覆盖输出文件
-    // 输出文件
-    command += ` "${outputPath}"`;
-    return command;
-}
 // 临时目录管理
 async function withTempDir(fn, customTempDir) {
     const tempDir = customTempDir || fs.mkdtempSync(path.join(os.tmpdir(), "video-cut-"));
@@ -169,11 +160,16 @@ export const cutVideo = async (videoPath, options = {}) => {
         // 使用临时目录处理
         await withTempDir(async (tempDir) => {
             const tempOutputPath = path.join(tempDir, `temp_output.${outputFormat}`);
-            // 构建 FFmpeg 命令
-            const command = buildFFmpegCommand(validatedPath, tempOutputPath, timeParams.startTime, timeParams.duration, options);
-            log('Executing FFmpeg command', { command });
-            // 执行 FFmpeg 命令
-            const result = shell.exec(command, { silent: true });
+            log('Executing FFmpeg command', { startTime: timeParams.startTime, duration: timeParams.duration });
+            const result = runSync("ffmpeg", [
+                "-ss", timeParams.startTime,
+                "-i", validatedPath,
+                "-t", timeParams.duration,
+                "-c", "copy",
+                "-avoid_negative_ts", "make_zero",
+                "-y",
+                tempOutputPath,
+            ]);
             if (result.code !== 0) {
                 throw new Error(`FFmpeg failed: ${result.stderr}`);
             }

package/lib/src/ffmpeg/extractAudio.js

@@ -1,5 +1,5 @@
-import shell from "shelljs";
 import { spawn } from "node:child_process";
+import { runSync } from "./runSync.js";
 import * as fs from "node:fs";
 import * as path from "node:path";
 import * as os from "node:os";
@@ -18,7 +18,12 @@ function validateAndSanitizePath(inputPath) {
     return inputPath;
 }
 function getDurationInSeconds(videoPath) {
-    const result = shell.exec(`ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 "${videoPath}"`, { silent: true });
+    const result = runSync("ffprobe", [
+        "-v", "error",
+        "-show_entries", "format=duration",
+        "-of", "default=noprint_wrappers=1:nokey=1",
+        videoPath,
+    ]);
     if (result.code !== 0) {
         throw new Error(`FFprobe failed to get duration: ${result.stderr}`);
     }
@@ -57,13 +62,12 @@ function buildFfmpegArgs(outputPath, outputFormat, copyStream, audioCodec) {
     args.push("-y", outputPath);
     return args;
 }
-/** 执行 ffmpeg（shell.exec），无进度 */
+/** 执行 ffmpeg（runSync），无进度 */
 function runFfmpegSync(inputPath, outputPath, outputFormat, copyStream, audioCodec) {
     const args = buildFfmpegArgs(outputPath, outputFormat, copyStream, audioCodec);
     args[1] = inputPath;
-    const command = `ffmpeg ${args.map((a) => (a.includes(" ") ? `"${a}"` : a)).join(" ")}`;
-    log("Executing FFmpeg command", { command });
-    const result = shell.exec(command, { silent: true });
+    log("Executing FFmpeg command", { inputPath, outputPath });
+    const result = runSync("ffmpeg", args);
     if (result.code !== 0) {
         throw new Error(`FFmpeg failed: ${result.stderr}`);
     }

package/lib/src/ffmpeg/getThumbnail.js

@@ -1,5 +1,5 @@
-import shell from "shelljs";
 import Sharp from "sharp";
+import { runSync } from "./runSync.js";
 import * as fs from "fs";
 import * as path from "node:path";
 import * as os from "node:os";
@@ -22,7 +22,12 @@ function validateAndSanitizePath(inputPath) {
 // 获取视频时长
 function getDurationInSeconds(videoPath) {
     log('Getting video duration', { videoPath });
-    const result = shell.exec(`ffprobe -v error -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 "${videoPath}"`, { silent: true });
+    const result = runSync("ffprobe", [
+        "-v", "error",
+        "-show_entries", "format=duration",
+        "-of", "default=noprint_wrappers=1:nokey=1",
+        videoPath,
+    ]);
     if (result.code !== 0) {
         throw new Error(`FFprobe failed to get duration: ${result.stderr}`);
     }
@@ -40,7 +45,15 @@ async function extractFrames(videoPath, tempDir, frames, interval, maxConcurrenc
         const t = interval * i;
         const framePath = path.join(tempDir, `frame-${t}.jpg`);
         return new Promise((resolve, reject) => {
-            const result = shell.exec(`ffmpeg -ss ${t} -i "${videoPath}" -vframes 1 -q:v 10 -an -threads 4 "${framePath}"`, { silent: true });
+            const result = runSync("ffmpeg", [
+                "-ss", String(t),
+                "-i", videoPath,
+                "-vframes", "1",
+                "-q:v", "10",
+                "-an",
+                "-threads", "4",
+                framePath,
+            ]);
             if (result.code === 0) {
                 log(`Frame ${i + 1}/${total} extracted`, { time: t });
                 resolve();

package/lib/src/ffmpeg/getVideoInfo.js

@@ -1,4 +1,5 @@
-import shell from "shelljs";
+import * as fs from "node:fs";
+import { runSync } from "./runSync.js";
 /**
  * 格式化文件大小
  * @param bytes 字节数
@@ -32,12 +33,16 @@ function formatDuration(seconds) {
  * @returns 视频信息对象
  */
 export function getVideoInfo(videoPath) {
-    // 检查文件是否存在
-    if (!shell.test("-f", videoPath)) {
+    if (!fs.existsSync(videoPath)) {
         throw new Error(`视频文件不存在: ${videoPath}`);
     }
-    // 使用 ffprobe 获取 JSON 格式的视频信息
-    const result = shell.exec(`ffprobe -v quiet -print_format json -show_format -show_streams "${videoPath}"`, { silent: true });
+    const result = runSync("ffprobe", [
+        "-v", "quiet",
+        "-print_format", "json",
+        "-show_format",
+        "-show_streams",
+        videoPath,
+    ]);
     if (result.code !== 0) {
         throw new Error(`获取视频信息失败: ${result.stderr}`);
     }
@@ -98,10 +103,18 @@ export function getMultipleVideoInfo(videoPaths) {
  * @returns 详细的视频信息
  */
 export function getDetailedVideoInfo(videoPath) {
-    if (!shell.test("-f", videoPath)) {
+    if (!fs.existsSync(videoPath)) {
         throw new Error(`视频文件不存在: ${videoPath}`);
     }
-    const result = shell.exec(`ffprobe -v quiet -print_format json -show_format -show_streams -show_chapters -show_private_data "${videoPath}"`, { silent: true });
+    const result = runSync("ffprobe", [
+        "-v", "quiet",
+        "-print_format", "json",
+        "-show_format",
+        "-show_streams",
+        "-show_chapters",
+        "-show_private_data",
+        videoPath,
+    ]);
     if (result.code !== 0) {
         throw new Error(`获取详细视频信息失败: ${result.stderr}`);
     }

package/lib/src/ffmpeg/runSync.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 同步执行外部命令（跨平台、兼容 Electron，不依赖 shell）。
+ * 使用 spawnSync + 参数数组，避免 shell 解析和路径/空格问题。
+ *
+ * @param command 可执行文件名（如 ffmpeg、ffprobe）
+ * @param args 参数列表（路径无需额外引号）
+ * @returns 与 shelljs.exec 兼容的 { code, stdout, stderr }
+ */
+export declare function runSync(command: string, args: string[], options?: {
+    encoding?: BufferEncoding;
+}): {
+    code: number;
+    stdout: string;
+    stderr: string;
+};

package/lib/src/ffmpeg/runSync.js

@@ -0,0 +1,20 @@
+import { spawnSync } from "node:child_process";
+/**
+ * 同步执行外部命令（跨平台、兼容 Electron，不依赖 shell）。
+ * 使用 spawnSync + 参数数组，避免 shell 解析和路径/空格问题。
+ *
+ * @param command 可执行文件名（如 ffmpeg、ffprobe）
+ * @param args 参数列表（路径无需额外引号）
+ * @returns 与 shelljs.exec 兼容的 { code, stdout, stderr }
+ */
+export function runSync(command, args, options) {
+    const encoding = options?.encoding ?? "utf8";
+    const result = spawnSync(command, args, {
+        encoding,
+        windowsHide: true,
+    });
+    const stdout = (result.stdout ?? "");
+    const stderr = (result.stderr ?? "");
+    const code = result.status ?? (result.signal ? -1 : 0);
+    return { code, stdout, stderr };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiping/node-utils",
-  "version": "1.0.61",
+  "version": "1.0.62",
   "description": "node-utils",
   "type": "module",
   "author": "The-End-Hero <527409987@qq.com>",
@@ -16,16 +16,16 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/The-End-Hero/wang-ping.git"
+    "url": "git+https://github.com/The-End-Hero/xiping.git"
   },
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1",
     "build": "tsc && node scripts/copy-readmes.js"
   },
   "bugs": {
-    "url": "https://github.com/The-End-Hero/wang-ping/issues"
+    "url": "https://github.com/The-End-Hero/xiping/issues"
   },
-  "gitHead": "6cb2ac8c64a780abb18ec793978d3adfff71fba7",
+  "gitHead": "83ac9cffc81c4bbd5b78e1ecf621029630c98c20",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -33,14 +33,12 @@
   "dependencies": {
     "@xiping/subtitle": "1.0.52",
     "chalk": "^5.6.2",
-    "fs-extra": "^11.3.3",
-    "sharp": "^0.34.4",
-    "shelljs": "0.10.0",
+    "sharp": "^0.34.5",
     "srt-parser-2": "^1.2.3"
   },
   "devDependencies": {
-    "@types/node": "^24.10.4",
+    "@types/node": "^24.10.13",
     "tslib": "^2.8.1",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   }
 }