feat(devkit): add method to read installed Nx version

nrwl · Jan 27, 2023 · 05923aa · 05923aa
1 parent d5332b4
commit 05923aa
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 0 deletions.
diff --git a/docs/generated/devkit/index.md b/docs/generated/devkit/index.md
@@ -155,6 +155,7 @@ It only uses language primitives and immutable objects
 - [generateFiles](../../devkit/documents/index#generatefiles)
 - [getDependentPackagesForProject](../../devkit/documents/index#getdependentpackagesforproject)
 - [getImportPath](../../devkit/documents/index#getimportpath)
+- [getInstalledNxVersion](../../devkit/documents/index#getinstallednxversion)
 - [getNpmPackageSharedConfig](../../devkit/documents/index#getnpmpackagesharedconfig)
 - [getOutputsForTargetAndConfiguration](../../devkit/documents/index#getoutputsfortargetandconfiguration)
 - [getPackageManagerCommand](../../devkit/documents/index#getpackagemanagercommand)
@@ -175,6 +176,7 @@ It only uses language primitives and immutable objects
 - [parseTargetString](../../devkit/documents/index#parsetargetstring)
 - [readAllWorkspaceConfiguration](../../devkit/documents/index#readallworkspaceconfiguration)
 - [readCachedProjectGraph](../../devkit/documents/index#readcachedprojectgraph)
+- [readInstalledPackageVersion](../../devkit/documents/index#readinstalledpackageversion)
 - [readJson](../../devkit/documents/index#readjson)
 - [readJsonFile](../../devkit/documents/index#readjsonfile)
 - [readNxJson](../../devkit/documents/index#readnxjson)
@@ -1347,6 +1349,16 @@ Prefixes project name with npm scope
 
 ---
 
+### getInstalledNxVersion
+
+▸ **getInstalledNxVersion**(): `string` \| `null`
+
+#### Returns
+
+`string` \| `null`
+
+---
+
 ### getNpmPackageSharedConfig
 
 ▸ **getNpmPackageSharedConfig**(`pkgName`, `version`): [`SharedLibraryConfig`](../../devkit/documents/index#sharedlibraryconfig) \| `undefined`
@@ -1797,6 +1809,22 @@ Synchronously reads the latest cached copy of the workspace's ProjectGraph.
 
 ---
 
+### readInstalledPackageVersion
+
+▸ **readInstalledPackageVersion**(`pkg`): `string` \| `null`
+
+#### Parameters
+
+| Name  | Type     |
+| :---- | :------- |
+| `pkg` | `string` |
+
+#### Returns
+
+`string` \| `null`
+
+---
+
 ### readJson
 
 ▸ **readJson**<`T`\>(`tree`, `path`, `options?`): `T`

diff --git a/docs/generated/packages/devkit/documents/index.md b/docs/generated/packages/devkit/documents/index.md
@@ -155,6 +155,7 @@ It only uses language primitives and immutable objects
 - [generateFiles](../../devkit/documents/index#generatefiles)
 - [getDependentPackagesForProject](../../devkit/documents/index#getdependentpackagesforproject)
 - [getImportPath](../../devkit/documents/index#getimportpath)
+- [getInstalledNxVersion](../../devkit/documents/index#getinstallednxversion)
 - [getNpmPackageSharedConfig](../../devkit/documents/index#getnpmpackagesharedconfig)
 - [getOutputsForTargetAndConfiguration](../../devkit/documents/index#getoutputsfortargetandconfiguration)
 - [getPackageManagerCommand](../../devkit/documents/index#getpackagemanagercommand)
@@ -175,6 +176,7 @@ It only uses language primitives and immutable objects
 - [parseTargetString](../../devkit/documents/index#parsetargetstring)
 - [readAllWorkspaceConfiguration](../../devkit/documents/index#readallworkspaceconfiguration)
 - [readCachedProjectGraph](../../devkit/documents/index#readcachedprojectgraph)
+- [readInstalledPackageVersion](../../devkit/documents/index#readinstalledpackageversion)
 - [readJson](../../devkit/documents/index#readjson)
 - [readJsonFile](../../devkit/documents/index#readjsonfile)
 - [readNxJson](../../devkit/documents/index#readnxjson)
@@ -1347,6 +1349,16 @@ Prefixes project name with npm scope
 
 ---
 
+### getInstalledNxVersion
+
+▸ **getInstalledNxVersion**(): `string` \| `null`
+
+#### Returns
+
+`string` \| `null`
+
+---
+
 ### getNpmPackageSharedConfig
 
 ▸ **getNpmPackageSharedConfig**(`pkgName`, `version`): [`SharedLibraryConfig`](../../devkit/documents/index#sharedlibraryconfig) \| `undefined`
@@ -1797,6 +1809,22 @@ Synchronously reads the latest cached copy of the workspace's ProjectGraph.
 
 ---
 
+### readInstalledPackageVersion
+
+▸ **readInstalledPackageVersion**(`pkg`): `string` \| `null`
+
+#### Parameters
+
+| Name  | Type     |
+| :---- | :------- |
+| `pkg` | `string` |
+
+#### Returns
+
+`string` \| `null`
+
+---
+
 ### readJson
 
 ▸ **readJson**<`T`\>(`tree`, `path`, `options?`): `T`

diff --git a/packages/devkit/index.ts b/packages/devkit/index.ts
@@ -231,6 +231,8 @@ export {
   addDependenciesToPackageJson,
   ensurePackage,
   removeDependenciesFromPackageJson,
+  getInstalledNxVersion,
+  readInstalledPackageVersion,
 } from './src/utils/package-json';
 
 /**

diff --git a/packages/devkit/src/utils/package-json.ts b/packages/devkit/src/utils/package-json.ts
@@ -6,6 +6,7 @@ import { clean, coerce, gt, satisfies } from 'semver';
 import { getPackageManagerCommand } from 'nx/src/utils/package-manager';
 import { execSync } from 'child_process';
 import { readModulePackageJson } from 'nx/src/utils/package-json';
+import { workspaceRoot } from 'nx/src/utils/workspace-root';
 
 const NON_SEMVER_TAGS = {
   '*': 2,
@@ -381,3 +382,11 @@ export async function ensurePackage(
     }
   }
 }
+
+export function readInstalledPackageVersion(pkg: string): string | null {
+  return readModulePackageJson(pkg).packageJson?.version;
+}
+
+export function getInstalledNxVersion(): string | null {
+  return readInstalledPackageVersion('nx');
+}