fix(devkit): fix extractLayoutDirectory typescript types to better reflect allowed params and return value (#15339)

docs/generated/devkit/extractLayoutDirectory.md

@@ -1,20 +1,20 @@
 # Function: extractLayoutDirectory
 
-▸ **extractLayoutDirectory**(`directory`): `Object`
+▸ **extractLayoutDirectory**(`directory?`): `Object`
 
 Experimental
 
 #### Parameters
 
 | Name         | Type     |
-| :---------- | :------- |
+| :----------- | :------- |
-| `directory` | `string` |
+| `directory?` | `string` |
 
 #### Returns
 
 `Object`
 
 | Name                | Type               |
-| :----------------- | :------- |
+| :------------------ | :----------------- |
-| `layoutDirectory`  | `string` |
+| `layoutDirectory`   | `string` \| `null` |
-| `projectDirectory` | `string` |
+| `projectDirectory?` | `string`           |

packages/devkit/src/utils/get-workspace-layout.spec.ts

@@ -1,5 +1,8 @@
 import { createTreeWithEmptyWorkspace } from 'nx/src/devkit-testing-exports';
-import { getWorkspaceLayout } from './get-workspace-layout';
+import {
+  getWorkspaceLayout,
+  extractLayoutDirectory,
+} from './get-workspace-layout';
 
 describe('getWorkspaceLayout', () => {
   it('should return selected values', () => {
@@ -59,3 +62,24 @@ describe('getWorkspaceLayout', () => {
     });
   });
 });
+
+describe('extractLayoutDirectory', () => {
+  it('should extract layout directory', () => {
+    expect(extractLayoutDirectory('apps/my-app')).toEqual({
+      layoutDirectory: 'apps',
+      projectDirectory: 'my-app',
+    });
+    expect(extractLayoutDirectory('libs/my-lib')).toEqual({
+      layoutDirectory: 'libs',
+      projectDirectory: 'my-lib',
+    });
+    expect(extractLayoutDirectory('packages/my-package')).toEqual({
+      layoutDirectory: 'packages',
+      projectDirectory: 'my-package',
+    });
+    expect(extractLayoutDirectory(undefined)).toEqual({
+      layoutDirectory: null,
+      projectDirectory: undefined,
+    });
+  });
+});

packages/devkit/src/utils/get-workspace-layout.ts

@@ -34,9 +34,9 @@ export function getWorkspaceLayout(tree: Tree): {
 /**
  * Experimental
  */
-export function extractLayoutDirectory(directory: string): {
+export function extractLayoutDirectory(directory?: string): {
-  layoutDirectory: string;
+  layoutDirectory: string | null;
-  projectDirectory: string;
+  projectDirectory?: string;
 } {
   if (directory) {
     directory = directory.startsWith('/') ? directory.substring(1) : directory;