feat(feature): ngrx import and install deps

Author: Peter Smith

libs/ddd/src/schematics/feature/index.ts

@@ -18,6 +18,8 @@ import {
   addImport,
   addTsExport,
   filterTemplates,
+  addNgrxImportsToDomain,
+  addNgRxToPackageJson,
 } from '../rules';
 import { readWorkspaceName } from '../utils';
 
@@ -27,6 +29,7 @@ export default function (options: FeatureOptions): Rule {
 
     const domainFolderName = strings.dasherize(options.domain);
     const domainPath = `libs/${domainFolderName}/domain/src/lib`;
+    const domainModulePath = `${domainPath}/${domainFolderName}-domain.module.ts`;
     const domainModuleClassName =
       strings.classify(options.domain) + 'DomainModule';
     const domainImportPath = `${workspaceName}/${domainFolderName}/domain`;
@@ -62,22 +65,30 @@ export default function (options: FeatureOptions): Rule {
       }
     }
 
-    const domainTemplates = options.ngrx
-      ? apply(url('./files/forDomainWithNgrx'), [
-          filterTemplates(options),
-          template({ ...strings, ...options, workspaceName }),
-          move(domainPath),
-        ])
-      : apply(url('./files/forDomain'), [
-          filterTemplates(options),
-          template({ ...strings, ...options, workspaceName }),
-          move(domainPath),
-        ]);
+    const domainTemplates =
+      options.ngrx && options.entity
+        ? apply(url('./files/forDomainWithNgrx'), [
+            filterTemplates(options),
+            template({ ...strings, ...options, workspaceName }),
+            move(domainPath),
+          ])
+        : apply(url('./files/forDomain'), [
+            filterTemplates(options),
+            template({ ...strings, ...options, workspaceName }),
+            move(domainPath),
+          ]);
 
