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

nrwl · Feb 22, 2023 · 8a92cb5 · 8a92cb5
1 parent f8d4995
commit 8a92cb5
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/docs/generated/devkit/nrwl_devkit.md b/docs/generated/devkit/nrwl_devkit.md
@@ -128,6 +128,7 @@ It only uses language primitives and immutable objects
 
 ### Utils Variables
 
+- [NX_VERSION](../../devkit/documents/nrwl_devkit#nx_version)
 - [appRootPath](../../devkit/documents/nrwl_devkit#approotpath)
 - [cacheDir](../../devkit/documents/nrwl_devkit#cachedir)
 - [output](../../devkit/documents/nrwl_devkit#output)
@@ -794,6 +795,12 @@ Implementation of a target of a project that handles multiple projects to be bat
 
 ## Utils Variables
 
+### NX_VERSION
+
+• **NX_VERSION**: `string`
+
+---
+
 ### appRootPath
 
 • **appRootPath**: `string` = `workspaceRoot`

diff --git a/docs/generated/packages/devkit/documents/nrwl_devkit.md b/docs/generated/packages/devkit/documents/nrwl_devkit.md
@@ -128,6 +128,7 @@ It only uses language primitives and immutable objects
 
 ### Utils Variables
 
+- [NX_VERSION](../../devkit/documents/nrwl_devkit#nx_version)
 - [appRootPath](../../devkit/documents/nrwl_devkit#approotpath)
 - [cacheDir](../../devkit/documents/nrwl_devkit#cachedir)
 - [output](../../devkit/documents/nrwl_devkit#output)
@@ -794,6 +795,12 @@ Implementation of a target of a project that handles multiple projects to be bat
 
 ## Utils Variables
 
+### NX_VERSION
+
+• **NX_VERSION**: `string`
+
+---
+
 ### appRootPath
 
 • **appRootPath**: `string` = `workspaceRoot`

diff --git a/packages/devkit/public-api.ts b/packages/devkit/public-api.ts
@@ -50,6 +50,7 @@ export {
   addDependenciesToPackageJson,
   ensurePackage,
   removeDependenciesFromPackageJson,
+  NX_VERSION,
 } from './src/utils/package-json';
 
 /**

diff --git a/packages/devkit/src/utils/package-json.ts b/packages/devkit/src/utils/package-json.ts
@@ -454,3 +454,8 @@ function getPackageVersion(pkg: string): undefined | string {
     return undefined;
   }
 }
+
+/**
+ * @description The version of Nx used by the workspace. Returns null if no version is found.
+ */
+export const NX_VERSION = getPackageVersion('nx');