starship-butler-utils 0.0.1-beta.1 → 0.0.1-beta.10

package/dist/index.d.mts

@@ -1,5 +1,12 @@
 import * as ansis from 'ansis';
 
+/**
+ * Updates or creates a user rc file (rc file under home directory).
+ * @param name The name of the rc file.
+ * @param config The rc to write.
+ */
+declare function upsertUserRc(name: string, config: any): void;
+
 /**
  * Check if a file or directory exists. Does not dereference symlinks.
  * @param path - The path to check
@@ -20,10 +27,34 @@ declare function isDirectory(path: string): boolean;
  * @returns `true` if the directory is created, `false` otherwise
  */
 declare function ensureDir(dirPath: string): boolean;
-declare function createSymlink(sourcePath: string, targetPath: string, force?: boolean): Promise<boolean>;
-declare function removeSymlink(targetPath: string): boolean;
+/**
+ * Copy a file.
+ * @param sourcePath The path to the source file
+ * @param targetPath The path to the target file
+ * @param force Whether to force overwrite the target file
+ * @returns `true` if the file was copied, `false` otherwise
+ */
 declare function copyFile(sourcePath: string, targetPath: string, force?: boolean): boolean;
+/**
+ * Create a symbolic link.
+ * @param sourcePath The path to the source file
+ * @param targetPath The path to the target symlink
+ * @param force Whether to force overwrite the target symlink
+ * @returns `true` if the symlink was created, `false` otherwise
+ */
+declare function createSymlink(sourcePath: string, targetPath: string, force?: boolean): Promise<boolean>;
+/**
+ * Remove a file.
+ * @param targetPath The path to the target file
+ * @returns `true` if the file was removed, `false` otherwise
+ */
 declare function removeFile(targetPath: string): boolean;
+/**
+ * Remove a symbolic link.
+ * @param targetPath The path to the target symlink
+ * @returns `true` if the symlink was removed, `false` otherwise
+ */
+declare function removeSymlink(targetPath: string): boolean;
 
 declare const fs_copyFile: typeof copyFile;
 declare const fs_createSymlink: typeof createSymlink;
@@ -52,4 +83,4 @@ declare const highlight: {
     reset: ansis.Ansis;
 };
 
-export { fs, highlight };
+export { fs, highlight, upsertUserRc };

package/dist/index.mjs

@@ -1,8 +1,18 @@
-import { lstatSync, mkdirSync, unlinkSync, promises, copyFileSync, constants } from 'node:fs';
+import { readUser, writeUser, updateUser } from 'rc9';
+import { lstatSync, mkdirSync, renameSync, copyFileSync, constants, promises, unlinkSync } from 'node:fs';
 import { dirname } from 'node:path';
 import consola from 'consola';
 import { reset, bold, magenta, cyan, red, green } from 'ansis';
 
+function upsertUserRc(name, config) {
+  const rc = readUser(name);
+  if (!rc) {
+    writeUser(config, name);
+  } else {
+    updateUser(config, name);
+  }
+}
+
 const highlight = {
   green: (text) => {
     return green(text);
@@ -44,44 +54,52 @@ function ensureDir(dirPath) {
   }
   return false;
 }
-async function createSymlink(sourcePath, targetPath, force = false) {
-  if (existsSync(targetPath)) {
-    if (force) {
-      unlinkSync(targetPath);
-    } else {
-      consola.warn(`LINK: File already exists: ${highlight.info(targetPath)}, skip`);
+function copyFile(sourcePath, targetPath, force = false) {
+  const isExist = existsSync(targetPath);
+  if (isExist) {
+    if (!force) {
+      consola.warn(`COPY: File already exists: ${highlight.info(targetPath)}, skip`);
       return false;
+    } else {
+      renameSync(targetPath, `${targetPath}.bak`);
     }
   }
-  await promises.symlink(sourcePath, targetPath, "file");
-  return true;
-}
-function removeSymlink(targetPath) {
-  if (!existsSync(targetPath)) {
-    consola.warn(`UNLINK: Target file not found: ${highlight.info(targetPath)}, skip`);
-    return false;
-  }
-  const stats = lstatSync(targetPath);
-  if (!stats.isSymbolicLink()) {
-    consola.warn(`UNLINK: Target file is not a symlink: ${highlight.info(targetPath)}, skip`);
+  try {
+    copyFileSync(sourcePath, targetPath, force ? constants.COPYFILE_FICLONE : constants.COPYFILE_EXCL);
+    if (isExist) {
+      removeFile(`${targetPath}.bak`);
+    }
+  } catch (error) {
+    if (isExist) {
+      renameSync(`${targetPath}.bak`, targetPath);
+    }
+    consola.error(error);
     return false;
   }
-  unlinkSync(targetPath);
   return true;
 }
-function copyFile(sourcePath, targetPath, force = false) {
-  if (existsSync(targetPath)) {
+async function createSymlink(sourcePath, targetPath, force = false) {
+  const isExist = existsSync(targetPath);
+  if (isExist) {
     if (!force) {
-      consola.warn(`COPY: File already exists: ${highlight.info(targetPath)}, skip`);
+      consola.warn(`LINK: File already exists: ${highlight.info(targetPath)}, skip`);
       return false;
     } else {
-      if (lstatSync(targetPath).isSymbolicLink()) {
-        consola.debug(`Try to force override a symbolic link, will remove it first.`);
-        removeSymlink(targetPath);
-      }
+      renameSync(targetPath, `${targetPath}.bak`);
+    }
+  }
+  try {
+    await promises.symlink(sourcePath, targetPath, "file");
+    if (isExist) {
+      removeFile(`${targetPath}.bak`);
     }
+  } catch (error) {
+    if (isExist) {
+      renameSync(`${targetPath}.bak`, targetPath);
+    }
+    consola.error(error);
+    return false;
   }
-  copyFileSync(sourcePath, targetPath, force ? constants.COPYFILE_FICLONE : constants.COPYFILE_EXCL);
   return true;
 }
 function removeFile(targetPath) {
@@ -92,6 +110,15 @@ function removeFile(targetPath) {
   unlinkSync(targetPath);
   return true;
 }
+function removeSymlink(targetPath) {
+  const stats = lstatSync(targetPath);
+  if (!stats.isSymbolicLink()) {
+    consola.warn(`REMOVE: Target file is not a symlink: ${highlight.info(targetPath)}, skip`);
+    return false;
+  }
+  removeFile(targetPath);
+  return true;
+}
 
 const fs = {
   __proto__: null,
@@ -104,4 +131,4 @@ const fs = {
   removeSymlink: removeSymlink
 };
 
-export { fs, highlight };
+export { fs, highlight, upsertUserRc };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starship-butler-utils",
   "type": "module",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.10",
   "description": "Your best starship butler.",
   "author": "Lumirelle <shabbyacc@outlook.com>",
   "license": "MIT",
@@ -25,7 +25,8 @@
   ],
   "dependencies": {
     "ansis": "^4.1.0",
-    "consola": "^3.4.2"
+    "consola": "^3.4.2",
+    "rc9": "^2.1.2"
   },
   "scripts": {
     "build": "unbuild",