feat(ui): allow customization of the target directory

Author: pascalbe-dev

libs/ddd/src/schematics/ui/schema.json

@@ -20,6 +20,10 @@
             "type": "string",
             "description": "Domain name, if the library belongs to a certain domain."
         },
+        "directory": {
+            "type": "string",
+            "description": "Subpath of the library beneath the domain or shared folder."
+        },
         "type": {
             "type": "string",
             "enum": [

libs/ddd/src/schematics/ui/schema.ts

@@ -18,6 +18,10 @@ export interface UiOptions {
    * Domain name, if the library belongs to a certain domain.
    */
   domain?: string;
+  /**
+   * Subpath of the library beneath the domain or shared folder.
+   */
+  directory?: string;
   /**
    * A type to determine if and how to build the library.
    */

libs/ddd/src/schematics/ui/ui.spec.ts

@@ -73,4 +73,33 @@ describe('ui', () => {
       );
     await expect(schematicFunc()).rejects.toThrowError();
   });
+
+  it('should be able to customize the directory of the library within the domain / shared folder', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', domain: 'customer', directory: 'forms' },
+      appTree
+    );
+
+    const workspaceJson = readJsonInTree(tree, '/workspace.json');
+    expect(workspaceJson.projects).toHaveProperty('customer-forms-ui-form-components');
+    expect(workspaceJson.projects['customer-forms-ui-form-components'].root).toEqual(
+      'libs/customer/forms/ui-form-components'
+    );
+  });
+
+  it('should keep correct tags with a customized directory', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', domain: 'customer', directory: 'forms' },
+      appTree
+    );
+
+    const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
+    expect(nxJson.projects).toEqual({
+      'customer-forms-ui-form-components': {
+        tags: ['domain:customer', 'type:ui']
+      }
+    });
+  });
 });

libs/ddd/src/schematics/ui/ui.ts

@@ -2,7 +2,6 @@ import { strings } from '@angular-devkit/core';
 import { chain, externalSchematic, Rule } from '@angular-devkit/schematics';
 import { UiOptions } from './schema';
 
-
 function validateInputs(options: UiOptions): void {
   if (options.shared && options.domain) {
     throw new Error(`A UI library should either belong to a specific domain or be shared globally. 
@@ -21,17 +20,18 @@ export default function(options: UiOptions): Rule {
   validateInputs(options);
 
   const libName = strings.dasherize(options.name);
-  const libDir = options.shared ? "shared" : options.domain;
+  const domain = options.shared ? 'shared' : options.domain;
+  const libDir = options.directory ? `${domain}/${options.directory}` : domain;
 
   return chain([
     externalSchematic('@nrwl/angular', 'lib', {
       name: `ui-${libName}`,
       directory: libDir,
-      tags: `domain:${libDir},type:ui`,
+      tags: `domain:${domain},type:ui`,
       style: 'scss',
       prefix: options.name,
       publishable: options.type === 'publishable',
-      buildable: options.type === 'buildable',
+      buildable: options.type === 'buildable'
     })
   ]);
 }