package-management 0.0.0-dev.1

package/dist/index.d.cts

@@ -0,0 +1,844 @@
+import { Split } from 'string-ts';
+import { AsyncCacheFn as AsyncCacheFn$1 } from 'async-cache-fn';
+import { Options } from 'execa';
+import * as async_cache_fn_index from 'async-cache-fn/index';
+import { InstallPackageOptions as InstallPackageOptions$1 } from '@antfu/install-pkg';
+import { ResolveOptions } from 'mlly';
+import * as parse_gitignore from 'parse-gitignore';
+import * as WST from 'workspace-tools';
+import { ModificationOptions } from 'jsonc-parser';
+import { Storage, StorageValue, TransactionOptions, Snapshot } from 'unstorage';
+import { FSStorageOptions } from 'unstorage/drivers/fs-lite';
+
+type Equals<A1 extends any, A2 extends any> = (<A>() => A extends A2 ? 1 : 0) extends <A>() => A extends A1 ? 1 : 0 ? 1 : 0;
+type Cast<A1 extends any, A2 extends any> = A1 extends A2 ? A1 : A2;
+type __<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type ValueOf<T> = T[keyof T];
+type EnumToLiteral<T extends string | number> = T extends string ? `${T}` : `${T}` extends `${infer N extends number}` ? N : never;
+type IsUnknown<t> = unknown extends t ? [t] extends [{}] ? false : true : false;
+type AnyFunction = (...args: any[]) => any;
+type StringLiteral<T extends string> = T | (string & {});
+type Awaitable<T> = T | Promise<T>;
+type ResolvedPromise<T> = T extends Promise<infer U> ? U : never;
+type KeyOf<T, K> = K extends keyof T ? K : never;
+type ValueKeyOf<T, K> = T[KeyOf<T, K>];
+type ValueAtPath<T, $dot_path extends string> = ValueKeyOfDeep<Extract<T, object>, Split<$dot_path, ".">>;
+type ValueKeyOfDeep<T, $path extends PropertyKey[]> = $path extends [
+    infer K,
+    ...infer $Path
+] ? ValueKeyOfDeep<ValueKeyOf<T, K>, Extract<$Path, PropertyKey[]>> : T;
+type PickKeyOf<T, K extends keyof T> = K extends keyof T ? K : never;
+type SelectionMap<T> = __<{
+    [K in keyof T]?: boolean;
+}>;
+type PickByValue<T, V> = {
+    [K in keyof T as T[K] extends V ? K : never]: T[K];
+};
+type Entry<key extends PropertyKey = PropertyKey, value = unknown> = readonly [key: key, value: value];
+type EntryOf<O> = {
+    [k in keyof O]-?: [k, O[k] & ({} | null)];
+}[O extends readonly unknown[] ? keyof O & number : keyof O] & unknown;
+type FromEntries<entries extends readonly Entry[]> = {
+    [entry in entries[number] as entry[0]]: entry[1];
+};
+type IsExactBoolean<T> = Equals<T, boolean> extends 1 ? true : false;
+type UnionizedSelectionMap<T, TSelection extends SelectionMap<T>, V> = __<V & {
+    [K in keyof T as IsExactBoolean<TSelection[K]> extends true ? K : never]?: T[K];
+}>;
+type Select<T, TSelection extends SelectionMap<T>, TMode extends "true:pick" | "true:omit"> = __<UnionizedSelectionMap<T, TSelection, TMode extends "true:pick" ? Pick<T, KeyOf<T, keyof PickByValue<TSelection, true>>> : Omit<T, KeyOf<T, keyof PickByValue<TSelection, true>>>>>;
+type IsUnion<T, U = T> = T extends U ? [U] extends [T] ? false : true : never;
+type MergeObject<T extends object, O extends object | unknown = unknown> = __<T & (O extends object ? O : Record<never, never>)>;
+type OmitIndexSignature<ObjectType> = {
+    [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? never : KeyType]: ObjectType[KeyType];
+};
+type RequireExactlyOne<ObjectType, KeysType extends keyof ObjectType = keyof ObjectType> = {
+    [Key in KeysType]: Required<Pick<ObjectType, Key>> & Partial<Record<Exclude<KeysType, Key>, never>>;
+}[KeysType] & Omit<ObjectType, KeysType>;
+type OmitNever<T> = Omit<T, {
+    [K in keyof T]: T[K] extends never ? K : never;
+}[keyof T]> & {};
+type OmitByValue<T, V> = OmitNever<{
+    [K in keyof T]: T[K] extends V ? never : T[K];
+}>;
+type NoInfer<T> = [T][T extends any ? 0 : never];
+type SingleProp<$key, $value> = Prettify<FromEntries<[[key: $key & PropertyKey, value: $value]]>>;
+
+interface PathOptions {
+    cwd?: string;
+}
+type AsyncCacheFn<TReturn = unknown, TOption extends object | undefined = undefined, C extends "required" | "optional" = "optional"> = AsyncCacheFn$1<TReturn, C extends "optional" ? [TOption | undefined] | [] : [TOption]>;
+type CheckResult<$data, $error = Error, $data_key extends string = "data", $error_key extends string = "error"> = Prettify<RequireExactlyOne<SingleProp<$data_key, $data> & SingleProp<$error_key, $error>>>;
+
+interface StackFrameOptions {
+    rootFunctionName?: string;
+}
+declare const _filename: (options?: StackFrameOptions) => string | undefined;
+declare const _dirname: (options?: StackFrameOptions) => string | undefined;
+
+interface PackageManagerConfig<ID extends string = string> {
+    id: ID;
+    command: string;
+    name: string;
+    meta: {
+        lockfile: string | string[];
+    };
+    runner: string;
+    args: {
+        install: {
+            command: string;
+            options: {
+                preferOffline: string;
+                dev: string;
+            };
+        };
+        uninstall: {
+            command: string;
+        };
+    };
+    options: {
+        version: string;
+    };
+}
+type InstallPackageOptions = PackageManagerScriptOptions<"install">;
+type UninstallPackageOptions = PackageManagerScriptOptions<"uninstall">;
+type PackageManagerCommands = PackageManagerConfig["args"];
+type PackageManagerCommandName = keyof PackageManagerCommands;
+type PackageManagerCommandSpec<K> = ValueKeyOf<PackageManagerCommands, K> extends {
+    options: infer O;
+} ? SelectionMap<O> : Record<never, never>;
+type PackageManagerScriptOptions<K extends PackageManagerCommandName | undefined = undefined> = __<{
+    cwd?: string;
+    silent?: boolean;
+    shellOptions?: Options;
+} & PackageManagerCommandSpec<K>>;
+
+interface ImportModuleData<T = any> {
+    /**
+     * The name of the package to import. This should match the name used in the import statement.
+     */
+    name: string;
+    /**
+     * A callback which returns a module import statement
+     */
+    import: ImportCallback<T>;
+}
+interface ImportPackageData<T = any> extends ImportModuleData<T> {
+    /**
+     * When enabled, the package will be installed if it is not found
+     * @default true
+     */
+    install?: boolean;
+    /**
+     * When enabled, the package will be installed as a dev dependency
+     */
+    dev?: boolean;
+    /**
+     * Additional installation options
+     */
+    installOptions?: Omit<InstallPackageOptions$1, "dev">;
+}
+type ImportOption<T = any> = Module | ImportCallback<T> | ImportModuleData<T> | ImportPackageData<T>;
+type Module<T = any> = Promise<T>;
+type ImportCallback<T = any> = () => Module<T>;
+type ImportMap = Record<string, ImportOption>;
+type ImportList = ImportOption[];
+type ImportModuleFn = <T = any>(name: string) => ImportModuleData<T>;
+type ImportOptionData<T extends ImportOption> = ResolvedPromise<ExtractImportOptionModule<T>>;
+type ResolvedImportMap<$Imports extends ImportMap> = {
+    [P in keyof $Imports]: ImportOptionData<$Imports[P]>;
+};
+type ResolvedImportMapPromise<T extends ImportMap> = Promise<ResolvedImportMap<T>>;
+type ResolvedImportList<$Imports extends ImportList> = {
+    [P in keyof $Imports]: ImportOptionData<$Imports[P]>;
+};
+type ResolvedImportListPromise<T extends ImportList> = Promise<ResolvedImportList<T>>;
+type ResolvedImportOption<TOption extends ImportOption> = __<{
+    name?: string;
+    import: () => ExtractImportOptionModule<TOption>;
+} & Partial<ImportPackageData>>;
+type ExtractImportOptionModule<TOption> = Extract<TOption extends {
+    import: () => infer I;
+} ? I : TOption extends () => infer I ? I : TOption extends Module ? TOption : never, Module>;
+
+interface ImporterOptions {
+    /**
+     * When enabled, the default behavior is to install packages that are not found if the name is provided.
+     * @default true
+     */
+    install?: boolean;
+    installer?: InstallerFn;
+}
+/**
+ * Dynamically imports modules and returns their exports in a tuple.
+ * This function ensures type safety and maintains the order of imports.
+ *
+ * @param imports An array of dynamic import promises.
+ * @returns A promise that resolves to a tuple containing the default exports of the imported modules.
+ *
+ * @example
+ * ```typescript
+ * // Usage example with dynamic imports
+ * const [package1, package2] = await importer([
+ *   import('@antfu/eslint-config'),
+ *   import('@antfu/install-pkg')
+ * ]);
+ *
+ * // package1 and package2 will be the default exports of the respective modules
+ * ```
+ *
+ * @typeparam Imports An array type representing the dynamic imports.
+ */
+declare function importer<T extends ImportList>(imports: [...T], options?: ImporterOptions): Promise<ResolvedImportList<T>>;
+type DefinePackageFn = <T = any>(options: __<string | Pick<ImportPackageData, "name" | "dev">>) => ImportPackageData<T>;
+declare const definePackage: DefinePackageFn;
+type InstallerFn = (packageName: string | string[], options?: {
+    dev?: boolean;
+    checkExists?: boolean;
+}) => Promise<void>;
+
+interface ImportMapOptions extends ImporterOptions {
+}
+type ImportMapFn = <T extends ImportMap>(importMap: T, options?: ImportMapOptions) => ResolvedImportMapPromise<T>;
+/**
+ * Asynchronously imports modules from a record of dynamic import promises.
+ * Returns a promise that resolves to a record with the same keys, each mapped to the resolved import.
+ * This function maintains the key-value mapping and ensures type safety.
+ *
+ * @param importMap A record where each key is associated with a dynamic import promise.
+ * @returns A promise that resolves to a record containing the default exports of the imported modules,
+ *          maintaining the original key structure.
+ *
+ * @example
+ * ```typescript
+ * // Usage example with a record of dynamic imports
+ *
+ * const { package1, package2 } = await importMap({
+ *   package1: import('package-1'),
+ *   package2: import('package-2')
+ * });
+ *
+ * // importedModules.config and importedModules.pkg will be the default exports of the respective modules
+ * ```
+ *
+ */
+declare const importMap: ImportMapFn;
+
+declare function resolveModule<T>(module: Awaitable<T>): Promise<T extends {
+    default: infer U;
+} ? U : T>;
+interface ResolveModulePathOptions extends Omit<ResolveOptions, "url"> {
+    paths?: string | URL | (string | URL)[];
+    normalize?: ((path: string) => string) | boolean;
+}
+declare function isPackageModuleFound(name: string, options?: ResolveModulePathOptions): boolean;
+declare function resolvePackageModulePath(name: string, options?: ResolveModulePathOptions): string | undefined;
+declare function findResolvedModulePath(paths: string[], options?: ResolveModulePathOptions): string | undefined;
+declare function resolveModulePath(modulePath: string, options?: ResolveModulePathOptions): string | undefined;
+
+type PackageManagers = PackageManager<PackageManagerId>[];
+interface PackageManager<ID extends string = PackageManagerId> {
+    id: ID;
+    config: PackageManagerConfig;
+    findLockfilePath: AsyncCacheFn<string | undefined, {
+        cwd?: string;
+    }>;
+    hasLockfile: AsyncCacheFn<boolean, {
+        cwd?: string;
+    }>;
+    readLockfile: AsyncCacheFn<string | undefined, {
+        cwd?: string;
+    }>;
+    globalVersion: AsyncCacheFn<string | undefined, PackageManagerScriptOptions>;
+    definePackage: DefinePackageFn;
+    defineImportMap: <T extends ImportMap>(importMap: T, options?: {
+        /**
+         * When enabled, the default behavior is to install packages that are not found.
+         * @default true
+         */
+        install?: boolean;
+    }) => ResolvedImportMapPromise<T>;
+    uninstallPackage: (packageNames: string | string[], options?: UninstallPackageOptions) => Promise<void>;
+    installPackage: (packageNames: string | string[], options?: PackageManagerScriptOptions<"install">) => Promise<void>;
+}
+
+interface DetectPackageManagerOptions {
+    allowed?: SelectionMap<Record<PackageManagerId, unknown>>;
+    cwd?: string;
+}
+declare function findPackageManager(packageManagers: PackageManagers, options?: DetectPackageManagerOptions): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">>;
+declare function findPackageManagerSafely<TAssert extends boolean = true>(packageManagers: PackageManagers, options?: DetectPackageManagerOptions & {
+    assert?: TAssert;
+}): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun"> | undefined>;
+declare function detectPackageManagers(packageManagers: PackageManagers, options?: DetectPackageManagerOptions): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+declare function detectLockfilePackageManagers(packageManagers: PackageManagers, options?: DetectPackageManagerOptions): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+declare function detectGlobalPackageManagers(packageManagers: PackageManagers, options?: DetectPackageManagerOptions): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+declare function filterPackageManagers(packageManagers: PackageManagers, filterFn: (packageManager: PackageManager) => Promise<boolean> | boolean, options?: DetectPackageManagerOptions): Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+
+type PackageManagerId = (typeof packageManagerConfigs)[number]["id"];
+declare const packageManagerConfigs: (PackageManagerConfig<"pnpm"> | PackageManagerConfig<"yarn"> | PackageManagerConfig<"bun"> | PackageManagerConfig<"npm">)[];
+declare function definePackageManagerClient(options: DetectPackageManagerOptions): {
+    configs: PackageManager<"yarn" | "pnpm" | "npm" | "bun">[];
+    findPackageManager: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">, [options?: DetectPackageManagerOptions | undefined]>;
+    findPackageManagerSafely: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun"> | undefined, [options?: DetectPackageManagerOptions | undefined]>;
+    detectPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    detectLockfilePackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    detectGlobalPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    filterPackageManagers: (filterFn: (packageManager: PackageManager) => Promise<boolean> | boolean, options?: DetectPackageManagerOptions) => Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+};
+
+declare function isPackageDependency(packageName: string | string[]): boolean;
+
+interface AliasDefinition {
+    resolve: ResolvePathAliasFn;
+    subpaths?: Subpath[] | Readonly<Subpath[]>;
+}
+interface Subpath {
+    to: string;
+    description?: string;
+}
+type AliasDefinitionMap<TAlias extends string = string> = Record<TAlias, AliasDefinition>;
+type AliasMap<TAliases extends AliasDefinitionMap = AliasDefinitionMap> = {
+    [K in keyof TAliases]: TAliases[K]["resolve"];
+} & {
+    [K in keyof TAliases as `${Extract<K, string>}/${NonNullable<TAliases[K]["subpaths"]>[number]["to"]}`]: TAliases[K]["resolve"];
+};
+type ResolvePathAliasFn = (opts?: {
+    cwd?: string;
+}) => string;
+declare function definePathAliases<const T extends AliasDefinitionMap>(aliasDefinitions: T): {
+    aliasDefinitions: T;
+    aliasMap: AliasMap<T>;
+    getFilePath: <TValidate extends boolean = false, TGlob extends boolean = false>(options: PathTo<Extract<keyof T, string> | Extract<keyof { [K in keyof T as `${Extract<K, string>}/${NonNullable<T[K]["subpaths"]>[number]["to"]}`]: T[K]["resolve"]; }, string>> | GetPathOptions<Extract<keyof T, string> | Extract<keyof { [K in keyof T as `${Extract<K, string>}/${NonNullable<T[K]["subpaths"]>[number]["to"]}`]: T[K]["resolve"]; }, string>, TValidate, TGlob>, aliases?: Record<string, string>) => TValidate extends true ? string | undefined : TGlob extends true ? string | undefined : string;
+};
+type PathTo<TBaseDirAlias extends string = string> = string | [baseDir: TBaseDirAlias, subpath?: string];
+interface GetPathOptions<TAlias extends string, TValidate extends boolean = false, TGlob extends boolean = false> {
+    to: PathTo<TAlias>;
+    startingFrom?: PathTo<TAlias>;
+    cwd?: string;
+    checkExistence?: TValidate;
+    glob?: TGlob;
+}
+declare function getAliasMap<const T extends AliasDefinitionMap>(aliasDefs: T): AliasMap<T>;
+
+/**
+ *  ### Path Aliases:
+ *
+ *
+```jsx
+ Notation: <user_home>/Projects/<workspace_folder>/apps/<package_folder>/src/
+```
+
+ * - **`<workspace_folder>`**:
+ *    > Starting from `cwd`, searches up the directory hierarchy for the workspace root, falling back to the git root if no workspace is detected.
+ *
+ * - **`<workspace_folder?>`**:
+ *    > Starting from `cwd`, searches up the directory hierarchy for the workspace root, unlike `<workspace_folder>` it will not fallback to the git root if no workspace is detected.
+ *    > - *Note that the `?` seen in `<workspace_folder?>` indicates that it has no fallback.*
+ *
+ * - **`<workspace_folder>/node_modules`**:
+ *    > Subpath for node modules in the workspace folder.
+ *    > - Example: `<workspace_folder>/node_modules`
+ *
+ * - **`<package_folder>`**:
+ *    > Starting from `cwd`, searches up the directory hierarchy for package.json.
+ *    > - Example: `<workspace_folder>/apps/package-folder`
+ *
+ * - **`<package_folder>/node_modules`**:
+ *    > Subpath for node modules in the package folder.
+ *
+ * - **`<package_folder>/node_modules/.bin`**:
+ *    > Subpath for executable scripts in the package folder.
+ *
+ * - **`<user_home>`**:
+ *    > Path to the current user's home directory.
+ *    > - Example: `/Users/username`
+ *
+ * - **`<user_tmpdir>`**:
+ *    > Path to the OS tmpdir folder.
+ *    > - Example: `/var/folders/vb/62qmb9fj2qsxcwhr8tb16krrw0000gn/T`
+ *
+ * - **`<cwd>`**:
+ *    > Path to the current working directory.
+ *
+ * - **`<current_file>`**:
+ *    > Path to the current file.
+ *    > - Example: `/Users/username/Projects/monorepo/package-folder/src/utils/getPath.ts`
+ *
+ * - **`<current-folder>`**:
+ *    > Path to the current folder.
+ *    > - Example: `/Users/username/Projects/monorepo/package-folder/src/utils`
+ */
+declare const getPath: <TValidate extends boolean = false, TGlob extends boolean = false>(options: PathTo<"<workspace_folder>" | "<workspace_folder?>" | "<package_folder>" | "<gitroot_folder>" | "<user_home>" | "<user_tmpdir>" | "<cwd>" | "<current_file>" | "<current_folder>" | `<user_home>/${any}` | `<user_tmpdir>/${any}` | `<cwd>/${any}` | `<current_file>/${any}` | `<current_folder>/${any}` | "<workspace_folder>/node_modules" | "<workspace_folder>/node_modules/.bin" | "<workspace_folder?>/node_modules" | "<workspace_folder?>/node_modules/.bin" | "<package_folder>/node_modules" | "<package_folder>/node_modules/.bin" | "<package_folder>/src" | "<gitroot_folder>/node_modules" | "<gitroot_folder>/node_modules/.bin" | "<gitroot_folder>/.vscode"> | GetPathOptions<"<workspace_folder>" | "<workspace_folder?>" | "<package_folder>" | "<gitroot_folder>" | "<user_home>" | "<user_tmpdir>" | "<cwd>" | "<current_file>" | "<current_folder>" | `<user_home>/${any}` | `<user_tmpdir>/${any}` | `<cwd>/${any}` | `<current_file>/${any}` | `<current_folder>/${any}` | "<workspace_folder>/node_modules" | "<workspace_folder>/node_modules/.bin" | "<workspace_folder?>/node_modules" | "<workspace_folder?>/node_modules/.bin" | "<package_folder>/node_modules" | "<package_folder>/node_modules/.bin" | "<package_folder>/src" | "<gitroot_folder>/node_modules" | "<gitroot_folder>/node_modules/.bin" | "<gitroot_folder>/.vscode", TValidate, TGlob>, aliases?: Record<string, string>) => TValidate extends true ? string | undefined : TGlob extends true ? string | undefined : string;
+
+type PathAlias = keyof PredefinedPathAliases;
+type PickPathAlias<K extends PathAlias> = K;
+type PredefinedPathAliases = typeof predefinedPathAliases;
+declare const predefinedPathAliases: {
+    readonly "<workspace_folder>": {
+        readonly resolve: (opts: {
+            cwd?: string | undefined;
+        } | undefined) => string;
+        readonly subpaths: [{
+            readonly to: "node_modules";
+        }, {
+            readonly to: "node_modules/.bin";
+        }];
+    };
+    readonly "<workspace_folder?>": {
+        readonly resolve: (opts: {
+            cwd?: string | undefined;
+        } | undefined) => string;
+        readonly subpaths: [{
+            readonly to: "node_modules";
+        }, {
+            readonly to: "node_modules/.bin";
+        }];
+    };
+    readonly "<package_folder>": {
+        readonly resolve: (opts: {
+            cwd?: string | undefined;
+        } | undefined) => string;
+        readonly subpaths: [{
+            readonly to: "node_modules";
+        }, {
+            readonly to: "node_modules/.bin";
+        }, {
+            readonly to: "src";
+        }];
+    };
+    readonly "<gitroot_folder>": {
+        readonly resolve: (opts: {
+            cwd?: string | undefined;
+        } | undefined) => string;
+        readonly subpaths: [{
+            readonly to: "node_modules";
+        }, {
+            readonly to: "node_modules/.bin";
+        }, {
+            readonly to: ".vscode";
+        }];
+    };
+    readonly "<user_home>": {
+        readonly resolve: () => string;
+        readonly subpaths: any[];
+    };
+    readonly "<user_tmpdir>": {
+        readonly resolve: () => string;
+        readonly subpaths: any[];
+    };
+    readonly "<cwd>": {
+        readonly resolve: () => string;
+        readonly subpaths: any[];
+    };
+    readonly "<current_file>": {
+        readonly resolve: () => string;
+        readonly subpaths: any[];
+    };
+    readonly "<current_folder>": {
+        readonly resolve: () => string;
+        readonly subpaths: any[];
+    };
+};
+
+type PackageName = string;
+interface PackageInfo {
+    name: PackageName;
+    dirpath: string;
+    path: string;
+    packageJson: PackageJson;
+}
+type PackageInfoList = PackageInfo[];
+type PackageInfoMap = Record<PackageName, PackageInfo>;
+interface PackageDependencyItem {
+    name: string;
+    type: PackageDependencyType;
+    version: string;
+}
+type PackageDependencyType = "dependency" | "devDependency" | "peerDependency" | "optionalDependency";
+declare const dependencyTypeMap: {
+    dependency: "dependencies";
+    devDependency: "devDependencies";
+    peerDependency: "peerDependencies";
+    optionalDependency: "optionalDependencies";
+};
+type KnownPackageJson = OmitIndexSignature<PackageJson>;
+interface PackageJson {
+    /**
+     * The name is what your thing is called.
+     * Some rules:
+     
+           - The name must be less than or equal to 214 characters. This includes the scope for scoped packages.
+           - The name can’t start with a dot or an underscore.
+           - New packages must not have uppercase letters in the name.
+           - The name ends up being part of a URL, an argument on the command line, and a folder name. Therefore, the name can’t contain any non-URL-safe characters.
+     
+     */
+    name: PackageName;
+    /**
+     * Version must be parseable by `node-semver`, which is bundled with npm as a dependency. (`npm install semver` to use it yourself.)
+     */
+    version?: string;
+    /**
+     * Put a description in it. It’s a string. This helps people discover your package, as it’s listed in `npm search`.
+     */
+    description?: string;
+    /**
+     * Put keywords in it. It’s an array of strings. This helps people discover your package as it’s listed in `npm search`.
+     */
+    keywords?: string[];
+    /**
+     * The url to the project homepage.
+     */
+    homepage?: string;
+    /**
+     * The url to your project’s issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.
+     */
+    bugs?: string | {
+        url?: string;
+        email?: string;
+    };
+    /**
+     * You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you’re placing on it.
+     */
+    license?: string;
+    /**
+     * Specify the place where your code lives. This is helpful for people who want to contribute. If the git repo is on GitHub, then the `npm docs` command will be able to find you.
+     * For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same shortcut syntax you use for npm install:
+     */
+    repository?: string | {
+        type: string;
+        url: string;
+        /**
+         * If the `package.json` for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives:
+         */
+        directory?: string;
+    };
+    scripts?: Record<string, string>;
+    /**
+     * If you set `"private": true` in your package.json, then npm will refuse to publish it.
+     */
+    private?: boolean;
+    /**
+     * The “author” is one person.
+     */
+    author?: PackageJsonPerson;
+    /**
+     * “contributors” is an array of people.
+     */
+    contributors?: PackageJsonPerson[];
+    /**
+     * The optional `files` field is an array of file patterns that describes the entries to be included when your package is installed as a dependency. File patterns follow a similar syntax to `.gitignore`, but reversed: including a file, directory, or glob pattern (`*`, `**\/*`, and such) will make it so that file is included in the tarball when it’s packed. Omitting the field will make it default to `["*"]`, which means it will include all files.
+     */
+    files?: string[];
+    /**
+     * The main field is a module ID that is the primary entry point to your program. That is, if your package is named `foo`, and a user installs it, and then does `require("foo")`, then your main module’s exports object will be returned.
+     * This should be a module ID relative to the root of your package folder.
+     * For most modules, it makes the most sense to have a main script and often not much else.
+     */
+    main?: string;
+    /**
+     * If your module is meant to be used client-side the browser field should be used instead of the main field. This is helpful to hint users that it might rely on primitives that aren’t available in Node.js modules. (e.g. window)
+     */
+    browser?: string;
+    /**
+     * A map of command name to local file name. On install, npm will symlink that file into `prefix/bin` for global installs, or `./node_modules/.bin/` for local installs.
+     */
+    bin?: string | Record<string, string>;
+    /**
+     * Specify either a single file or an array of filenames to put in place for the `man` program to find.
+     */
+    man?: string | string[];
+    /**
+     * Dependencies are specified in a simple object that maps a package name to a version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.
+     */
+    dependencies?: Record<string, string>;
+    /**
+     * If someone is planning on downloading and using your module in their program, then they probably don’t want or need to download and build the external test or documentation framework that you use.
+     * In this case, it’s best to map these additional items in a `devDependencies` object.
+     */
+    devDependencies?: Record<string, string>;
+    /**
+     * If a dependency can be used, but you would like npm to proceed if it cannot be found or fails to install, then you may put it in the `optionalDependencies` object. This is a map of package name to version or url, just like the `dependencies` object. The difference is that build failures do not cause installation to fail.
+     */
+    optionalDependencies?: Record<string, string>;
+    /**
+     * In some cases, you want to express the compatibility of your package with a host tool or library, while not necessarily doing a `require` of this host. This is usually referred to as a plugin. Notably, your module may be exposing a specific interface, expected and specified by the host documentation.
+     */
+    peerDependencies?: Record<string, string>;
+    /**
+     * TypeScript typings, typically ending by .d.ts
+     */
+    types?: string;
+    typings?: string;
+    /**
+     * Non-Standard Node.js alternate entry-point to main.
+     * An initial implementation for supporting CJS packages (from main), and use module for ESM modules.
+     */
+    module?: string;
+    /**
+     * Make main entry-point be loaded as an ESM module, support "export" syntax instead of "require"
+     *
+     * Docs:
+     * - https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_package_json_type_field
+     *
+     * @default 'commonjs'
+     * @since Node.js v14
+     */
+    type?: "module" | "commonjs";
+    /**
+     * Alternate and extensible alternative to "main" entry point.
+     *
+     * When using `{type: "module"}`, any ESM module file MUST end with `.mjs` extension.
+     *
+     * Docs:
+     * - https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_exports_sugar
+     *
+     * @default 'commonjs'
+     * @since Node.js v14
+     */
+    exports?: string | Record<"import" | "require" | "." | "node" | "browser" | string, string | Record<"import" | "require" | string, string>>;
+    workspaces?: string[];
+    [key: string]: any;
+}
+/**
+ * A “person” is an object with a “name” field and optionally “url” and “email”. Or you can shorten that all into a single string, and npm will parse it for you.
+ */
+type PackageJsonPerson = string | {
+    name: string;
+    email?: string;
+    url?: string;
+};
+
+interface FindDependencyInPackageJsonOptions {
+    name: string;
+    type?: PackageDependencyType | AllowedDependencyTypesOption;
+}
+type AllowedDependencyTypesOption = SelectionMap<Record<PackageDependencyType, any>>;
+declare function isDependencyInPackageJson(options: string | FindDependencyInPackageJsonOptions, packageJson?: PackageJson): boolean;
+declare function findDependencyInPackageJson(option: string | FindDependencyInPackageJsonOptions, packageJson: PackageJson | undefined): {
+    firstMatch: PackageDependencyItem | undefined;
+    matches: PackageDependencyItem[];
+} | undefined;
+
+type ProjectFolderTypeOption = WorkspaceFolderTypeOption | PackageFolderTypeOption | GitRootFolderTypeOption | PackageNameFolderTypeOption;
+type PackageFolderTypeOption = PickPathAlias<"<package_folder>">;
+type GitRootFolderTypeOption = PickPathAlias<"<gitroot_folder>">;
+type PackageNameFolderTypeOption = RequireExactlyOne<{
+    packageName: PackageName;
+}>;
+type WorkspaceFolderTypeOption = PickPathAlias<"<workspace_folder>"> | RequireExactlyOne<{
+    "<workspace_folder>": Pick<GetWorkspaceFolderOptions, "fallbackToGitRoot" | "throwIfNotFound">;
+}>;
+
+type ProjectParams = [
+    source: ProjectFolderTypeOption,
+    options?: PathOptions
+];
+declare const project: (source: ProjectFolderTypeOption, options?: PathOptions | undefined) => {
+    packageJson: PackageJson | undefined;
+    packageJsonPath: string | undefined;
+    packageName: string | undefined;
+    projectDir: string | undefined;
+    findPackageManager: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">, [options?: DetectPackageManagerOptions | undefined]>;
+    detectPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    detectGlobalPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    detectLockfilePackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+    tsconfig: {
+        readonly paths: string[];
+    };
+    gitignore: {
+        readonly data: parse_gitignore.ParsedGitignoreObject;
+        readonly patterns: string[];
+    };
+    filterPackageManagers: (filterFn: (packageManager: PackageManager<"yarn" | "pnpm" | "npm" | "bun">) => boolean | Promise<boolean>, options?: DetectPackageManagerOptions | undefined) => Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+    getPackageJson: () => PackageJson;
+    findDependencyInPackageJson: (options: string | FindDependencyInPackageJsonOptions) => {
+        firstMatch: PackageDependencyItem | undefined;
+        matches: PackageDependencyItem[];
+    } | undefined;
+    isDependencyInPackageJson: (options: string | FindDependencyInPackageJsonOptions) => boolean;
+};
+
+declare function getFolderByPackageName(name: PackageName, options?: PathOptions): string | undefined;
+
+declare function getGitRootFolder(options?: PathOptions): string | undefined;
+
+/**
+ *
+ * Finds the nearest `package.json` directory, starting from `cwd`
+ *
+ */
+declare function getPackageFolder(options?: {
+    cwd?: string;
+}): string;
+
+interface GetWorkspaceFolderOptions<$Validate extends boolean = true> extends PathOptions {
+    /** @default true */
+    fallbackToGitRoot?: boolean;
+    /** @default true */
+    throwIfNotFound?: $Validate;
+}
+/**
+ * Starting from cwd, searches up the directory hierarchy for the workspace root,
+ * falling back to the git root if no workspace is detected.
+ */
+declare function getWorkspaceFolder<$ThrowIfNotFound extends boolean = true>(options?: GetWorkspaceFolderOptions<$ThrowIfNotFound>): $ThrowIfNotFound extends true ? string : string | undefined;
+
+declare function getWorkspacePackageInfoMap(options?: PathOptions & {
+    includeRoot?: boolean;
+}): PackageInfoMap;
+
+interface GetPackageInfoListOptions {
+    cwd?: string;
+    includeRoot?: boolean;
+}
+declare function getWorkspacePackageInfoList(options?: GetPackageInfoListOptions): (PackageInfo | {
+    name: string;
+    path: string;
+    packageJson: WST.PackageInfo;
+})[];
+
+declare function getWorkspacePackageNames(options?: GetPackageInfoListOptions): string[];
+
+declare const workspace: {
+    packageNames: typeof getWorkspacePackageNames;
+    packageGraph: typeof getWorkspacePackageInfoMap;
+    packageList: typeof getWorkspacePackageInfoList;
+    workspaceRootDir: typeof getWorkspaceFolder;
+    getProject: (source: ProjectFolderTypeOption, options?: PathOptions | undefined) => {
+        packageJson: PackageJson | undefined;
+        packageJsonPath: string | undefined;
+        packageName: string | undefined;
+        projectDir: string | undefined;
+        findPackageManager: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">, [options?: DetectPackageManagerOptions | undefined]>;
+        detectPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+        detectGlobalPackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+        detectLockfilePackageManagers: async_cache_fn_index.AsyncCacheFn<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[], [options?: DetectPackageManagerOptions | undefined]>;
+        tsconfig: {
+            readonly paths: string[];
+        };
+        gitignore: {
+            readonly data: parse_gitignore.ParsedGitignoreObject;
+            readonly patterns: string[];
+        };
+        filterPackageManagers: (filterFn: (packageManager: PackageManager<"yarn" | "pnpm" | "npm" | "bun">) => boolean | Promise<boolean>, options?: DetectPackageManagerOptions | undefined) => Promise<PackageManager<"yarn" | "pnpm" | "npm" | "bun">[]>;
+        getPackageJson: () => PackageJson;
+        findDependencyInPackageJson: (options: string | FindDependencyInPackageJsonOptions) => {
+            firstMatch: PackageDependencyItem | undefined;
+            matches: PackageDependencyItem[];
+        } | undefined;
+        isDependencyInPackageJson: (options: string | FindDependencyInPackageJsonOptions) => boolean;
+    };
+};
+
+interface JsonSourceData<$json extends object = object> {
+    text: string;
+    data: $json;
+}
+type JsonSourceInput<data extends object = object> = Prettify<RequireExactlyOne<{
+    data?: data;
+    filepath?: string;
+    text?: string;
+}>>;
+
+interface JSONEditMap {
+    [$dot_path: string | number]: Omit<JSONEditData, "path">;
+}
+interface JSONEditData {
+    path: (string | number)[] | string | number;
+    value: any;
+    options?: JSONEditOptions;
+}
+interface JSONEditOptions extends ModificationOptions {
+    /** @default "."  */
+    pathSeparator?: string | false;
+}
+type JSONEdits = JSONEditMap | JSONEditData[];
+interface ModifyJSONCDataOptions<$data extends object = object> {
+    json: JsonSourceInput<$data>;
+    edits: JSONEdits;
+    defaultEditOptions?: JSONEditOptions;
+}
+type ModifyJSONDataResult = CheckResult<JsonSourceData>;
+declare function modifyJSON({ json, edits, defaultEditOptions, }: ModifyJSONCDataOptions): ModifyJSONDataResult;
+interface MoodifyJSONFileOptions<$auto_commit extends boolean = boolean> {
+    autoCommit?: $auto_commit;
+    defaultEditOptions?: JSONEditOptions;
+}
+type ModifyJSONFileResult<$auto_commit extends boolean = true> = $auto_commit extends true ? CheckResult<JsonSourceData> : CheckResult<{
+    json: JsonSourceData;
+    commit: () => void;
+}>;
+declare function modifyJSONFile<$auto_commit extends boolean = true>(filepath: string, edits: JSONEdits, options?: MoodifyJSONFileOptions<$auto_commit>): ModifyJSONFileResult<$auto_commit>;
+
+declare const storage: Storage<StorageValue>;
+declare const tempFileSystem: {
+    definition: {
+        readonly base: string;
+    };
+    initialize: () => Promise<FileSystemStorage<unknown, string & {}>>;
+};
+type FileSystemEntriesDefinition<$filepath extends string = string> = {
+    [K in $filepath]: StorageValue | (<$file_data extends StorageValue>() => {
+        file: $file_data;
+        options?: TransactionOptions;
+        serialize?: (file_data: $file_data) => string;
+        deserialize?: (file_content: string) => $file_data;
+    });
+};
+interface FileSystemEntry<$key extends string = string> {
+    key: $key;
+    value: string;
+    options?: TransactionOptions;
+}
+type DefineFileSystemOptions<$filepath extends string = string> = {
+    base: string;
+    initial?: FileSystemEntriesDefinition<$filepath>;
+} & Omit<FSStorageOptions, "base">;
+type FileSystemPath<$fs_def> = Extract<keyof $fs_def, string>;
+type FileSystemPathCompletion<$fs_def> = StringLiteral<FileSystemPath<$fs_def>>;
+interface FileSystemStorage<$fs_def extends FileSystemEntriesDefinition | undefined = FileSystemEntriesDefinition, // prettier-ignore
+$path_completion extends FileSystemPathCompletion<$fs_def> = FileSystemPathCompletion<$fs_def>> {
+    meta: {
+        fileEntriesData: FileSystemEntriesData<$fs_def>;
+    };
+    createFile: (key: string, data: string) => Promise<{
+        key: string;
+        filepath: string;
+        get: () => Promise<StorageValue>;
+        update: (data: string) => Promise<void>;
+    }>;
+    getFile: (filepath: $path_completion) => Promise<{
+        key: string;
+        filepath: string;
+        data: any;
+        read: () => Promise<any>;
+    }>;
+    readFile: (filepath: $path_completion) => Promise<string>;
+    getFilePath: <$filepath extends $path_completion>(key: $filepath) => Promise<string>;
+    restoreFs(snapshot: Snapshot, base?: string): Promise<void>;
+    snapshotFs: (base?: string) => Promise<Snapshot<string>>;
+    initializeFs: (newInitial?: FileSystemEntriesDefinition) => Promise<void>;
+    removeAllFiles(base?: string, opts?: TransactionOptions): Promise<void>;
+    deleteFileSystem(): Promise<void>;
+    defineFileSystemEntries: typeof defineFileSystemEntries;
+    storage: Storage;
+}
+interface FileSystemEntriesData<T extends FileSystemEntriesDefinition | undefined = undefined, $fs_def extends ExtractFsEntriesDef<T> = ExtractFsEntriesDef<T>> {
+    definition: $fs_def;
+    fileSystemEntries: FileSystemEntry<FileSystemPath<$fs_def>>[];
+}
+declare function defineFileSystemEntries<const $fs_def extends FileSystemEntriesDefinition>(definition: $fs_def): FileSystemEntriesData<$fs_def>;
+type ExtractFsEntriesDef<$fs_def> = Cast<$fs_def, FileSystemEntriesDefinition>;
+declare function defineFileSystemStorage<const $fs_storage_def extends DefineFileSystemOptions = DefineFileSystemOptions, // prettier-ignore
+$fs_def extends $fs_storage_def['initial'] = $fs_storage_def['initial']>(options: $fs_storage_def): $fs_storage_def["initial"] extends undefined ? FileSystemStorage : {
+    definition: $fs_storage_def;
+    initialize: () => Promise<FileSystemStorage<$fs_def>>;
+};
+
+export { type AliasDefinition, type AliasDefinitionMap, type AliasMap, type AnyFunction, type AsyncCacheFn, type Awaitable, type Cast, type CheckResult, type DefinePackageFn, type DetectPackageManagerOptions, type Entry, type EntryOf, type EnumToLiteral, type Equals, type ExtractImportOptionModule, type FileSystemEntriesDefinition, type FindDependencyInPackageJsonOptions, type FromEntries, type GetPathOptions, type GetWorkspaceFolderOptions, type ImportCallback, type ImportList, type ImportMap, type ImportMapFn, type ImportMapOptions, type ImportModuleData, type ImportModuleFn, type ImportOption, type ImportOptionData, type ImportPackageData, type ImporterOptions, type InstallPackageOptions, type InstallerFn, type IsExactBoolean, type IsUnion, type IsUnknown, type JSONEditData, type JSONEditMap, type JSONEditOptions, type JSONEdits, type KeyOf, type KnownPackageJson, type MergeObject, type ModifyJSONCDataOptions, type Module, type MoodifyJSONFileOptions, type NoInfer, type OmitByValue, type OmitIndexSignature, type OmitNever, type PackageDependencyItem, type PackageDependencyType, type PackageInfo, type PackageInfoList, type PackageInfoMap, type PackageJson, type PackageJsonPerson, type PackageManagerCommandName, type PackageManagerCommandSpec, type PackageManagerCommands, type PackageManagerConfig, type PackageManagerId, type PackageManagerScriptOptions, type PackageName, type PathAlias, type PathOptions, type PathTo, type PickByValue, type PickKeyOf, type PickPathAlias, type PredefinedPathAliases, type Prettify, type ProjectParams, type RequireExactlyOne, type ResolveModulePathOptions, type ResolvedImportList, type ResolvedImportListPromise, type ResolvedImportMap, type ResolvedImportMapPromise, type ResolvedImportOption, type ResolvedPromise, type Select, type SelectionMap, type SingleProp, type StringLiteral, type UninstallPackageOptions, type ValueAtPath, type ValueKeyOf, type ValueKeyOfDeep, type ValueOf, type __, _dirname, _filename, defineFileSystemEntries, defineFileSystemStorage, definePackage, definePackageManagerClient, definePathAliases, dependencyTypeMap, detectGlobalPackageManagers, detectLockfilePackageManagers, detectPackageManagers, filterPackageManagers, findDependencyInPackageJson, findPackageManager, findPackageManagerSafely, findResolvedModulePath, getAliasMap, getFolderByPackageName, getGitRootFolder, getPackageFolder, getPath, getWorkspaceFolder, importMap, importer, isDependencyInPackageJson, isPackageDependency, isPackageModuleFound, modifyJSON, modifyJSONFile, packageManagerConfigs, predefinedPathAliases, project, resolveModule, resolveModulePath, resolvePackageModulePath, storage, tempFileSystem, workspace };