@visulima/package 4.0.1 → 4.1.0

package/dist/packem_shared/package-json-CiMqtMwD.d.ts

@@ -0,0 +1,232 @@
+import { WriteJsonOptions } from '@visulima/fs';
+import { PackageJson as PackageJson$1, Paths, JsonObject } from 'type-fest';
+import { InstallPackageOptions } from '@antfu/install-pkg';
+import { Package } from 'normalize-package-data';
+
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PartialDeep<T> = T extends object ? {
+    [P in keyof T]?: PartialDeep<T[P]>;
+} : T;
+
+/**
+ * Union type representing the possible statuses of a prompt.
+ *
+ * -   `'loading'`: The prompt is currently loading.
+ * -   `'idle'`: The prompt is loaded and currently waiting for the user to
+ *     submit an answer.
+ * -   `'done'`: The user has submitted an answer and the prompt is finished.
+ * -   `string`: Any other string: The prompt is in a custom state.
+ */
+type Status = 'loading' | 'idle' | 'done' | (string & {});
+type DefaultTheme = {
+    /**
+     * Prefix to prepend to the message. If a function is provided, it will be
+     * called with the current status of the prompt, and the return value will be
+     * used as the prefix.
+     *
+     * @remarks
+     * If `status === 'loading'`, this property is ignored and the spinner (styled
+     * by the `spinner` property) will be displayed instead.
+     *
+     * @defaultValue
+     * ```ts
+     * // import colors from 'yoctocolors-cjs';
+     * (status) => status === 'done' ? colors.green('✔') : colors.blue('?')
+     * ```
+     */
+    prefix: string | Prettify<Omit<Record<Status, string>, 'loading'>>;
+    /**
+     * Configuration for the spinner that is displayed when the prompt is in the
+     * `'loading'` state.
+     *
+     * We recommend the use of {@link https://github.com/sindresorhus/cli-spinners|cli-spinners} for a list of available spinners.
+     */
+    spinner: {
+        /**
+         * The time interval between frames, in milliseconds.
+         *
+         * @defaultValue
+         * ```ts
+         * 80
+         * ```
+         */
+        interval: number;
+        /**
+         * A list of frames to show for the spinner.
+         *
+         * @defaultValue
+         * ```ts
+         * ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+         * ```
+         */
+        frames: string[];
+    };
+    /**
+     * Object containing functions to style different parts of the prompt.
+     */
+    style: {
+        /**
+         * Style to apply to the user's answer once it has been submitted.
+         *
+         * @param text - The user's answer.
+         * @returns The styled answer.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.cyan(text)
+         * ```
+         */
+        answer: (text: string) => string;
+        /**
+         * Style to apply to the message displayed to the user.
+         *
+         * @param text - The message to style.
+         * @param status - The current status of the prompt.
+         * @returns The styled message.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text, status) => colors.bold(text)
+         * ```
+         */
+        message: (text: string, status: Status) => string;
+        /**
+         * Style to apply to error messages.
+         *
+         * @param text - The error message.
+         * @returns The styled error message.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.red(`> ${text}`)
+         * ```
+         */
+        error: (text: string) => string;
+        /**
+         * Style to apply to the default answer when one is provided.
+         *
+         * @param text - The default answer.
+         * @returns The styled default answer.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.dim(`(${text})`)
+         * ```
+         */
+        defaultAnswer: (text: string) => string;
+        /**
+         * Style to apply to help text.
+         *
+         * @param text - The help text.
+         * @returns The styled help text.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.dim(text)
+         * ```
+         */
+        help: (text: string) => string;
+        /**
+         * Style to apply to highlighted text.
+         *
+         * @param text - The text to highlight.
+         * @returns The highlighted text.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.cyan(text)
+         * ```
+         */
+        highlight: (text: string) => string;
+        /**
+         * Style to apply to keyboard keys referred to in help texts.
+         *
+         * @param text - The key to style.
+         * @returns The styled key.
+         *
+         * @defaultValue
+         * ```ts
+         * // import colors from 'yoctocolors-cjs';
+         * (text) => colors.cyan(colors.bold(`<${text}>`))
+         * ```
+         */
+        key: (text: string) => string;
+    };
+};
+type Theme<Extension extends object = object> = Prettify<Extension & DefaultTheme>;
+
+type NormalizedPackageJson = Package & PackageJson;
+type PackageJson = PackageJson$1;
+type Cache<T = any> = Map<string, T>;
+type EnsurePackagesOptions = {
+    confirm?: {
+        default?: boolean;
+        message: string | ((packages: string[]) => string);
+        theme?: PartialDeep<Theme>;
+        transformer?: (value: boolean) => string;
+    };
+    cwd?: URL | string;
+    deps?: boolean;
+    devDeps?: boolean;
+    installPackage?: Omit<InstallPackageOptions, "cwd" | "dev">;
+    logger?: {
+        warn: (message: string) => void;
+    };
+    peerDeps?: boolean;
+    throwOnWarn?: boolean;
+};
+
+type ReadOptions = {
+    cache?: FindPackageJsonCache | boolean;
+    ignoreWarnings?: (RegExp | string)[];
+    json5?: boolean;
+    resolveCatalogs?: boolean;
+    strict?: boolean;
+    yaml?: boolean;
+};
+type FindPackageJsonCache = Cache<NormalizedReadResult>;
+type NormalizedReadResult = {
+    packageJson: NormalizedPackageJson;
+    path: string;
+};
+declare const findPackageJson: (cwd?: URL | string, options?: ReadOptions) => Promise<NormalizedReadResult>;
+declare const findPackageJsonSync: (cwd?: URL | string, options?: ReadOptions) => NormalizedReadResult;
+declare const writePackageJson: <T = PackageJson>(data: T, options?: WriteJsonOptions & {
+    cwd?: URL | string;
+}) => Promise<void>;
+declare const writePackageJsonSync: <T = PackageJson>(data: T, options?: WriteJsonOptions & {
+    cwd?: URL | string;
+}) => void;
+declare const parsePackageJsonSync: (packageFile: JsonObject | string, options?: {
+    cache?: Cache<NormalizedPackageJson> | boolean;
+    ignoreWarnings?: (RegExp | string)[];
+    json5?: boolean;
+    resolveCatalogs?: boolean;
+    strict?: boolean;
+    yaml?: boolean;
+}) => NormalizedPackageJson;
+declare const parsePackageJson: (packageFile: JsonObject | string, options?: {
+    cache?: Cache<NormalizedPackageJson> | boolean;
+    ignoreWarnings?: (RegExp | string)[];
+    json5?: boolean;
+    resolveCatalogs?: boolean;
+    strict?: boolean;
+    yaml?: boolean;
+}) => Promise<NormalizedPackageJson>;
+declare const getPackageJsonProperty: <T = unknown>(packageJson: NormalizedPackageJson, property: Paths<NormalizedPackageJson>, defaultValue?: T) => T;
+declare const hasPackageJsonProperty: (packageJson: NormalizedPackageJson, property: Paths<NormalizedPackageJson>) => boolean;
+declare const hasPackageJsonAnyDependency: (packageJson: NormalizedPackageJson, arguments_: string[], options?: {
+    peerDeps?: boolean;
+}) => boolean;
+declare const ensurePackages: (packageJson: NormalizedPackageJson, packages: string[], installKey?: "dependencies" | "devDependencies", options?: EnsurePackagesOptions) => Promise<void>;
+
+export { findPackageJsonSync as a, hasPackageJsonProperty as b, parsePackageJsonSync as c, writePackageJsonSync as d, ensurePackages as e, findPackageJson as f, getPackageJsonProperty as g, hasPackageJsonAnyDependency as h, parsePackageJson as p, writePackageJson as w };
+export type { EnsurePackagesOptions as E, FindPackageJsonCache as F, NormalizedReadResult as N, PackageJson as P, NormalizedPackageJson as i };

