feat(ui): add new UI library schematic

Author: pascalbe-dev

libs/ddd/collection.json

@@ -16,7 +16,11 @@
       "factory": "./src/schematics/feature/index",
       "schema": "./src/schematics/feature/schema.json",
       "description": "adds a feature lib to a domain"
+    },
+    "ui": {
+      "factory": "./src/schematics/ui/ui",
+      "schema": "./src/schematics/ui/schema.json",
+      "description": "adds a UI library to a domain or as a shared library"
     }
-
   }
-}
+}

libs/ddd/src/schematics/json-schema-to-ts.js

@@ -9,3 +9,7 @@ toTypeScript
     .compileFromFile('libs/ddd/src/schematics/feature/schema.json')
     .then(ts => fs.writeFileSync('libs/ddd/src/schematics/feature/schema.ts', ts));
 
+
+toTypeScript
+    .compileFromFile('libs/ddd/src/schematics/ui/schema.json')
+    .then(ts => fs.writeFileSync('libs/ddd/src/schematics/ui/schema.ts', ts));

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

@@ -0,0 +1,37 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "id": "ui-options",
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "Name of the UI library",
+            "$default": {
+                "$source": "argv",
+                "index": 0
+            }
+        },
+        "shared": {
+            "type": "boolean",
+            "description": "Whether the library should be shared across all domains.",
+            "default": false
+        },
+        "domain": {
+            "type": "string",
+            "description": "Domain name, if the library belongs to a certain domain."
+        },
+        "type": {
+            "type": "string",
+            "enum": [
+                "internal",
+                "buildable",
+                "publishable"
+            ],
+            "description": "A type to determine if and how to build the library.",
+            "default": "buildable"
+        }
+    },
+    "required": [
+        "name"
+    ]
+}

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

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface UiOptions {
+  /**
+   * Name of the UI library
+   */
+  name: string;
+  /**
+   * Whether the library should be shared across all domains.
+   */
+  shared?: boolean;
+  /**
+   * Domain name, if the library belongs to a certain domain.
+   */
+  domain?: string;
+  /**
+   * A type to determine if and how to build the library.
+   */
+  type?: "internal" | "buildable" | "publishable";
+  [k: string]: any;
+}

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

@@ -0,0 +1,76 @@
+import { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import { NxJson, readJsonInTree } from '@nrwl/workspace';
+import { createEmptyWorkspace } from '@nrwl/workspace/testing';
+import { join } from 'path';
+import { UiOptions } from './schema';
+
+describe('ui', () => {
+  let appTree: Tree;
+
+  const testRunner = new SchematicTestRunner(
+    '@angular-architects/ddd',
+    join(__dirname, '../../../collection.json')
+  );
+
+  function runSchematic<SchemaOptions = any>(
+    schematicName: string,
+    options: SchemaOptions,
+    tree: Tree
+  ) {
+    return testRunner
+      .runSchematicAsync(schematicName, options, tree)
+      .toPromise();
+  }
+
+  beforeEach(() => {
+    appTree = Tree.empty();
+    appTree = createEmptyWorkspace(appTree);
+  });
+
+  it('should add correct tags if ui lib is shared', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', shared: true },
+      appTree
+    );
+
+    const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
+    expect(nxJson.projects).toEqual({
+      'shared-ui-form-components': {
+        tags: ['domain:shared', 'type:ui']
+      }
+    });
+  });
+
+  it('should add correct tags if ui lib belongs to a domain', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', domain: 'customer' },
+      appTree
+    );
+
+    const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
+    expect(nxJson.projects).toEqual({
+      'customer-ui-form-components': {
+        tags: ['domain:customer', 'type:ui']
+      }
+    });
+  });
+
+  it('should throw error if neither domain nor shared option is provided', async () => {
+    const schematicFunc = async () =>
+      await runSchematic<UiOptions>('ui', { name: 'form-components' }, appTree);
+    await expect(schematicFunc()).rejects.toThrowError();
+  });
+
+  it('should throw error if domain and shared option is provided', async () => {
+    const schematicFunc = async () =>
+      await runSchematic<UiOptions>(
+        'ui',
+        { name: 'form-components', domain: 'customer', shared: true },
+        appTree
+      );
+    await expect(schematicFunc()).rejects.toThrowError();
+  });
+});

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

@@ -0,0 +1,37 @@
+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. 
+      If you want to share a UI library across multiple specific domains, 
+      consider using an API library. Hence, you should not provide the shared option in combination
+      with the domain option.`);
+  }
+
+  if (!options.shared && !options.domain) {
+    throw new Error(`A UI library should either belong to a domain or be shared globally.
+      Please provide either of these two options: --domain / --shared`);
+  }
+}
+
+export default function(options: UiOptions): Rule {
+  validateInputs(options);
+
+  const libName = strings.dasherize(options.name);
+  const libDir = options.shared ? "shared" : options.domain;
+
+  return chain([
+    externalSchematic('@nrwl/angular', 'lib', {
+      name: `ui-${libName}`,
+      directory: libDir,
+      tags: `domain:${libDir},type:ui`,
+      style: 'scss',
+      prefix: options.name,
+      publishable: options.type === 'publishable',
+      buildable: options.type === 'buildable',
+    })
+  ]);
+}