starship-butler-utils 1.0.1 → 1.0.3

package/dist/config.d.mts

@@ -0,0 +1,61 @@
+import { ConfigLayerMeta, ConfigLayerMeta as ConfigLayerMeta$1, LoadConfigOptions, LoadConfigOptions as LoadConfigOptions$1, ResolvedConfig, UserInputConfig } from "c12";
+import * as rc90 from "rc9";
+
+//#region src/config.d.ts
+type RCOptions = typeof rc90.defaults;
+/**
+ * Reads the user rc file (rc file under home directory).
+ *
+ * Default rc file name is ".butlerrc".
+ *
+ * @param options Options for rc9.
+ * @returns The rc content.
+ */
+declare function readUserRc<RC extends Record<string, any>>(options?: RCOptions): RC;
+/**
+ * Writes a user rc file (rc file under home directory).
+ *
+ * Default rc file name is ".butlerrc".
+ *
+ * @param config The config to be written to rc file.
+ * @param options Options for rc9.
+ */
+declare function writeUserRc(config: any, options?: RCOptions): void;
+/**
+ * Updates a user rc file (rc file under home directory).
+ *
+ * Default rc file name is ".butlerrc".
+ *
+ * @param config The config to update the rc file.
+ * @param options Options for rc9.
+ * @returns The updated rc content.
+ */
+declare function updateUserRc(config: any, options?: RCOptions): any;
+/**
+ * Removes the user rc file (rc file under home directory).
+ *
+ * Default rc file name is ".butlerrc".
+ *
+ * @param options Options for rc9.
+ */
+declare function removeUserRc(options?: RCOptions): void;
+/**
+ * Updates or creates a user rc file (rc file under home directory).
+ *
+ * Default rc file name is ".butlerrc".
+ *
+ * @param config The config to upsert to the rc file.
+ * @param options Options for rc9.
+ */
+declare function upsertUserRc(config: any, options?: RCOptions): void;
+/**
+ * Loads the configuration using `c12`.
+ *
+ * Default config file name is "butler" and rc file loading is disabled.
+ *
+ * @param options Load config options.
+ * @returns Configuration.
+ */
+declare function loadConfig<M extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta$1 = ConfigLayerMeta$1>(options?: LoadConfigOptions$1<M, MT>): Promise<ResolvedConfig<M, MT>>;
+//#endregion
+export { type ConfigLayerMeta, type LoadConfigOptions, RCOptions, loadConfig, readUserRc, removeUserRc, updateUserRc, upsertUserRc, writeUserRc };

package/dist/config.mjs

@@ -0,0 +1,91 @@
+import { remove } from "./fs.mjs";
+import { homedir } from "./path.mjs";
+import { loadConfig as loadConfig$1 } from "c12";
+import { readUser, updateUser, writeUser } from "rc9";
+
+//#region src/config.ts
+const RC_FILE_NAME = ".butlerrc";
+/**
+* Reads the user rc file (rc file under home directory).
+*
+* Default rc file name is ".butlerrc".
+*
+* @param options Options for rc9.
+* @returns The rc content.
+*/
+function readUserRc(options) {
+	return readUser({
+		name: RC_FILE_NAME,
+		...options ?? {}
+	});
+}
+/**
+* Writes a user rc file (rc file under home directory).
+*
+* Default rc file name is ".butlerrc".
+*
+* @param config The config to be written to rc file.
+* @param options Options for rc9.
+*/
+function writeUserRc(config, options) {
+	writeUser(config, {
+		name: RC_FILE_NAME,
+		...options ?? {}
+	});
+}
+/**
+* Updates a user rc file (rc file under home directory).
+*
+* Default rc file name is ".butlerrc".
+*
+* @param config The config to update the rc file.
+* @param options Options for rc9.
+* @returns The updated rc content.
+*/
+function updateUserRc(config, options) {
+	return updateUser(config, {
+		name: RC_FILE_NAME,
+		...options ?? {}
+	});
+}
+/**
+* Removes the user rc file (rc file under home directory).
+*
+* Default rc file name is ".butlerrc".
+*
+* @param options Options for rc9.
+*/
+function removeUserRc(options) {
+	const { dir, name = RC_FILE_NAME } = options ?? {};
+	remove(homedir(dir ? `${dir}/${name}` : name));
+}
+/**
+* Updates or creates a user rc file (rc file under home directory).
+*
+* Default rc file name is ".butlerrc".
+*
+* @param config The config to upsert to the rc file.
+* @param options Options for rc9.
+*/
+function upsertUserRc(config, options) {
+	if (!readUserRc(options)) writeUserRc(config, options);
+	else updateUserRc(config, options);
+}
+/**
+* Loads the configuration using `c12`.
+*
+* Default config file name is "butler" and rc file loading is disabled.
+*
+* @param options Load config options.
+* @returns Configuration.
+*/
+function loadConfig(options) {
+	return loadConfig$1({
+		name: "butler",
+		rcFile: false,
+		...options ?? {}
+	});
+}
+
+//#endregion
+export { loadConfig, readUserRc, removeUserRc, updateUserRc, upsertUserRc, writeUserRc };

