feat(ui): support passing import path to publishable lib

Author: pascalbe-dev

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

@@ -38,8 +38,8 @@ describe('ui', () => {
     const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
     expect(nxJson.projects).toEqual({
       'shared-ui-form-components': {
-        tags: ['domain:shared', 'type:ui']
-      }
+        tags: ['domain:shared', 'type:ui'],
+      },
     });
   });
 
@@ -53,8 +53,8 @@ describe('ui', () => {
     const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
     expect(nxJson.projects).toEqual({
       'customer-ui-form-components': {
-        tags: ['domain:customer', 'type:ui']
-      }
+        tags: ['domain:customer', 'type:ui'],
+      },
     });
   });
 
@@ -82,10 +82,12 @@ describe('ui', () => {
     );
 
     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'
+    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 () => {
@@ -98,8 +100,51 @@ describe('ui', () => {
     const nxJson = readJsonInTree<NxJson>(tree, '/nx.json');
     expect(nxJson.projects).toEqual({
       'customer-forms-ui-form-components': {
-        tags: ['domain:customer', 'type:ui']
-      }
+        tags: ['domain:customer', 'type:ui'],
+      },
     });
   });
+
+  it('should add valid import path to publishable lib', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      { name: 'form-components', shared: true, type: 'publishable' },
+      appTree
+    );
+
+    let ngPackage = readJsonInTree(
+      tree,
+      'libs/shared/ui-form-components/ng-package.json'
+    );
+    expect(ngPackage).toBeDefined();
+    const packageJson = readJsonInTree(
+      tree,
+      'libs/shared/ui-form-components/package.json'
+    );
+    expect(packageJson.name).toEqual('@proj/shared-ui-form-components');
+  });
+
+  it('should add valid import path to publishable lib with customized directory', async () => {
+    const tree = await runSchematic<UiOptions>(
+      'ui',
+      {
+        name: 'form-components',
+        shared: true,
+        type: 'publishable',
+        directory: 'forms',
+      },
+      appTree
+    );
+
+    let ngPackage = readJsonInTree(
+      tree,
+      'libs/shared/forms/ui-form-components/ng-package.json'
+    );
+    expect(ngPackage).toBeDefined();
+    const packageJson = readJsonInTree(
+      tree,
+      'libs/shared/forms/ui-form-components/package.json'
+    );
+    expect(packageJson.name).toEqual('@proj/shared-forms-ui-form-components');
+  });
 });

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

@@ -1,5 +1,11 @@
 import { strings } from '@angular-devkit/core';
-import { chain, externalSchematic, Rule } from '@angular-devkit/schematics';
+import {
+  chain,
+  externalSchematic,
+  Rule,
+  Tree
+} from '@angular-devkit/schematics';
+import { getNpmScope } from '@nrwl/workspace';
 import { UiOptions } from './schema';
 
 function validateInputs(options: UiOptions): void {
@@ -16,22 +22,36 @@ function validateInputs(options: UiOptions): void {
   }
 }
 
-export default function(options: UiOptions): Rule {
-  validateInputs(options);
+export default function (options: UiOptions): Rule {
+  return (host: Tree) => {
+    validateInputs(options);
 
-  const libName = strings.dasherize(options.name);
-  const domain = options.shared ? 'shared' : options.domain;
-  const libDir = options.directory ? `${domain}/${options.directory}` : domain;
+    const libName = `ui-${strings.dasherize(options.name)}`;
+    const domain = options.shared ? 'shared' : options.domain;
+    const libDirectory = options.directory
+      ? `${domain}/${options.directory}`
+      : domain;
+    const isPublishableLib = options.type === 'publishable';
+    const npmScope = getNpmScope(host);
+    const projectName = `${libDirectory}-${libName}`.replace(
+      new RegExp('/', 'g'),
+      '-'
+    );
+    const importPath = isPublishableLib
+      ? `@${npmScope}/${projectName}`
+      : undefined;
 
-  return chain([
-    externalSchematic('@nrwl/angular', 'lib', {
-      name: `ui-${libName}`,
-      directory: libDir,
-      tags: `domain:${domain},type:ui`,
-      style: 'scss',
-      prefix: options.name,
-      publishable: options.type === 'publishable',
-      buildable: options.type === 'buildable'
-    })
-  ]);
+    return chain([
+      externalSchematic('@nrwl/angular', 'lib', {
+        name: libName,
+        tags: `domain:${domain},type:ui`,
+        style: 'scss',
+        prefix: options.name,
+        publishable: isPublishableLib,
+        buildable: options.type === 'buildable',
+        directory: libDirectory,
+        importPath,
+      }),
+    ]);
+  };
 }