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

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT LUMIRELLE <https://github.com/lumirelle>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -1,5 +1,80 @@
 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
+ * @returns `true` if the file or directory exists, `false` otherwise
+ */
+declare function existsSync(path: string): boolean;
+/**
+ * Check if a path is a directory. If path exists, we check the stats, if not, we check if the path ends with `/` or `\`.
+ * @param path - The path to check
+ * @returns `true` if the path is a directory, `false` otherwise
+ */
+declare function isDirectory(path: string): boolean;
+/**
+ * Ensure a directory exists.
+ * If the path is not a directory, we will try to create it.
+ * If the path is a file, we will create the parent directory.
+ * @param dirPath - The path to ensure
+ * @returns `true` if the directory is created, `false` otherwise
+ */
+declare function ensureDir(dirPath: 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;
+declare const fs_ensureDir: typeof ensureDir;
+declare const fs_existsSync: typeof existsSync;
+declare const fs_isDirectory: typeof isDirectory;
+declare const fs_removeFile: typeof removeFile;
+declare const fs_removeSymlink: typeof removeSymlink;
+declare namespace fs {
+  export {
+    fs_copyFile as copyFile,
+    fs_createSymlink as createSymlink,
+    fs_ensureDir as ensureDir,
+    fs_existsSync as existsSync,
+    fs_isDirectory as isDirectory,
+    fs_removeFile as removeFile,
+    fs_removeSymlink as removeSymlink,
+  };
+}
+
 declare const highlight: {
     green: (text: string) => string;
     red: (text: string) => string;
@@ -8,4 +83,4 @@ declare const highlight: {
     reset: ansis.Ansis;
 };
 
-export { highlight };
+export { fs, highlight, upsertUserRc };

package/dist/index.mjs

@@ -1,5 +1,18 @@
+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);
@@ -16,4 +29,106 @@ const highlight = {
   reset
 };
 
-export { highlight };
+function existsSync(path) {
+  try {
+    lstatSync(path);
+    return true;
+  } catch (error) {
+    if (error instanceof Error && error.message.includes("ENOENT")) {
+      return false;
+    } else {
+      throw error;
+    }
+  }
+}
+function isDirectory(path) {
+  return existsSync(path) && lstatSync(path).isDirectory() || path.match(/\/$|\\$/) !== null;
+}
+function ensureDir(dirPath) {
+  if (!isDirectory(dirPath)) {
+    dirPath = dirname(dirPath);
+  }
+  if (!existsSync(dirPath)) {
+    mkdirSync(dirPath, { recursive: true });
+    return true;
+  }
+  return false;
+}
+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`);
+    }
+  }
+  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;
+  }
+  return true;
+}
+async function createSymlink(sourcePath, targetPath, force = false) {
+  const isExist = existsSync(targetPath);
+  if (isExist) {
+    if (!force) {
+      consola.warn(`LINK: File already exists: ${highlight.info(targetPath)}, skip`);
+      return false;
+    } else {
+      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;
+  }
+  return true;
+}
+function removeFile(targetPath) {
+  if (!existsSync(targetPath)) {
+    consola.warn(`REMOVE: Target file not found: ${highlight.info(targetPath)}, skip`);
+    return false;
+  }
+  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,
+  copyFile: copyFile,
+  createSymlink: createSymlink,
+  ensureDir: ensureDir,
+  existsSync: existsSync,
+  isDirectory: isDirectory,
+  removeFile: removeFile,
+  removeSymlink: removeSymlink
+};
+
+export { fs, highlight, upsertUserRc };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starship-butler-utils",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.1-beta.10",
   "description": "Your best starship butler.",
   "author": "Lumirelle <shabbyacc@outlook.com>",
   "license": "MIT",
@@ -23,13 +23,14 @@
   "files": [
     "dist"
   ],
+  "dependencies": {
+    "ansis": "^4.1.0",
+    "consola": "^3.4.2",
+    "rc9": "^2.1.2"
+  },
   "scripts": {
     "build": "unbuild",
     "dev": "unbuild --stub",
-    "prepublishOnly": "nr build",
     "start": "tsx src/index.ts"
-  },
-  "dependencies": {
-    "ansis": "catalog:utils/prod"
   }
-}
+}