package/dist/consola-oeMzCFcY.mjs

@@ -0,0 +1,3 @@
+import { LogLevels, consola as consola_default } from "consola";
+
+export { consola_default as n, LogLevels as t };

package/dist/consola.d.mts

@@ -0,0 +1,2 @@
+import { LogLevels, consola as consola_default } from "consola";
+export { LogLevels, consola_default as default };

package/dist/consola.mjs

@@ -0,0 +1,3 @@
+import { n as consola_default, t as LogLevels } from "./consola-oeMzCFcY.mjs";
+
+export { LogLevels, consola_default as default };

package/dist/fs.d.mts

@@ -0,0 +1,74 @@
+//#region src/fs.d.ts
+/**
+ * Check if a path exists. Does not dereference symlinks.
+ *
+ * @param path The path to check.
+ * @returns Whether the path exists.
+ */
+declare function exists(path: string): boolean;
+/**
+ * Check if a path is a directory.
+ *
+ * If the path exists, we check the stats, if not, we check if the path ends
+ * with `/` or `\`.
+ *
+ * @param path The path to check.
+ * @returns Whether the path is a directory.
+ */
+declare function isDirectory(path: string): boolean;
+/**
+ * Check if a path is a symbolic link.
+ *
+ * @param path The path to check.
+ * @returns Whether the path is a symbolic link.
+ */
+declare function isSymbolicLink(path: string): boolean;
+/**
+ * Ensure a directory exists.
+ *
+ * - If the path exists but is not a directory, return false.
+ * - If the path does not exist, create the directory and get fails, return false.
+ * - Otherwise, return true.
+ *
+ * @param path The path to ensure.
+ * @returns `true` if the path is a directory and exists at the end, `false` otherwise.
+ */
+declare function ensureDirectory(path: 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 Whether the file was copied.
+ */
+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 Whether the symlink was created.
+ */
+declare function createSymlink(sourcePath: string, targetPath: string, force?: boolean): boolean;
+/**
+ * Remove a path.
+ *
+ * @param path The path to remove.
+ * @param recursive Whether to remove (directories) recursively. If `false`, removing a directory will fail with an error.
+ * @returns `true` if the file was removed, `false` otherwise.
+ */
+declare function remove(path: string, recursive?: boolean): boolean;
+/**
+ * Remove a symbolic link.
+ *
+ * If the path is not a symlink, a warning will be logged and the function will
+ * return false.
+ *
+ * @param path The path to remove.
+ * @returns `true` if the symlink was removed, `false` otherwise.
+ */
+declare function removeSymlink(path: string): boolean;
+//#endregion
+export { copyFile, createSymlink, ensureDirectory, exists, isDirectory, isSymbolicLink, remove, removeSymlink };

package/dist/fs.mjs

@@ -0,0 +1,149 @@
+import { n as consola_default } from "./consola-oeMzCFcY.mjs";
+import { a as info } from "./highlight-BQrgNBQi.mjs";
+import { constants, copyFileSync, lstatSync, mkdirSync, renameSync, rmSync, symlinkSync } from "node:fs";
+
+//#region src/fs.ts
+/**
+* Check if a path exists. Does not dereference symlinks.
+*
+* @param path The path to check.
+* @returns Whether the path exists.
+*/
+function exists(path) {
+	try {
+		if (lstatSync(path).isFile() && path.match(/\/$|\\$/)) return false;
+		else return true;
+	} catch (error) {
+		if (error instanceof Error && ["ENOENT", "ENOTDIR"].some((str) => error.message.includes(str))) return false;
+		else throw error;
+	}
+}
+/**
+* Check if a path is a directory.
+*
+* If the path exists, we check the stats, if not, we check if the path ends
+* with `/` or `\`.
+*
+* @param path The path to check.
+* @returns Whether the path is a directory.
+*/
+function isDirectory(path) {
+	if (exists(path)) return lstatSync(path).isDirectory();
+	else return (!exists(path) || lstatSync(path).isDirectory()) && path.match(/\/$|\\$/) !== null;
+}
+/**
+* Check if a path is a symbolic link.
+*
+* @param path The path to check.
+* @returns Whether the path is a symbolic link.
+*/
+function isSymbolicLink(path) {
+	return exists(path) && lstatSync(path).isSymbolicLink();
+}
+/**
+* Ensure a directory exists.
+*
+* - If the path exists but is not a directory, return false.
+* - If the path does not exist, create the directory and get fails, return false.
+* - Otherwise, return true.
+*
+* @param path The path to ensure.
+* @returns `true` if the path is a directory and exists at the end, `false` otherwise.
+*/
+function ensureDirectory(path) {
+	try {
+		if (exists(path)) return isDirectory(path);
+		else {
+			mkdirSync(path, { recursive: true });
+			return true;
+		}
+	} catch {
+		return false;
+	}
+}
+/**
+* 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 Whether the file was copied.
+*/
+function copyFile(sourcePath, targetPath, force = false) {
+	const isExist = exists(targetPath);
+	if (isExist) {
+		if (!force) {
+			consola_default.warn(`COPY: Path already exists: ${info(targetPath)}, skip`);
+			return false;
+		}
+		renameSync(targetPath, `${targetPath}.bak`);
+	}
+	try {
+		copyFileSync(sourcePath, targetPath, force ? constants.COPYFILE_FICLONE : constants.COPYFILE_EXCL);
+		if (isExist) remove(`${targetPath}.bak`);
+	} catch (error) {
+		if (isExist) renameSync(`${targetPath}.bak`, targetPath);
+		throw error;
+	}
+	return true;
+}
+/**
+* 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 Whether the symlink was created.
+*/
+function createSymlink(sourcePath, targetPath, force = false) {
+	const isExist = exists(targetPath);
+	if (isExist) {
+		if (!force) {
+			consola_default.warn(`LINK: Path already exists: ${info(targetPath)}, skip`);
+			return false;
+		}
+		renameSync(targetPath, `${targetPath}.bak`);
+	}
+	try {
+		symlinkSync(sourcePath, targetPath, "file");
+		if (isExist) remove(`${targetPath}.bak`);
+	} catch (error) {
+		if (isExist) renameSync(`${targetPath}.bak`, targetPath);
+		throw error;
+	}
+	return true;
+}
+/**
+* Remove a path.
+*
+* @param path The path to remove.
+* @param recursive Whether to remove (directories) recursively. If `false`, removing a directory will fail with an error.
+* @returns `true` if the file was removed, `false` otherwise.
+*/
+function remove(path, recursive = false) {
+	if (!exists(path)) {
+		consola_default.warn(`REMOVE: Path not exists: ${info(path)}, skip`);
+		return false;
+	}
+	rmSync(path, { recursive });
+	return true;
+}
+/**
+* Remove a symbolic link.
+*
+* If the path is not a symlink, a warning will be logged and the function will
+* return false.
+*
+* @param path The path to remove.
+* @returns `true` if the symlink was removed, `false` otherwise.
+*/
+function removeSymlink(path) {
+	if (!isSymbolicLink(path)) {
+		consola_default.warn(`REMOVE: Path is not a symlink: ${info(path)}, skip`);
+		return false;
+	}
+	return remove(path);
+}
+
+//#endregion
+export { copyFile, createSymlink, ensureDirectory, exists, isDirectory, isSymbolicLink, remove, removeSymlink };

package/dist/highlight-BQrgNBQi.mjs

@@ -0,0 +1,12 @@
+import { bold, bold as bold$1, cyan, cyan as cyan$1, green, magenta, magenta as magenta$1, red, reset } from "ansis";
+
+//#region src/highlight.ts
+function info(v) {
+	return cyan(v);
+}
+function important(v) {
+	return bold(magenta(v));
+}
+
+//#endregion
+export { info as a, reset as c, important as i, cyan$1 as n, magenta$1 as o, green as r, red as s, bold$1 as t };

package/dist/highlight.d.mts

@@ -0,0 +1,7 @@
+import { bold, cyan, green, magenta, red, reset } from "ansis";
+
+//#region src/highlight.d.ts
+declare function info(v: unknown): string;
+declare function important(v: unknown): string;
+//#endregion
+export { bold, cyan, green, important, info, magenta, red, reset };

package/dist/highlight.mjs

@@ -0,0 +1,3 @@
+import { a as info, c as reset, i as important, n as cyan, o as magenta, r as green, s as red, t as bold } from "./highlight-BQrgNBQi.mjs";
+
+export { bold, cyan, green, important, info, magenta, red, reset };

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+import { ConfigLayerMeta, LoadConfigOptions, RCOptions, loadConfig, readUserRc, removeUserRc, updateUserRc, upsertUserRc, writeUserRc } from "./config.mjs";
+import { LogLevels } from "./consola.mjs";
+import { copyFile, createSymlink, ensureDirectory, exists, isDirectory, isSymbolicLink, remove, removeSymlink } from "./fs.mjs";
+import { bold, cyan, green, important, info, magenta, red, reset } from "./highlight.mjs";
+import { appdata, basename, homedir, join, localAppdata } from "./path.mjs";
+import { n as __reExport, t as __exportAll } from "./prompts.mjs";
+export * from "@clack/prompts";
+
+//#region src/index.d.ts
+declare namespace index_d_exports {
+  export { ConfigLayerMeta, LoadConfigOptions, LogLevels, RCOptions, appdata, basename, bold, copyFile, createSymlink, cyan, ensureDirectory, exists, green, homedir, important, info, isDirectory, isSymbolicLink, join, loadConfig, localAppdata, magenta, readUserRc, red, remove, removeSymlink, removeUserRc, reset, updateUserRc, upsertUserRc, writeUserRc };
+}
+//#endregion
+export { ConfigLayerMeta, LoadConfigOptions, LogLevels, RCOptions, appdata, basename, bold, copyFile, createSymlink, cyan, ensureDirectory, exists, green, homedir, important, info, isDirectory, isSymbolicLink, join, loadConfig, localAppdata, magenta, readUserRc, red, remove, removeSymlink, removeUserRc, reset, updateUserRc, upsertUserRc, writeUserRc };

package/dist/index.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/path.d.mts

@@ -0,0 +1,39 @@
+import { basename } from "pathe";
+import * as node_path0 from "node:path";
+
+//#region src/path.d.ts
+
+/**
+ * Join all arguments together and normalize the resulting path, starting from home directory.
+ *
+ * @param paths Paths to join.
+ * @returns Joined paths.
+ * @throws {TypeError} if any of the path segments is not a string.
+ */
+declare const join: typeof node_path0.join;
+/**
+ * Join all arguments together and normalize the resulting path, starting from home directory.
+ *
+ * @param paths Paths to join.
+ * @returns Joined paths.
+ * @throws {TypeError} if any of the path segments is not a string.
+ */
+declare function homedir(...paths: string[]): string;
+/**
+ * Join all arguments together and normalize the resulting path, starting from appdata directory.
+ *
+ * @param paths Paths to join.
+ * @returns Joined paths.
+ * @throws {TypeError} if any of the path segments is not a string.
+ */
+declare function appdata(...paths: string[]): string;
+/**
+ * Join all arguments together and normalize the resulting path, starting from local appdata directory.
+ *
+ * @param paths Paths to join.
+ * @returns Joined paths.
+ * @throws {TypeError} if any of the path segments is not a string.
+ */
+declare function localAppdata(...paths: string[]): string;
+//#endregion
+export { appdata, basename, homedir, join, localAppdata };

package/dist/path.mjs

@@ -0,0 +1,46 @@
+import { homedir as homedir$1 } from "node:os";
+import process from "node:process";
+import { basename, join as join$1 } from "pathe";
+
+//#region src/path.ts
+/**
+* Join all arguments together and normalize the resulting path, starting from home directory.
+*
+* @param paths Paths to join.
+* @returns Joined paths.
+* @throws {TypeError} if any of the path segments is not a string.
+*/
+const join = join$1;
+/**
+* Join all arguments together and normalize the resulting path, starting from home directory.
+*
+* @param paths Paths to join.
+* @returns Joined paths.
+* @throws {TypeError} if any of the path segments is not a string.
+*/
+function homedir(...paths) {
+	return join(process.env.XDG_CONFIG_HOME ?? homedir$1(), ...paths);
+}
+/**
+* Join all arguments together and normalize the resulting path, starting from appdata directory.
+*
+* @param paths Paths to join.
+* @returns Joined paths.
+* @throws {TypeError} if any of the path segments is not a string.
+*/
+function appdata(...paths) {
+	return join(process.env.APPDATA, ...paths);
+}
+/**
+* Join all arguments together and normalize the resulting path, starting from local appdata directory.
+*
+* @param paths Paths to join.
+* @returns Joined paths.
+* @throws {TypeError} if any of the path segments is not a string.
+*/
+function localAppdata(...paths) {
+	return join(process.env.LOCALAPPDATA, ...paths);
+}
+
+//#endregion
+export { appdata, basename, homedir, join, localAppdata };

package/dist/prompts.d.mts

@@ -0,0 +1,6 @@
+export * from "@clack/prompts";
+
+//#region rolldown:runtime
+
+//#endregion
+export { __reExport as n, __exportAll as t };

package/dist/prompts.mjs

@@ -0,0 +1,3 @@
+export * from "@clack/prompts"
+
+export {  };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starship-butler-utils",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Utils used by starship butler.",
   "author": "Lumirelle <shabbyacc@outlook.com>",
   "license": "MIT",
@@ -19,6 +19,7 @@
   ],
   "sideEffects": false,
   "exports": {
+    ".": "./dist/index.mjs",
     "./config": "./dist/config.mjs",
     "./path": "./dist/path.mjs",
     "./fs": "./dist/fs.mjs",
@@ -26,8 +27,6 @@
     "./consola": "./dist/consola.mjs",
     "./prompts": "./dist/prompts.mjs"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "files": [
     "dist"