feat(Schematics): Add option to group feature blueprints in respective folders (#736)

Author: brandonroberts

modules/schematics/src/action/index.spec.ts

@@ -13,6 +13,8 @@ describe('Action Schematic', () => {
     path: 'app',
     sourceDir: 'src',
     spec: false,
+    group: false,
+    flat: true,
   };
 
   it('should create one file', () => {
@@ -44,4 +46,13 @@ describe('Action Schematic', () => {
       expect(fileContent).toMatch(/export enum FooActionTypes/);
     }
   });
+
+  it('should group within an "actions" folder if group is set', () => {
+    const tree = schematicRunner.runSchematic('action', {
+      ...defaultOptions,
+      group: true,
+    });
+    expect(tree.files.length).toEqual(1);
+    expect(tree.files[0]).toEqual('/src/app/actions/foo.actions.ts');
+  });
 });

modules/schematics/src/action/index.ts

@@ -25,7 +25,11 @@ export default function(options: ActionOptions): Rule {
   const templateSource = apply(url('./files'), [
     options.spec ? noop() : filter(path => !path.endsWith('__spec.ts')),
     template({
-      'if-flat': (s: string) => (options.flat ? '' : s),
+      'if-flat': (s: string) =>
+        stringUtils.group(
+          options.flat ? '' : s,
+          options.group ? 'actions' : ''
+        ),
       ...stringUtils,
       ...(options as object),
       dot: () => '.',

modules/schematics/src/action/schema.d.ts

@@ -8,4 +8,5 @@ export interface Schema {
    */
   spec?: boolean;
   flat?: boolean;
+  group?: boolean;
 }

modules/schematics/src/action/schema.json

@@ -27,6 +27,11 @@
       "type": "boolean",
       "default": true,
       "description": "Flag to indicate if a dir is created."
+    },
+    "group": {
+      "type": "boolean",
+      "default": false,
+      "description": "Group actions file within 'actions' folder"
     }
   },
   "required": [

modules/schematics/src/effect/files/__path__/__name@dasherize@if-flat__/__name@dasherize__.effects.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
 import { Actions, Effect } from '@ngrx/effects';
-<% if(feature) { %>import { <%= classify(name) %>Actions, <%= classify(name) %>ActionTypes } from './<%= dasherize(name) %>.actions';<% } %>
+<% if(feature) { %>import { <%= classify(name) %>Actions, <%= classify(name) %>ActionTypes } from '<%= featurePath(group, "actions") %><%= dasherize(name) %>.actions';<% } %>
 
 @Injectable()
 export class <%= classify(name) %>Effects {

modules/schematics/src/effect/index.spec.ts

@@ -22,6 +22,7 @@ describe('Effect Schematic', () => {
     flat: false,
     feature: false,
     root: false,
+    group: false,
   };
 
   let appTree: Tree;
@@ -173,4 +174,14 @@ describe('Effect Schematic', () => {
 
     expect(content).not.toMatch(/EffectsModule\.forRoot\(\[FooEffects\]\)/);
   });
+
+  it('should group within an "effects" folder if group is set', () => {
+    const options = { ...defaultOptions, flat: true, spec: false, group: true };
+
+    const tree = schematicRunner.runSchematic('effect', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf('/src/app/effects/foo.effects.ts')
+    ).toBeGreaterThanOrEqual(0);
+  });
 });

modules/schematics/src/effect/index.ts

@@ -61,6 +61,7 @@ function addImportToNgModule(options: EffectOptions): Rule {
 
     const effectsPath =
       `/${options.sourceDir}/${options.path}/` +
+      (options.group ? 'effects/' : '') +
       (options.flat ? '' : stringUtils.dasherize(options.name) + '/') +
       stringUtils.dasherize(options.name) +
       '.effects';
@@ -108,7 +109,11 @@ export default function(options: EffectOptions): Rule {
       options.spec ? noop() : filter(path => !path.endsWith('__spec.ts')),
       template({
         ...stringUtils,
-        'if-flat': (s: string) => (options.flat ? '' : s),
+        'if-flat': (s: string) =>
+          stringUtils.group(
+            options.flat ? '' : s,
+            options.group ? 'effects' : ''
+          ),
         ...(options as object),
         dot: () => '.',
       }),

modules/schematics/src/effect/schema.d.ts

@@ -17,4 +17,5 @@ export interface Schema {
   module?: string;
   root?: boolean;
   feature?: boolean;
+  group?: boolean;
 }

modules/schematics/src/effect/schema.json

@@ -44,7 +44,12 @@
       "type": "boolean",
       "default": false,
       "description": "Flag to indicate if part of a feature schematic."
-    }    
+    },
+    "group": {
+      "type": "boolean",
+      "default": false,
+      "description": "Group effects file within 'effects' folder"
+    }
   },
   "required": [
     "name"

modules/schematics/src/feature/index.spec.ts

@@ -17,6 +17,7 @@ describe('Feature Schematic', () => {
     sourceDir: 'src',
     module: '',
     spec: true,
+    group: false,
   };
 
   it('should create all files of a feature', () => {
@@ -34,4 +35,26 @@ describe('Feature Schematic', () => {
       files.indexOf('/src/app/foo.effects.spec.ts')
     ).toBeGreaterThanOrEqual(0);
   });
+
+  it('should create all files of a feature within grouped folders if group is set', () => {
+    const options = { ...defaultOptions, group: true };
+
+    const tree = schematicRunner.runSchematic('feature', options);
+    const files = tree.files;
+    expect(
+      files.indexOf('/src/app/actions/foo.actions.ts')
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf('/src/app/reducers/foo.reducer.ts')
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf('/src/app/reducers/foo.reducer.spec.ts')
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf('/src/app/effects/foo.effects.ts')
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf('/src/app/effects/foo.effects.spec.ts')
+    ).toBeGreaterThanOrEqual(0);
+  });
 });