@vlandoss/clibuddy 0.4.0 → 0.4.1-git-53b6b02.0

package/dist/index.d.mts

@@ -1,53 +1,60 @@
-import { ChalkInstance } from "chalk";
+import * as _$ansis from "ansis";
+import { hasTTY, isCI } from "std-env";
+import { PackageJson } from "pkg-types";
 import * as _$zx from "zx";
 import { Options, ProcessOutput, Shell as Shell$1 } from "zx";
-import { Project } from "@pnpm/workspace.find-packages";
-import { NormalizedPackageJson } from "read-package-up";
+import { Project } from "@pnpm/types";
 
 //#region src/colors.d.ts
-declare const colorIsSupported: () => boolean;
-declare const colorize: (hex: string) => ChalkInstance | (<T>(x: T) => T);
+declare const colorize: (hex: string) => _$ansis.Ansis;
 declare const palette: {
-  bold: ChalkInstance | (<T>(x: T) => T);
-  italic: ChalkInstance | (<T>(x: T) => T);
-  link: ChalkInstance | (<T>(x: T) => T);
-  muted: ChalkInstance | (<T>(x: T) => T);
-  primary: ChalkInstance | (<T>(x: T) => T);
+  bold: _$ansis.Ansis;
+  italic: _$ansis.Ansis;
+  link: _$ansis.Ansis;
+  muted: _$ansis.Ansis;
+  primary: _$ansis.Ansis;
+  dim: _$ansis.Ansis;
+  highlight: _$ansis.Ansis;
+  success: _$ansis.Ansis;
+  label: (s: string) => string;
 };
 //#endregion
 //#region src/meta.d.ts
 declare function dirnameOf(meta: ImportMeta): string;
 declare function filenameOf(meta: ImportMeta): string;
 //#endregion