-    const featureTemplates = apply(url('./files/forFeature'), [
-      template({ ...strings, ...options, workspaceName }),
-      move(featurePath),
-    ]);
+    const featureTemplates =
+      options.ngrx && options.entity
+        ? apply(url('./files/forFeatureWithNgrx'), [
+            filterTemplates(options),
+            template({ ...strings, ...options, workspaceName }),
+            move(featurePath),
+          ])
+        : apply(url('./files/forFeature'), [
+            template({ ...strings, ...options, workspaceName }),
+            move(featurePath),
+          ]);
 
     return chain([
       externalSchematic('@nrwl/angular', 'lib', {
@@ -113,6 +124,15 @@ export default function (options: FeatureOptions): Rule {
             `./lib/infrastructure/${entityName}.data.service`,
           ])
         : noop(),
+      options.ngrx && options.entity && host.exists(domainModulePath)
+        ? chain([
+            addNgRxToPackageJson(),
+            addNgrxImportsToDomain(domainModulePath, entityName),
+            addTsExport(domainIndexPath, [
+              `./lib/+state/${entityName}/${entityName}.actions`,
+            ]),
+          ])
+        : noop(),
       addTsExport(domainIndexPath, [`./lib/application/${featureName}.facade`]),
       mergeWith(featureTemplates),
       addTsExport(featureIndexPath, [`./lib/${featureName}.component`]),

libs/ddd/src/schematics/rules/add-import.ts

@@ -5,7 +5,7 @@ import { readIntoSourceFile } from '../utils';
 
 /**
  * addImport
- * @param modulePath the path of the moudule the import is being included in
+ * @param modulePath the path of the module the import is being included in
  * @param ngModuleToImportPath the path of angular module that is being imported.
  * @param ngModuleToImportName the name of the angular module that is being imported.
  * @param optional whether or not optional

libs/ddd/src/schematics/rules/add-ngrx-imports-to-domain.ts

@@ -0,0 +1,51 @@
+import { Tree, Rule } from '@angular-devkit/schematics';
+import { classify, dasherize } from '@nrwl/workspace/src/utils/strings';
+import {
+  addImportToModule,
+  insertImport,
+} from '@schematics/angular/utility/ast-utils';
+import { readIntoSourceFile, insert } from '../utils';
+
+/**
+ * addNgrxImportsToDomain
+ * @param modulePath the path of the moudule the import is being included in
+ * @param entityName the name of the entity
+ */
+export function addNgrxImportsToDomain(
+  modulePath: string,
+  entityName: string
+): Rule {
+  return (host: Tree) => {
+    const pathPrefix = `./+state/${dasherize(entityName)}/${dasherize(
+      entityName
+    )}`;
+    const reducerPath = `${pathPrefix}.reducer`;
+    const reducerImports = `* as from${classify(entityName)}`;
+    const effectsName = `${classify(entityName)}Effects`;
+    const effectsPath = `${pathPrefix}.effects`;
+    const effectsImports = `{ ${effectsName} }`;
+
+    const classfiedEntityName = classify(entityName);
+    const fromFeature = `from${classfiedEntityName}`;
+    const storeForFeature = `StoreModule.forFeature(${fromFeature}.${classfiedEntityName.toUpperCase()}_FEATURE_KEY, ${fromFeature}.reducer)`;
+    const effectsForFeature = `EffectsModule.forFeature([${effectsName}])`;
+
+    if (!host.exists(modulePath)) {
+      return;
+    }
+
+    const source = readIntoSourceFile(host, modulePath);
+
+    insert(host, modulePath, [
+      insertImport(source, modulePath, effectsImports, effectsPath, true),
+      insertImport(source, modulePath, reducerImports, reducerPath, true),
+      ...addImportToModule(source, modulePath, storeForFeature, '@ngrx/store'),
+      ...addImportToModule(
+        source,
+        modulePath,
+        effectsForFeature,
+        '@ngrx/effects'
+      ),
+    ]);
+  };
+}

libs/ddd/src/schematics/rules/add-ngrx-to-package-json.ts

@@ -0,0 +1,26 @@
+/**
+ * credit: https://github.com/nrwl/nx/tree/master/packages/angular/src/schematics/ngrx/rules
+ */
+import { Rule } from '@angular-devkit/schematics';
+import { addDepsToPackageJson } from '@nrwl/workspace';
+
+/**
+ * addNgRxToPackageJson
+ * add the ngrx packages to the package.json and install them
+ */
+export function addNgRxToPackageJson(): Rule {
+  const ngrxVersion = '10.0.0';
+
+  return addDepsToPackageJson(
+    {
+      '@ngrx/store': ngrxVersion,
+      '@ngrx/effects': ngrxVersion,
+      '@ngrx/entity': ngrxVersion
+    },
+    {}
+  );
+}
+
+/**
+ * TODO: reconcile the assumption of forRoot
+ */

libs/ddd/src/schematics/rules/index.ts

@@ -5,3 +5,5 @@ export * from './add-import';
 export * from './add-ts-exports';
 export * from './filter-templates';
 export * from './init-linting-rules';
+export * from './add-ngrx-imports-to-domain';
+export * from './add-ngrx-to-package-json';

libs/ddd/src/schematics/utils/index.ts

@@ -3,3 +3,4 @@ export * from './check-rule-exists';
 export * from './read-workspace-name';
 export * from './validate-inputs';
 export * from './update-dep-const';
+export * from './insert';

libs/ddd/src/schematics/utils/insert.ts

@@ -0,0 +1,36 @@
+/**
+ * credit: https://github.com/nrwl/nx/blob/master/packages/workspace/src/utils/ast-utils.ts
+ * we use this instead of @nrwl/workspace version of import because the nrwl/workspace uses
+ * an internal version of Change and we are using the @schematics/angular/utility/ast-utils'
+ * version
+ */
+import { Tree } from '@angular-devkit/schematics';
+import { RemoveChange } from '@nrwl/workspace';
+import { Change, InsertChange } from '@schematics/angular/utility/change';
+
+/**
+ * insert
+ * @param host Host
+ * @param modulePath path to module
+ * @param changes array of changes
+ */
+export function insert(host: Tree, modulePath: string, changes: Change[]) {
+  if (changes.length < 1) {
+    return;
+  }
+
+  // sort changes so that the highest pos goes first
+  const orderedChanges = changes.sort((a, b) => b.order - a.order);
+
+  const recorder = host.beginUpdate(modulePath);
+  for (const change of orderedChanges) {
+    if (change instanceof InsertChange) {
+      recorder.insertLeft(change.pos, change.toAdd);
+    } else if (change instanceof RemoveChange) {
+      recorder.remove(change.pos - 1, change.toRemove.length + 1);
+    } else {
+      throw new Error(`Unexpected Change '${change.constructor.name}'`);
+    }
+  }
+  host.commitUpdate(recorder);
+}