workspace-tools/lib/types/WorkspaceInfo.d.ts

A collection of utilities that are useful in a git-controlled monorepo managed by one of these tools:

import { PackageInfo } from "./PackageInfo";
/**
 * Info about a single package ("workspace" in npm/yarn/pnpm terms) within a monorepo.
 *
 * Ideally this should be called just `WorkspaceInfo`, but that name was previously used for the
 * aggregate type.
 */
export interface WorkspacePackageInfo {
    /** Package name */
    name: string;
    /** Absolute path to the package root */
    path: string;
    /** `package.json` contents + path */
    packageJson: PackageInfo;
}
/**
 * Array with names, paths, and package.json contents for each package ("workspace" in
 * npm/yarn/pnpm terms) within a monorepo.
 */
export type WorkspaceInfos = WorkspacePackageInfo[];
/** @deprecated Use `WorkspaceInfos` */
export type WorkspaceInfo = WorkspaceInfos;