package/dist/pnpm.d.ts

@@ -1,4 +1,4 @@
-import { J as JsonObject } from './packem_shared/json-value.d-DU4PzU4Z.js';
+import { JsonObject } from 'type-fest';
 
 type PnpmCatalog = Record<string, string>;
 type PnpmCatalogs = {
@@ -12,4 +12,5 @@ declare const resolveCatalogReference: (packageName: string, versionSpec: string
 declare const resolveDependenciesCatalogReferences: (dependencies: Record<string, string>, catalogs: PnpmCatalogs) => void;
 declare const resolveCatalogReferences: (packageJson: JsonObject, catalogs: PnpmCatalogs) => void;
 
-export { type PnpmCatalog, type PnpmCatalogs, isPackageInWorkspace, readPnpmCatalogs, readPnpmCatalogsSync, resolveCatalogReference, resolveCatalogReferences, resolveDependenciesCatalogReferences };
+export { isPackageInWorkspace, readPnpmCatalogs, readPnpmCatalogsSync, resolveCatalogReference, resolveCatalogReferences, resolveDependenciesCatalogReferences };
+export type { PnpmCatalog, PnpmCatalogs };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@visulima/package",
-  "version": "4.0.1",
-  "description": "A comprehensive package management utility that helps you find root directories, monorepos, package managers, and parse package.json files with advanced features like catalog resolution.",
+  "version": "4.1.0",
+  "description": "A comprehensive package management utility that helps you find root directories, monorepos, package managers, and parse package.json, package.yaml, and package.json5 files with advanced features like catalog resolution.",
   "keywords": [
     "anolilab",
     "find",
@@ -14,6 +14,8 @@
     "package-json",
     "package-manager",
     "package.json",
+    "package.yaml",
+    "package.json5",
     "packages",
     "pkg-dir",
     "pkg-manager",
@@ -26,6 +28,8 @@
     "bun",
     "npm",
     "yarn",
+    "yaml",
+    "json5",
     "visulima"
   ],
   "homepage": "https://www.visulima.com/docs/package/package",
@@ -92,12 +96,14 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "yaml": "^2.8.1",
     "@antfu/install-pkg": "^1.1.0",
-    "@inquirer/confirm": "^5.1.18",
-    "@visulima/fs": "3.1.9",
-    "@visulima/path": "1.4.0",
-    "normalize-package-data": "^8.0.0"
+    "@inquirer/confirm": "^5.1.19",
+    "@visulima/fs": "4.0.0",
+    "@visulima/path": "2.0.0",
+    "json5": "^2.2.3",
+    "normalize-package-data": "^8.0.0",
+    "type-fest": "^5.1.0",
+    "yaml": "^2.8.1"
   },
   "engines": {
     "node": ">=20.19 <=24.*"

package/dist/packem_shared/json-value.d-DU4PzU4Z.d.ts

@@ -1,33 +0,0 @@
-/**
-Matches a JSON object.
-
-This type can be useful to enforce some input to be JSON-compatible or as a super-type to be extended from. Don't use this as a direct return type as the user would have to double-cast it: `jsonObject as unknown as CustomResponse`. Instead, you could extend your CustomResponse type from it to ensure your type only uses JSON-compatible types: `interface CustomResponse extends JsonObject { … }`.
-
-@category JSON
-*/
-type JsonObject = {[Key in string]: JsonValue} & {[Key in string]?: JsonValue | undefined};
-
-/**
-Matches a JSON array.
-
-@category JSON
-*/
-type JsonArray = JsonValue[] | readonly JsonValue[];
-
-/**
-Matches any valid JSON primitive value.
-
-@category JSON
-*/
-type JsonPrimitive = string | number | boolean | null;
-
-/**
-Matches any valid JSON value.
-
-@see `Jsonify` if you need to transform a type to one that is assignable to `JsonValue`.
-
-@category JSON
-*/
-type JsonValue = JsonPrimitive | JsonObject | JsonArray;
-
-export type { JsonObject as J, JsonValue as a };