-//#region src/run.d.ts
-declare function run(fn: () => Promise<void>, logger: {
-  error: (...args: unknown[]) => void;
-}): Promise<void>;
-//#endregion
-//#region src/services/pkg.d.ts
-declare class PkgService {
+//#region src/pkg.d.ts
+declare class Pkg {
   #private;
   get dirPath(): string;
-  get packageJson(): NormalizedPackageJson;
-  constructor(packageJson: NormalizedPackageJson, pkgPath: string);
+  get pkgPath(): string;
+  get packageJson(): PackageJson;
+  get version(): string;
+  constructor(packageJson: PackageJson, pkgPath: string);
   info(): {
-    packageJson: NormalizedPackageJson;
+    packageJson: PackageJson;
     dirPath: string;
   };
   hasFile(name: string, dir?: string): boolean;
   isMonorepo(): boolean;
   getWorkspaceProjects(): Promise<Project[]>;
+  write(packageJson: PackageJson): Promise<void>;
 }
-declare function createPkgService(cwd: string): Promise<PkgService | null>;
+declare function createPkg(cwd: string): Promise<Pkg | null>;
 //#endregion
-//#region src/services/shell/types.d.ts
+//#region src/run.d.ts
+declare function run(fn: () => Promise<void>, logger: {
+  error: (...args: unknown[]) => void;
+}): Promise<void>;
+//#endregion
+//#region src/shell/types.d.ts
 type Shell = Shell$1;
 type ShellOptions = Partial<Options>;
 type CreateOptions = ShellOptions & {
   localBaseBinPath?: string | Array<string>;
 };
 //#endregion
-//#region src/services/shell/shell.d.ts
+//#region src/shell/shell.d.ts
 declare class ShellService {
   #private;
   constructor(options: ShellOptions);
@@ -59,7 +66,7 @@ declare class ShellService {
   at(cwd: string, options?: ShellOptions): ShellService;
 }
 //#endregion
-//#region src/services/shell/create.d.ts
+//#region src/shell/create.d.ts
 declare const cwd: string;
 declare function quote(arg: string): string;
 declare const isRaw: (arg: unknown) => arg is {
@@ -67,7 +74,7 @@ declare const isRaw: (arg: unknown) => arg is {
 };
 declare function createShellService(options?: CreateOptions): ShellService;
 //#endregion
-//#region src/services/shell/utils.d.ts
+//#region src/shell/utils.d.ts
 declare function isProcessOutput(value: unknown): value is ProcessOutput;
 declare function getPreferLocal(localBaseBinPath: string | Array<string> | undefined): string[] | undefined;
 //#endregion
@@ -77,7 +84,4 @@ declare const text: {
   version: (version: string) => string;
 };
 //#endregion
-//#region src/version.d.ts
-declare function getVersion(pkg: PkgService): string;
-//#endregion
-export { CreateOptions, PkgService, type Project, Shell, ShellOptions, ShellService, colorIsSupported, colorize, createPkgService, createShellService, cwd, dirnameOf, filenameOf, getPreferLocal, getVersion, isProcessOutput, isRaw, palette, quote, run, text };
+export { CreateOptions, Pkg, type Project, Shell, ShellOptions, ShellService, colorize, createPkg, createShellService, cwd, dirnameOf, filenameOf, getPreferLocal, hasTTY, isCI, isProcessOutput, isRaw, palette, quote, run, text };

package/dist/index.mjs

@@ -1,23 +1,25 @@
-import chalk from "chalk";
-import supportsColor from "supports-color";
+import ansis, { bold, cyan, dim, green, italic, underline } from "ansis";
+import { hasTTY, isCI } from "std-env";
 import path, { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
+import fs, { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { findPackages } from "@pnpm/fs.find-packages";
+import { readPackageJSON, resolvePackageJSON, writePackageJSON } from "pkg-types";
+import { parse } from "yaml";
 import { $, ProcessOutput } from "zx";
-import fs from "node:fs";
-import { findWorkspacePackages } from "@pnpm/workspace.find-packages";
-import { readWorkspaceManifest } from "@pnpm/workspace.read-manifest";
-import { readPackageUp } from "read-package-up";
 //#region src/colors.ts
-const colorIsSupported = () => supportsColor.stdout && !process.env.NO_COLOR;
-const identity = (x) => x;
-const safe = (style) => colorIsSupported() ? style : identity;
-const colorize = (hex) => safe(chalk.hex(hex));
+const colorize = (hex) => ansis.hex(hex);
 const palette = {
-	bold: safe(chalk.bold),
-	italic: safe(chalk.italic),
-	link: safe(chalk.underline),
-	muted: colorize("#a8afb5"),
-	primary: colorize("#36d399")
+	bold,
+	italic,
+	link: underline,
+	muted: ansis.hex("#a8afb5"),
+	primary: ansis.hex("#36d399"),
+	dim,
+	highlight: cyan,
+	success: green,
+	label: (s) => ansis.bgMagenta.black(s)
 };
 //#endregion
 //#region src/meta.ts
@@ -28,44 +30,26 @@ function filenameOf(meta) {
 	return meta.filename ?? fileURLToPath(meta.url);
 }
 //#endregion
-//#region src/services/shell/utils.ts
-function isProcessOutput(value) {
-	return value instanceof ProcessOutput;
-}
-const getLocalBinPath = (dirPath) => path.join(dirPath, "node_modules", ".bin");
-function getPreferLocal(localBaseBinPath) {
-	return !localBaseBinPath ? void 0 : Array.isArray(localBaseBinPath) ? localBaseBinPath.map(getLocalBinPath) : [localBaseBinPath].map(getLocalBinPath);
-}
-//#endregion
-//#region src/run.ts
-function hasMessage(error) {
-	return typeof error === "object" && error !== null && "message" in error && typeof error.message === "string";
-}
-function formatError(error) {
-	if (hasMessage(error)) return error.message;
-	return String(error);
-}
-async function run(fn, logger) {
-	try {
-		await fn();
-	} catch (error) {
-		if (!isProcessOutput(error)) logger.error(formatError(error));
-		process.exit(1);
-	}
-}
-//#endregion
-//#region src/services/pkg.ts
-var PkgService = class {
+//#region src/pkg.ts
+var Pkg = class {
 	#packageJson;
 	#dirPath;
+	#pkgPath;
 	get dirPath() {
 		return this.#dirPath;
 	}
+	get pkgPath() {
+		return this.#pkgPath;
+	}
 	get packageJson() {
 		return this.#packageJson;
 	}
+	get version() {
+		return process.env.VERSION || this.#packageJson.version || "0.0.0";
+	}
 	constructor(packageJson, pkgPath) {
 		this.#packageJson = packageJson;
+		this.#pkgPath = pkgPath;
 		this.#dirPath = path.dirname(pkgPath);
 	}
 	info() {
@@ -75,41 +59,74 @@ var PkgService = class {
 		};
 	}
 	hasFile(name, dir) {
-		const filepath = dir ? path.join(dir, name) : this.#fromApp(name);
-		return fs.existsSync(filepath);
+		return existsSync(dir ? path.join(dir, name) : this.#fromPkgDir(name));
 	}
 	isMonorepo() {
-		return this.#packageJson.workspaces !== void 0 || this.#hasPnpmWorkspace();
+		return !!this.#packageJson.workspaces || this.#hasPnpmWorkspace();
 	}
 	async getWorkspaceProjects() {
 		let patterns;
-		if (this.#hasPnpmWorkspace()) {
-			const manifest = await readWorkspaceManifest(this.#dirPath);
-			if (!manifest) throw new Error("Can't read pnpm workspace manifest");
-			patterns = manifest.packages;
-		} else patterns = Array.isArray(this.#packageJson.workspaces) ? this.#packageJson.workspaces : this.#packageJson.workspaces?.packages ?? [];
+		if (this.#hasPnpmWorkspace()) patterns = (await this.#readPnpmWorkspaceManifest()).packages;
+		else patterns = Array.isArray(this.#packageJson.workspaces) ? this.#packageJson.workspaces : this.#packageJson.workspaces?.packages ?? [];
 		if (!Array.isArray(patterns) || patterns.some((p) => typeof p !== "string")) throw new Error("Invalid workspace patterns");
-		const projects = await findWorkspacePackages(this.#dirPath, { patterns });
+		const projects = await findPackages(this.#dirPath, { patterns });
 		const excludeRoot = (projects) => {
 			return projects.filter((project) => project.rootDir !== this.#dirPath);
 		};
 		return excludeRoot(projects);
 	}
+	async write(packageJson) {
+		await writePackageJSON(this.#pkgPath, packageJson);
+	}
 	#hasPnpmWorkspace() {
 		return this.hasFile("pnpm-workspace.yaml");
 	}
-	#fromApp(...args) {
+	async #readPnpmWorkspaceManifest() {
+		const manifest = parse(await readFile(this.#fromPkgDir("pnpm-workspace.yaml"), "utf-8"));
+		if (!manifest) throw new Error("Can't read pnpm workspace manifest");
+		return manifest;
+	}
+	#fromPkgDir(...args) {
 		return path.join(this.#dirPath, ...args);
 	}
 };
-async function createPkgService(cwd) {
-	const searchResult = await readPackageUp({ cwd });
-	if (!searchResult) return null;
-	const { packageJson, path } = searchResult;
-	return new PkgService(packageJson, path);
+async function createPkg(cwd) {
+	let pkgPath;
+	try {
+		pkgPath = await resolvePackageJSON(cwd);
+	} catch {
+		return null;
+	}
+	return new Pkg(await readPackageJSON(pkgPath), pkgPath);
 }
 //#endregion
-//#region src/services/shell/shell.ts
+//#region src/shell/utils.ts
+function isProcessOutput(value) {
+	return value instanceof ProcessOutput;
+}
+const getLocalBinPath = (dirPath) => path.join(dirPath, "node_modules", ".bin");
+function getPreferLocal(localBaseBinPath) {
+	return !localBaseBinPath ? void 0 : Array.isArray(localBaseBinPath) ? localBaseBinPath.map(getLocalBinPath) : [localBaseBinPath].map(getLocalBinPath);
+}
+//#endregion
+//#region src/run.ts
+function hasMessage(error) {
+	return typeof error === "object" && error !== null && "message" in error && typeof error.message === "string";
+}
+function formatError(error) {
+	if (hasMessage(error)) return error.message;
+	return String(error);
+}
+async function run(fn, logger) {
+	try {
+		await fn();
+	} catch (error) {
+		if (!isProcessOutput(error)) logger.error(formatError(error));
+		process.exit(1);
+	}
+}
+//#endregion
+//#region src/shell/shell.ts
 var ShellService = class ShellService {
 	#shell;
 	#options;
@@ -157,7 +174,7 @@ var ShellService = class ShellService {
 	}
 };
 //#endregion
-//#region src/services/shell/create.ts
+//#region src/shell/create.ts
 const cwd = fs.realpathSync(process.cwd());
 function quote(arg) {
 	if (/^[\w./:=@-]+$/i.test(arg) || arg === "") return arg;
@@ -185,9 +202,4 @@ const text = {
 	version: (version) => palette.muted(`v${version}`)
 };
 //#endregion
-//#region src/version.ts
-function getVersion(pkg) {
-	return process.env.VERSION || pkg.packageJson.version;
-}
-//#endregion
-export { PkgService, ShellService, colorIsSupported, colorize, createPkgService, createShellService, cwd, dirnameOf, filenameOf, getPreferLocal, getVersion, isProcessOutput, isRaw, palette, quote, run, text };
+export { Pkg, ShellService, colorize, createPkg, createShellService, cwd, dirnameOf, filenameOf, getPreferLocal, hasTTY, isCI, isProcessOutput, isRaw, palette, quote, run, text };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vlandoss/clibuddy",
-  "version": "0.4.0",
+  "version": "0.4.1-git-53b6b02.0",
   "description": "A helper library to create CLIs in Variable Land",
   "homepage": "https://github.com/variableland/dx/tree/main/packages/clibuddy#readme",
   "bugs": {
@@ -27,11 +27,12 @@
     "!src/**/*.test.*"
   ],
   "dependencies": {
-    "@pnpm/workspace.find-packages": "1000.0.62",
-    "@pnpm/workspace.read-manifest": "1000.2.10",
-    "chalk": "5.6.2",
-    "read-package-up": "12.0.0",
-    "supports-color": "10.2.2",
+    "@pnpm/fs.find-packages": "1000.0.24",
+    "@pnpm/types": "1001.3.0",
+    "ansis": "4.2.0",
+    "pkg-types": "2.3.0",
+    "std-env": "3.9.0",
+    "yaml": "2.8.4",
     "zx": "8.8.5"
   },
   "publishConfig": {

package/src/colors.ts

@@ -1,18 +1,20 @@
-import chalk, { type ChalkInstance } from "chalk";
-import supportsColor from "supports-color";
+import ansis, { bold, cyan, dim, green, italic, underline } from "ansis";
 
-// https://no-color.org/
-export const colorIsSupported = () => supportsColor.stdout && !process.env.NO_COLOR;
-
-const identity = <T>(x: T) => x;
-const safe = (style: ChalkInstance) => (colorIsSupported() ? style : identity);
-
-export const colorize = (hex: string) => safe(chalk.hex(hex));
+// hex-from-string factory; matches the previous public API.
+export const colorize = (hex: string) => ansis.hex(hex);
 
+// Curated semantic palette used across our CLIs.
 export const palette = {
-  bold: safe(chalk.bold),
-  italic: safe(chalk.italic),
-  link: safe(chalk.underline),
-  muted: colorize("#a8afb5"),
-  primary: colorize("#36d399"),
+  // structural
+  bold,
+  italic,
+  link: underline,
+  // tones
+  muted: ansis.hex("#a8afb5"),
+  primary: ansis.hex("#36d399"),
+  dim,
+  // semantic
+  highlight: cyan,
+  success: green,
+  label: (s: string) => ansis.bgMagenta.black(s),
 };

package/src/env.ts

@@ -0,0 +1 @@
+export { hasTTY, isCI } from "std-env";

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from "./colors.ts";
+export * from "./env.ts";
 export * from "./meta.ts";
+export * from "./pkg.ts";
 export * from "./run.ts";
-export * from "./services/index.ts";
+export * from "./shell/index.ts";
 export * from "./text.ts";
-export * from "./version.ts";

package/src/pkg.ts

@@ -0,0 +1,117 @@
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { findPackages } from "@pnpm/fs.find-packages";
+import type { Project } from "@pnpm/types";
+import { type PackageJson, readPackageJSON, resolvePackageJSON, writePackageJSON } from "pkg-types";
+import { parse as yamlParse } from "yaml";
+
+export type { Project };
+
+export class Pkg {
+  #packageJson: PackageJson;
+  #dirPath: string;
+  #pkgPath: string;
+
+  get dirPath() {
+    return this.#dirPath;
+  }
+
+  get pkgPath() {
+    return this.#pkgPath;
+  }
+
+  get packageJson() {
+    return this.#packageJson;
+  }
+
+  get version() {
+    return process.env.VERSION || this.#packageJson.version || "0.0.0";
+  }
+
+  constructor(packageJson: PackageJson, pkgPath: string) {
+    this.#packageJson = packageJson;
+    this.#pkgPath = pkgPath;
+    this.#dirPath = path.dirname(pkgPath);
+  }
+
+  info() {
+    return {
+      packageJson: this.#packageJson,
+      dirPath: this.#dirPath,
+    };
+  }
+
+  hasFile(name: string, dir?: string) {
+    const filepath = dir ? path.join(dir, name) : this.#fromPkgDir(name);
+    return existsSync(filepath);
+  }
+
+  isMonorepo() {
+    return !!this.#packageJson.workspaces || this.#hasPnpmWorkspace();
+  }
+
+  async getWorkspaceProjects() {
+    let patterns: string[];
+
+    if (this.#hasPnpmWorkspace()) {
+      const manifest = await this.#readPnpmWorkspaceManifest();
+      patterns = manifest.packages;
+    } else {
+      patterns = Array.isArray(this.#packageJson.workspaces)
+        ? this.#packageJson.workspaces
+        : (this.#packageJson.workspaces?.packages ?? []);
+    }
+
+    if (!Array.isArray(patterns) || patterns.some((p) => typeof p !== "string")) {
+      throw new Error("Invalid workspace patterns");
+    }
+
+    const projects = await findPackages(this.#dirPath, {
+      patterns,
+    });
+
+    const excludeRoot = (projects: Project[]) => {
+      return projects.filter((project) => project.rootDir !== this.#dirPath);
+    };
+
+    return excludeRoot(projects);
+  }
+
+  async write(packageJson: PackageJson) {
+    await writePackageJSON(this.#pkgPath, packageJson);
+  }
+
+  #hasPnpmWorkspace() {
+    return this.hasFile("pnpm-workspace.yaml");
+  }
+
+  async #readPnpmWorkspaceManifest() {
+    const manifestPath = this.#fromPkgDir("pnpm-workspace.yaml");
+    const manifestContent = await readFile(manifestPath, "utf-8");
+    const manifest = yamlParse(manifestContent);
+
+    if (!manifest) {
+      throw new Error("Can't read pnpm workspace manifest");
+    }
+
+    return manifest;
+  }
+
+  #fromPkgDir(...args: string[]) {
+    return path.join(this.#dirPath, ...args);
+  }
+}
+
+export async function createPkg(cwd: string): Promise<Pkg | null> {
+  let pkgPath: string;
+  try {
+    pkgPath = await resolvePackageJSON(cwd);
+  } catch {
+    return null;
+  }
+
+  const packageJson = await readPackageJSON(pkgPath);
+
+  return new Pkg(packageJson, pkgPath);
+}

package/src/run.ts

@@ -1,4 +1,4 @@
-import { isProcessOutput } from "./services/shell/utils.ts";
+import { isProcessOutput } from "./shell/utils.ts";
 
 function hasMessage(error: unknown): error is { message: string } {
   return (

package/src/services/index.ts

@@ -1,2 +0,0 @@
-export * from "./pkg.ts";
-export * from "./shell/index.ts";

package/src/services/pkg.ts

@@ -1,93 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { findWorkspacePackages, type Project } from "@pnpm/workspace.find-packages";
-import { readWorkspaceManifest } from "@pnpm/workspace.read-manifest";
-import { type NormalizedPackageJson, readPackageUp } from "read-package-up";
-
-export type { Project };
-
-export class PkgService {
-  #packageJson: NormalizedPackageJson;
-  #dirPath: string;
-
-  get dirPath() {
-    return this.#dirPath;
-  }
-
-  get packageJson() {
-    return this.#packageJson;
-  }
-
-  constructor(packageJson: NormalizedPackageJson, pkgPath: string) {
-    this.#packageJson = packageJson;
-    this.#dirPath = path.dirname(pkgPath);
-  }
-
-  info() {
-    return {
-      packageJson: this.#packageJson,
-      dirPath: this.#dirPath,
-    };
-  }
-
-  hasFile(name: string, dir?: string) {
-    const filepath = dir ? path.join(dir, name) : this.#fromApp(name);
-    return fs.existsSync(filepath);
-  }
-
-  isMonorepo() {
-    return this.#packageJson.workspaces !== undefined || this.#hasPnpmWorkspace();
-  }
-
-  async getWorkspaceProjects() {
-    let patterns: string[];
-
-    if (this.#hasPnpmWorkspace()) {
-      const manifest = await readWorkspaceManifest(this.#dirPath);
-
-      if (!manifest) {
-        throw new Error("Can't read pnpm workspace manifest");
-      }
-
-      patterns = manifest.packages;
-    } else {
-      patterns = Array.isArray(this.#packageJson.workspaces)
-        ? this.#packageJson.workspaces
-        : (this.#packageJson.workspaces?.packages ?? []);
-    }
-
-    if (!Array.isArray(patterns) || patterns.some((p) => typeof p !== "string")) {
-      throw new Error("Invalid workspace patterns");
-    }
-
-    const projects = await findWorkspacePackages(this.#dirPath, {
-      patterns,
-    });
-
-    const excludeRoot = (projects: Project[]) => {
-      return projects.filter((project) => project.rootDir !== this.#dirPath);
-    };
-
-    return excludeRoot(projects);
-  }
-
-  #hasPnpmWorkspace() {
-    return this.hasFile("pnpm-workspace.yaml");
-  }
-
-  #fromApp(...args: string[]) {
-    return path.join(this.#dirPath, ...args);
-  }
-}
-
-export async function createPkgService(cwd: string): Promise<PkgService | null> {
-  const searchResult = await readPackageUp({ cwd });
-
-  if (!searchResult) {
-    return null;
-  }
-
-  const { packageJson, path } = searchResult;
-
-  return new PkgService(packageJson, path);
-}

package/src/version.ts

@@ -1,5 +0,0 @@
-import type { PkgService } from "./services/index.ts";
-
-export function getVersion(pkg: PkgService) {
-  return process.env.VERSION || pkg.packageJson.version;
-}