feat(schematics): add project flag support to specify apps or libs (#1477)

Now its possible to specify the project when generate actions, effects,
entities, features, reducers and stores.
The new flag is --project and his alias -p
Upgrade the documentation to add the new flag and his alias

Closes #1455

Author: Rafa AS

modules/schematics-core/testing/create-workspace.ts

@@ -3,13 +3,13 @@ import {
   SchematicTestRunner,
 } from '@angular-devkit/schematics/testing';
 
-const defaultWorkspaceOptions = {
+export const defaultWorkspaceOptions = {
   name: 'workspace',
   newProjectRoot: 'projects',
   version: '6.0.0',
 };
 
-const defaultAppOptions = {
+export const defaultAppOptions = {
   name: 'bar',
   inlineStyle: false,
   inlineTemplate: false,

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

@@ -7,6 +7,8 @@ import { Schema as ActionOptions } from './schema';
 import {
   getTestProjectPath,
   createWorkspace,
+  defaultWorkspaceOptions,
+  defaultAppOptions,
 } from '../../../schematics-core/testing';
 
 describe('Action Schematic', () => {
@@ -16,7 +18,6 @@ describe('Action Schematic', () => {
   );
   const defaultOptions: ActionOptions = {
     name: 'foo',
-    // path: 'app',
     project: 'bar',
     spec: false,
     group: false,
@@ -31,6 +32,24 @@ describe('Action Schematic', () => {
     appTree = createWorkspace(schematicRunner, appTree);
   });
 
+  it('should create an action to specified project if provided', () => {
+    const options = {
+      ...defaultOptions,
+      project: 'baz',
+    };
+
+    const specifiedProjectPath = getTestProjectPath(defaultWorkspaceOptions, {
+      ...defaultAppOptions,
+      name: 'baz',
+    });
+
+    const tree = schematicRunner.runSchematic('action', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.actions.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
   it('should create one file', () => {
     const tree = schematicRunner.runSchematic(
       'action',

modules/schematics/src/action/schema.json

@@ -18,6 +18,12 @@
       "description": "The path to create the component.",
       "visible": false
     },
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "visible": false,
+      "aliases": ["p"]
+    },
     "spec": {
       "type": "boolean",
       "description": "Specifies if a spec file is generated.",

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

@@ -4,7 +4,6 @@ import {
 } from '@angular-devkit/schematics/testing';
 import * as path from 'path';
 import { Schema as ContainerOptions } from './schema';
-import {} from '../../schematics-core';
 import {
   getTestProjectPath,
   createWorkspace,
@@ -19,7 +18,6 @@ describe('Container Schematic', () => {
   const defaultOptions: ContainerOptions = {
     name: 'foo',
     project: 'bar',
-    // path: 'src/app',
     inlineStyle: false,
     inlineTemplate: false,
     changeDetection: 'Default',

modules/schematics/src/container/schema.json

@@ -13,7 +13,8 @@
     "project": {
       "type": "string",
       "description": "The name of the project.",
-      "visible": false
+      "visible": false,
+      "aliases": ["p"]
     },
     "name": {
       "type": "string",

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

@@ -3,12 +3,13 @@ import {
   UnitTestTree,
 } from '@angular-devkit/schematics/testing';
 import * as path from 'path';
-import {} from '../../schematics-core';
 import { Schema as EffectOptions } from './schema';
 import {
   getTestProjectPath,
   createWorkspace,
   createAppModuleWithEffects,
+  defaultWorkspaceOptions,
+  defaultAppOptions,
 } from '../../../schematics-core/testing';
 
 describe('Effect Schematic', () => {
@@ -19,7 +20,6 @@ describe('Effect Schematic', () => {
 
   const defaultOptions: EffectOptions = {
     name: 'foo',
-    // path: 'app',
     project: 'bar',
     spec: true,
     module: undefined,
@@ -37,6 +37,27 @@ describe('Effect Schematic', () => {
     appTree = createWorkspace(schematicRunner, appTree);
   });
 
+  it('should create an effect to specified project if provided', () => {
+    const options = {
+      ...defaultOptions,
+      project: 'baz',
+    };
+
+    const specifiedProjectPath = getTestProjectPath(defaultWorkspaceOptions, {
+      ...defaultAppOptions,
+      name: 'baz',
+    });
+
+    const tree = schematicRunner.runSchematic('effect', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo/foo.effects.spec.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo/foo.effects.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
   it('should create an effect with a spec file', () => {
     const options = { ...defaultOptions };
 

modules/schematics/src/effect/schema.json

@@ -18,6 +18,12 @@
       "description": "The path to create the component.",
       "visible": false
     },
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "visible": false,
+      "aliases": ["p"]
+    },
     "flat": {
       "type": "boolean",
       "default": true,

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

@@ -4,10 +4,11 @@ import {
 } from '@angular-devkit/schematics/testing';
 import * as path from 'path';
 import { Schema as EntityOptions } from './schema';
-import {} from '../../schematics-core';
 import {
   getTestProjectPath,
   createWorkspace,
+  defaultWorkspaceOptions,
+  defaultAppOptions,
 } from '../../../schematics-core/testing';
 
 describe('Entity Schematic', () => {
@@ -18,7 +19,6 @@ describe('Entity Schematic', () => {
   const defaultOptions: EntityOptions = {
     name: 'foo',
     project: 'bar',
-    // path: 'app',
     spec: false,
   };
 
@@ -48,6 +48,30 @@ describe('Entity Schematic', () => {
     ).toBeGreaterThanOrEqual(0);
   });
 
+  it('should create 3 files of an entity to specified project if provided', () => {
+    const options = {
+      ...defaultOptions,
+      project: 'baz',
+    };
+
+    const specifiedProjectPath = getTestProjectPath(defaultWorkspaceOptions, {
+      ...defaultAppOptions,
+      name: 'baz',
+    });
+
+    const tree = schematicRunner.runSchematic('entity', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.actions.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.model.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.reducer.ts`)
+    ).toBeGreaterThanOrEqual(0);
+  });
+
   it('should create a folder if flat is false', () => {
     const tree = schematicRunner.runSchematic(
       'entity',

modules/schematics/src/entity/schema.json

@@ -18,6 +18,12 @@
       "description": "The path to create the component.",
       "visible": false
     },
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "visible": false,
+      "aliases": ["p"]
+    },
     "spec": {
       "type": "boolean",
       "description": "Specifies if a spec file is generated.",

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

@@ -4,10 +4,11 @@ import {
 } from '@angular-devkit/schematics/testing';
 import * as path from 'path';
 import { Schema as FeatureOptions } from './schema';
-import {} from '../../schematics-core';
 import {
   getTestProjectPath,
   createWorkspace,
+  defaultWorkspaceOptions,
+  defaultAppOptions,
 } from '../../../schematics-core/testing';
 
 describe('Feature Schematic', () => {
@@ -18,7 +19,6 @@ describe('Feature Schematic', () => {
   const defaultOptions: FeatureOptions = {
     name: 'foo',
     project: 'bar',
-    // path: 'app',
     module: '',
     spec: true,
     group: false,
@@ -54,6 +54,36 @@ describe('Feature Schematic', () => {
     ).toBeGreaterThanOrEqual(0);
   });
 
+  it('should create all files of a feature to specified project if provided', () => {
+    const options = {
+      ...defaultOptions,
+      project: 'baz',
+    };
+
+    const specifiedProjectPath = getTestProjectPath(defaultWorkspaceOptions, {
+      ...defaultAppOptions,
+      name: 'baz',
+    });
+
+    const tree = schematicRunner.runSchematic('feature', options, appTree);
+    const files = tree.files;
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.actions.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.reducer.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.reducer.spec.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/foo.effects.ts`)
+    ).toBeGreaterThanOrEqual(0);
+    expect(
+      files.indexOf(`${specifiedProjectPath}/src/lib/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 };
 
@@ -85,12 +115,6 @@ describe('Feature Schematic', () => {
     };
 
     const tree = schematicRunner.runSchematic('feature', options, appTree);
-    const effectsFileContent = tree.readContent(
-      `${projectPath}/src/app/foo/effects/foo.effects.ts`
-    );
-    const reducerFileContent = tree.readContent(
-      `${projectPath}/src/app/foo/reducers/foo.reducer.ts`
-    );
     const moduleFileContent = tree.readContent(
       `${projectPath}/src/app/app.module.ts`
     );