Set entityConfig true as default

ngrx · Oct 9, 2019 · 120a200 · 120a200
1 parent ee1d059
commit 120a200
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 31 deletions.
diff --git a/modules/data/schematics/ng-add/files/entity-metadata.ts.template b/modules/data/schematics/ng-add/files/entity-metadata.ts.template
@@ -1,10 +1,10 @@
-import { EntityMetadataMap } from '@ngrx/data';
+import { EntityMetadataMap, EntityDataModuleConfig } from '@ngrx/data';
 
 const entityMetadata: EntityMetadataMap = {};
 
 const pluralNames = {  };
 
-export const entityConfig = {
+export const entityConfig: EntityDataModuleConfig = {
   entityMetadata,
   pluralNames
 };
diff --git a/modules/data/schematics/ng-add/index.spec.ts b/modules/data/schematics/ng-add/index.spec.ts
@@ -68,26 +68,26 @@ describe('Data ng-add Schematic', () => {
     expect(thrownError).toBeDefined();
   });
 
-  it('should import EntityDataModuleWithoutEffects into a specified module', () => {
-    const options = {
-      ...defaultOptions,
-      module: 'app.module.ts',
-      effects: false,
-    };
+  it('should add entity-metadata config to EntityDataModule', () => {
+    const options = { ...defaultOptions, effects: false, entityConfig: true };
 
     const tree = schematicRunner.runSchematic('ng-add', options, appTree);
     const content = tree.readContent(`${projectPath}/src/app/app.module.ts`);
     expect(content).toMatch(
-      /import { EntityDataModuleWithoutEffects } from '@ngrx\/data'/
+      /import { entityConfig } from '.\/entity-metadata'/
+    );
+    expect(content).toMatch(
+      /EntityDataModuleWithoutEffects.forRoot\(entityConfig\)/
     );
   });
 
-  it('should register EntityDataModule in the provided module', () => {
-    const options = { ...defaultOptions };
+  it('should add entity-metadata config file', () => {
+    const options = { ...defaultOptions, entityConfig: true };
 
     const tree = schematicRunner.runSchematic('ng-add', options, appTree);
-    const content = tree.readContent(`${projectPath}/src/app/app.module.ts`);
-    expect(content).toMatch(/EntityDataModule\n/);
+    expect(
+      tree.files.indexOf(`${projectPath}/src/app/entity-metadata.ts`)
+    ).toBeGreaterThanOrEqual(0);
   });
 
   it('should add entity-metadata config to EntityDataModule', () => {
@@ -101,34 +101,35 @@ describe('Data ng-add Schematic', () => {
     expect(content).toMatch(/EntityDataModule.forRoot\(entityConfig\)/);
   });
 
-  it('should register EntityDataModuleWithoutEffects in the provided module', () => {
-    const options = { ...defaultOptions, effects: false };
+  it('should import EntityDataModuleWithoutEffects into a specified module', () => {
+    const options = {
+      ...defaultOptions,
+      module: 'app.module.ts',
+      effects: false,
+      entityConfig: false,
+    };
 
     const tree = schematicRunner.runSchematic('ng-add', options, appTree);
     const content = tree.readContent(`${projectPath}/src/app/app.module.ts`);
-    expect(content).toMatch(/EntityDataModuleWithoutEffects\n/);
+    expect(content).toMatch(
+      /import { EntityDataModuleWithoutEffects } from '@ngrx\/data'/
+    );
   });
 
-  it('should add entity-metadata config to EntityDataModule', () => {
-    const options = { ...defaultOptions, effects: false, entityConfig: true };
+  it('should register EntityDataModule in the provided module', () => {
+    const options = { ...defaultOptions, entityConfig: false };
 
     const tree = schematicRunner.runSchematic('ng-add', options, appTree);
     const content = tree.readContent(`${projectPath}/src/app/app.module.ts`);
-    expect(content).toMatch(
-      /import { entityConfig } from '.\/entity-metadata'/
-    );
-    expect(content).toMatch(
-      /EntityDataModuleWithoutEffects.forRoot\(entityConfig\)/
-    );
+    expect(content).toMatch(/EntityDataModule\n/);
   });
 
-  it('should add entity-metadata config file', () => {
-    const options = { ...defaultOptions, entityConfig: true };
+  it('should register EntityDataModuleWithoutEffects in the provided module', () => {
+    const options = { ...defaultOptions, effects: false, entityConfig: false };
 
     const tree = schematicRunner.runSchematic('ng-add', options, appTree);
-    expect(
-      tree.files.indexOf(`${projectPath}/src/app/entity-metadata.ts`)
-    ).toBeGreaterThanOrEqual(0);
+    const content = tree.readContent(`${projectPath}/src/app/app.module.ts`);
+    expect(content).toMatch(/EntityDataModuleWithoutEffects\n/);
   });
 
   describe('Migration of ngrx-data', () => {

diff --git a/modules/data/schematics/ng-add/schema.json b/modules/data/schematics/ng-add/schema.json
@@ -42,7 +42,7 @@
     },
     "entityConfig": {
       "type": "boolean",
-      "default": false,
+      "default": true,
       "description": "Create the Entity config file"
     }
   },

diff --git a/projects/ngrx.io/content/guide/data/install.md b/projects/ngrx.io/content/guide/data/install.md
@@ -30,7 +30,7 @@ ng add @ngrx/data
 * module - name of file containing the module that you wish to add the import for the `EntityDataModule` to. Can also include the relative path to the file. For example, `src/app/app.module.ts`.
 * effects - if `false` it will use the `EntityDataModuleWithoutEffects` module instead of the default `EntityDataModule`.
 * migrateNgRxData - if `true` it will replace the `ngrx-data` module with the `@ngrx/data` module.
-* entityConfig - if `true` it will create and declare the `entity-metadata` file.
+* entityConfig - if `false` it will not create and declare the `entity-metadata` file.
 
 This command will automate the following steps: