@aztt-cli/utils 0.0.1 → 0.0.2

package/lib/index.ts

@@ -1,5 +1,121 @@
-function isObject(obj: any) {
-  return Object.prototype.toString.call(obj) === "[object Object]";
+'use strict';
+
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { Spinner } from 'cli-spinner';
+import { spawn, ChildProcess } from 'child_process';
+
+/**
+ * 判断一个值是否为对象
+ * @param o 任意值
+ * @returns 如果是对象则返回 true，否则返回 false
+ */
+function isObject(o: any): boolean {
+  return Object.prototype.toString.call(o) === '[object Object]';
+}
+
+/**
+ * 启动一个命令行 spinner
+ * @param msg spinner 显示的消息
+ * @param spinnerString spinner 的旋转字符序列
+ * @returns 返回 Spinner 实例
+ */
+function spinnerStart(msg: string, spinnerString: string = '|/-\\'): Spinner {
+  const spinner = new Spinner(`${msg} %s`);
+  spinner.setSpinnerString(spinnerString);
+  spinner.start();
+  return spinner;
+}
+
+/**
+ * 延迟指定的时间
+ * @param timeout 延迟的时间，默认为 1000 毫秒
+ * @returns 返回一个 Promise，在指定时间后 resolve
+ */
+function sleep(timeout: number = 1000): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, timeout));
+}
+
+/**
+ * 执行一个命令
+ * @param command 要执行的命令
+ * @param args 命令的参数
+ * @param options 子进程的选项
+ * @returns 返回子进程实例
+ */
+function exec(command: string, args: string[], options: any = {}): ChildProcess {
+  const win32 = process.platform === 'win32';
+
+  const cmd = win32 ? 'cmd' : command;
+  const cmdArgs = win32 ? ['/c'].concat(command, args) : args;
+
+  return spawn(cmd, cmdArgs, options);
+}
+
+/**
+ * 异步执行一个命令
+ * @param command 要执行的命令
+ * @param args 命令的参数
+ * @param options 子进程的选项
+ * @returns 返回一个 Promise，resolve 时返回退出码，reject 时返回错误
+ */
+function execAsync(command: string, args: string[], options: any = {}): Promise<number> {
+  return new Promise((resolve, reject) => {
+    const p = exec(command, args, options);
+    p.on('error', e => {
+      reject(e);
+    });
+    p.on('exit', c => {
+      resolve(c);
+    });
+  });
+}
+
+/**
+ * 读取文件内容
+ * @param path 文件路径
+ * @param options 选项，包含 toJson 属性，决定是否将内容转换为 JSON
+ * @returns 返回文件内容或 JSON 对象，如果文件不存在则返回 null
+ */
+function readFile(path: string, options: { toJson?: boolean } = {}): string | object | null {
+  if (existsSync(path)) {
+    const buffer = readFileSync(path);
+    if (buffer) {
+      if (options.toJson) {
+        return buffer.toJSON();
+      } else {
+        return buffer.toString();
+      }
+    }
+  }
+  return null;
+}
+
+/**
+ * 写入文件内容
+ * @param path 文件路径
+ * @param data 要写入的数据
+ * @param options 选项，包含 rewrite 属性，决定是否覆盖已存在的文件
+ * @returns 如果写入成功返回 true，否则返回 false
+ */
+function writeFile(path: string, data: string, { rewrite = true } = {}): boolean {
+  if (existsSync(path)) {
+    if (rewrite) {
+      writeFileSync(path, data);
+      return true;
+    }
+    return false;
+  } else {
+    writeFileSync(path, data);
+    return true;
+  }
 }
 
-export { isObject };
+export {
+  isObject,
+  spinnerStart,
+  sleep,
+  exec,
+  execAsync,
+  readFile,
+  writeFile,
+};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@aztt-cli/utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "description": "> TODO: description",
   "author": "za990326 <956267437@qq.com>",
   "homepage": "",
   "license": "ISC",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
@@ -23,9 +24,10 @@
     "build": "tsc --watch"
   },
   "dependencies": {
-    "@aztt-cli/utils": "file:"
+    "cli-spinner": "^0.2.10"
   },
   "devDependencies": {
+    "@types/cli-spinner": "^0.2.3",
     "typescript": "^5.7.3"
   }
 }