feat: flag to skip adding auto-generated component on ng new and ng add (#171)

Author: d-koppenhagen

src/add-ns/_ns-files/__sourceDir__/app/__entryComponentName@dasherize__.component__nsext__.html

@@ -1,3 +1,4 @@
 <!-- https://docs.nativescript.org/angular/core-concepts/angular-navigation.html#page-router-outlet -->
 <page-router-outlet></page-router-outlet>
-<!-- <Label text="Entry Component works" textWrap="true"></Label> -->
+<% if (skipAutoGeneratedComponent && !sample) { %><Label text="Entry Component works" textWrap="true"></Label>
+<% } %>

src/add-ns/_ns-files/__sourceDir__/app/app-routing.module__nsext__.ts

@@ -1,20 +1,20 @@
 import { NgModule } from '@angular/core';
 import { NativeScriptRouterModule } from 'nativescript-angular/router';
 import { Routes } from '@angular/router';
-
+<% if (!skipAutoGeneratedComponent) { %>
 import { AutoGeneratedComponent } from './auto-generated/auto-generated.component';
-
-export const routes: Routes = [
+<% } %>
+export const routes: Routes = [<% if (!skipAutoGeneratedComponent || sample) { %>
   {
       path: '',
-      redirectTo: <% if (sample) { %>'/players'<% } else { %>'/auto-generated'<% } %>,
+      redirectTo: <% if (sample) { %>'/players'<% } else if (!skipAutoGeneratedComponent) { %>'/auto-generated'<% } %>,
       pathMatch: 'full',
-  },
+  },<% if (!skipAutoGeneratedComponent) { %>
   {
       path: 'auto-generated',
       component: AutoGeneratedComponent,
-  },
-];
+  },<% } %>
+<% } %>];
 
 @NgModule({
   imports: [NativeScriptRouterModule.forRoot(routes)],

src/add-ns/index.ts

@@ -33,7 +33,6 @@ export default function (options: MigrationOptions): Rule {
 
   return chain([
     validateOptions(options),
-
     getProjectSettings(options.project),
 
     addNativeScriptSchematics,
@@ -48,7 +47,10 @@ export default function (options: MigrationOptions): Rule {
     addRunScriptsToPackageJson,
     addNativeScriptProjectId,
     excludeNsFilesFromTsconfig,
-    addSampleComponent(options.nsExtension, options.webExtension, options.project),
+ 
+    options.skipAutoGeneratedComponent ?
+      noop() :
+      addSampleComponent(options.nsExtension, options.webExtension, options.project),
 
     addDependencies(),
 
@@ -100,6 +102,7 @@ const addNsFiles = (options: MigrationOptions) => (_tree: Tree, context: Schemat
   context.logger.info('Adding {N} files');
   const templateOptions = {
     sample: options.sample,
+    skipAutoGeneratedComponent: options.skipAutoGeneratedComponent,
     theme: true,
 
     dasherize,
@@ -148,7 +151,6 @@ const addSampleFiles = () => (_tree: Tree, context: SchematicContext) => {
 const addSampleComponent = (nsExtension: string, webExtension: string, project: string) =>
   (_tree, context: SchematicContext) => {
     context.logger.info('Adding Sample Shared Component');
-
     return schematic('component', {
       nsExtension: nsExtension,
       webExtension: webExtension,

src/add-ns/index_spec.ts

@@ -17,6 +17,7 @@ describe('Add {N} schematic', () => {
         nsExtension: 'tns',
         webExtension: '',
         sample: false,
+        skipAutoGeneratedComponent: false
     };
 
     let appTree: UnitTestTree;
@@ -121,9 +122,49 @@ describe('Add {N} schematic', () => {
 
         it('should generate a sample shared component', () => {
             const { files } = appTree;
+            const appRoutingModuleContent = appTree.readContent('/foo/src/app/app-routing.module.tns.ts');
+            const appComponentTemplate = appTree.readContent('/foo/src/app/app.component.tns.html');
             expect(files).toContain('/foo/src/app/auto-generated/auto-generated.component.ts');
             expect(files).toContain('/foo/src/app/auto-generated/auto-generated.component.html');
             expect(files).toContain('/foo/src/app/auto-generated/auto-generated.component.tns.html');
+            expect(appRoutingModuleContent).toMatch(
+                /import { AutoGeneratedComponent } from '.\/auto-generated\/auto-generated.component'/
+            );
+            expect(appRoutingModuleContent).toMatch(
+                /{\s+path: 'auto-generated',\s+component: AutoGeneratedComponent,\s+},/g
+            );
+            expect(appComponentTemplate).not.toContain(
+                '<Label text="Entry Component works" textWrap="true"></Label>'
+            );
+        });
+    });
+
+    describe('when the skipAutoGeneratedComponent flag is raised', () => {
+        beforeEach(() => {
+            const options = {
+                ...defaultOptions,
+                skipAutoGeneratedComponent: true,
+            };
+
+            appTree = schematicRunner.runSchematic('add-ns', options, appTree);
+        });
+
+        it('should not add a sample shared component', () => {
+            const { files } = appTree;
+            const appRoutingModuleContent = appTree.readContent('/foo/src/app/app-routing.module.tns.ts');
+            const appComponentTemplate = appTree.readContent('/foo/src/app/app.component.tns.html');
+            expect(files.includes('/foo/src/app/auto-generated/auto-generated.component.css')).toBeFalsy();
+            expect(files.includes('/foo/src/app/auto-generated/auto-generated.component.html')).toBeFalsy();
+            expect(files.includes('/foo/src/app/auto-generated/auto-generated.component.ts')).toBeFalsy();
+            expect(appRoutingModuleContent).not.toMatch(
+                /import { AutoGeneratedComponent } from '.\/auto-generated\/auto-generated.component'/
+            );
+            expect(appRoutingModuleContent).toContain(
+                'export const routes: Routes = []'
+            );
+            expect(appComponentTemplate).toContain(
+                '<Label text="Entry Component works" textWrap="true"></Label>'
+            );
         });
     });
 
@@ -154,6 +195,13 @@ describe('Add {N} schematic', () => {
             expect(files.includes('/foo/src/app/barcelona/player-detail/player-detail.component.html')).toBeTruthy();
             expect(files.includes('/foo/src/app/barcelona/player-detail/player-detail.component.tns.html')).toBeTruthy();
         });
+
+        it('should configure routing for redirection', () => {
+            const appRoutingModuleContent = appTree.readContent('/foo/src/app/app-routing.module.tns.ts');
+            expect(appRoutingModuleContent).toMatch(
+                /{\s+path: '',\s+redirectTo: '\/players',\s+pathMatch: 'full',\s+},/g
+            );
+        });
     });
 });
 

src/add-ns/schema.d.ts

@@ -15,9 +15,13 @@ export interface Schema {
   /**
    * Specifies whether a sample master detail should be generated.
    */
-  sample: boolean; 
+  sample: boolean;
   /**
    * Skip installing dependency packages.
    */
   skipInstall?: boolean;
+  /**
+   * Skip adding an example component.
+   */
+  skipAutoGeneratedComponent?: boolean;
 }

src/add-ns/schema.json

@@ -30,6 +30,11 @@
       "description": "Skip installing dependency packages.",
       "type": "boolean",
       "default": false
+    },
+    "skipAutoGeneratedComponent": {
+      "description": "Skip adding an example component.",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": [

src/ng-new/index.ts

@@ -42,6 +42,7 @@ const parseToSharedOptions = (options: NgNewOptions): SharedOptions => {
     style: options.style,
     theme: options.theme,
     sample: options.sample,
+    skipAutoGeneratedComponent: options.skipAutoGeneratedComponent
   };
 }
 

src/ng-new/schema.d.ts

@@ -30,5 +30,9 @@ export interface Schema {
     /**
      * Specifies whether a sample master detail should be generated.
      */
-    sample: boolean; 
+    sample: boolean;
+    /**
+     * Skip adding an example component.
+     */
+    skipAutoGeneratedComponent?: boolean;
 }

src/ng-new/shared/schema.d.ts

@@ -22,5 +22,9 @@ export interface Schema {
     /**
      * Specifies whether a sample master detail should be generated.
      */
-    sample: boolean; 
+    sample: boolean;
+    /**
+     * Skip adding an example component.
+     */
+    skipAutoGeneratedComponent?: boolean;
 }