@augment-vir/node/dist/augments/npm/npm-deps.d.ts

A collection of augments, helpers types, functions, and classes only for Node.js (backend) JavaScript environments.

/**
 * All `package.json` keys that are parsed as direct dependencies.
 *
 * @category Internal
 */
export declare enum PackageJsonDependencyKey {
    DevDependencies = "devDependencies",
    Dependencies = "dependencies",
    PeerDependencies = "peerDependencies",
    Overrides = "overrides"
}
/**
 * A record of package names to package versions included in the direct dependencies. This is the
 * output from {@link listAllDirectNpmDeps}.
 *
 * @category Internal
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export type NpmDeps = Record<string, NpmDep[]>;
/**
 * An individual dependency used in {@link NpmDeps}.
 *
 * @category Internal
 * @category Package : @augment-vir/node
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export type NpmDep = {
    /** Path to the `package.json` file that depends on this. */
    requiredBy: string;
    dependencyKey: PackageJsonDependencyKey;
    /**
     * The version as it is directly noted in the `package.json` file. This might not necessarily
     * correlate to any actually published versions.
     */
    versionValue: string;
    /** If true, this dependency is part of the workspace's own packages. */
    isWorkspace: boolean;
};
/**
 * Finds all direct deps for the workspace at, or that contains, the given dir path.
 *
 * @category Node : Npm
 * @category Package : @augment-vir/node
 * @throws If no directory with a `package-lock.json` file is found.
 * @package [`@augment-vir/node`](https://www.npmjs.com/package/@augment-vir/node)
 */
export declare function listAllDirectNpmDeps(startDirPath: string): Promise<NpmDeps>;