Function: getDependencyVersionFromPackageJson
▸ getDependencyVersionFromPackageJson(tree, packageName, packageJsonPath?): string | null
Get the resolved version of a dependency from package.json.
Retrieves a package version and automatically resolves PNPM catalog references (e.g., "catalog:default") to their actual version strings. Searches dependencies first, then falls back to devDependencies.
Tree-based usage (generators and migrations): Use when you have a Tree object, which is typical in Nx generators and migrations.
Filesystem-based usage (CLI commands and scripts): Use when reading directly from the filesystem without a Tree object.
Parameters
| Name | Type |
|---|---|
tree | Tree |
packageName | string |
packageJsonPath? | string |
Returns
string | null
The resolved version string, or null if the package is not found in either dependencies or devDependencies
Example
1// Tree-based - from root package.json
2const reactVersion = getDependencyVersionFromPackageJson(tree, 'react');
3// Returns: "^18.0.0" (resolves "catalog:default" if present)
4
5// Tree-based - from specific package.json
6const version = getDependencyVersionFromPackageJson(
7 tree,
8 '@my/lib',
9 'packages/my-lib/package.json'
10);
11
12// Tree-based - with pre-loaded package.json
13const packageJson = readJson(tree, 'package.json');
14const version = getDependencyVersionFromPackageJson(tree, 'react', packageJson);
15Example
1// Filesystem-based - from current directory
2const reactVersion = getDependencyVersionFromPackageJson('react');
3
4// Filesystem-based - with workspace root
5const version = getDependencyVersionFromPackageJson(
6 'react',
7 '/path/to/workspace'
8);
9
10// Filesystem-based - with specific package.json
11const version = getDependencyVersionFromPackageJson(
12 'react',
13 '/path/to/workspace',
14 'apps/my-app/package.json'
15);
16▸ getDependencyVersionFromPackageJson(tree, packageName, packageJson?): string | null
Parameters
| Name | Type |
|---|---|
tree | Tree |
packageName | string |
packageJson? | PackageJson |
Returns
string | null
▸ getDependencyVersionFromPackageJson(packageName, workspaceRootPath?, packageJsonPath?): string | null
Parameters
| Name | Type |
|---|---|
packageName | string |
workspaceRootPath? | string |
packageJsonPath? | string |
Returns
string | null
▸ getDependencyVersionFromPackageJson(packageName, workspaceRootPath?, packageJson?): string | null
Parameters
| Name | Type |
|---|---|
packageName | string |
workspaceRootPath? | string |
packageJson? | PackageJson |
Returns
string | null