MCPcopy
hub / github.com/nrwl/nx / CatalogManager

Interface CatalogManager

packages/devkit/src/utils/catalog/manager.ts:23–85  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

21 * Interface for catalog managers that handle package manager-specific catalog implementations.
22 */
23export interface CatalogManager {
24 readonly name: string;
25
26 isCatalogReference(version: string): boolean;
27
28 parseCatalogReference(version: string): CatalogReference | null;
29
30 getCatalogDefinitionFilePaths(): string[];
31
32 /**
33 * Get catalog definitions from the workspace.
34 */
35 getCatalogDefinitions(workspaceRoot: string): CatalogDefinitions | null;
36 getCatalogDefinitions(tree: Tree): CatalogDefinitions | null;
37
38 /**
39 * Resolve a catalog reference to an actual version.
40 */
41 resolveCatalogReference(
42 workspaceRoot: string,
43 packageName: string,
44 version: string
45 ): string | null;
46 resolveCatalogReference(
47 tree: Tree,
48 packageName: string,
49 version: string
50 ): string | null;
51
52 /**
53 * Check that a catalog reference is valid.
54 */
55 validateCatalogReference(
56 workspaceRoot: string,
57 packageName: string,
58 version: string
59 ): void;
60 validateCatalogReference(
61 tree: Tree,
62 packageName: string,
63 version: string
64 ): void;
65
66 /**
67 * Updates catalog definitions for specified packages in their respective catalogs.
68 */
69 updateCatalogVersions(
70 tree: Tree,
71 updates: Array<{
72 packageName: string;
73 version: string;
74 catalogName?: string;
75 }>
76 ): void;
77 updateCatalogVersions(
78 workspaceRoot: string,
79 updates: Array<{
80 packageName: string;

Callers

nothing calls this directly

Implementers 4

YarnCatalogManagerpackages/devkit/src/utils/catalog/yarn
PnpmCatalogManagerpackages/devkit/src/utils/catalog/pnpm
YarnCatalogManagerpackages/nx/src/utils/catalog/yarn-man
PnpmCatalogManagerpackages/nx/src/utils/catalog/pnpm-man

Calls

no outgoing calls

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…