feat(@schematics/angular): add option to setup new workspace or application as zoneless mode

Introduces option `--experimental-zoneless` to setup workspace or application as zoneless mode.

Author: aparzi

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2017 Google, Inc.
+Copyright (c) 2010-2024 Google LLC. https://angular.dev/license
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

packages/schematics/angular/application/files/module-files/src/main.ts.template

@@ -4,6 +4,7 @@
 import { AppModule } from './app/app.module';
 
 platformBrowserDynamic().bootstrapModule(AppModule, {
+  <% if(experimentalZoneless) { %>providers: [provideExperimentalZonelessChangeDetection()],} %>
   ngZoneEventCoalescing: true<% if(!!viewEncapsulation) { %>,
   defaultEncapsulation: ViewEncapsulation.<%= viewEncapsulation %><% } %>
 })

packages/schematics/angular/application/files/standalone-files/src/app/app.config.ts.template

@@ -4,5 +4,7 @@ import { provideRouter } from '@angular/router';
 import { routes } from './app.routes';<% } %>
 
 export const appConfig: ApplicationConfig = {
-  providers: [provideZoneChangeDetection({ eventCoalescing: true })<% if (routing) { %>, provideRouter(routes)<% } %>]
+  providers: [
+  <% if(experimentalZoneless) { %>providers: [provideExperimentalZonelessChangeDetection()],} %>
+  provideZoneChangeDetection({ eventCoalescing: true })<% if (routing) { %>, provideRouter(routes)<% } %>]
 };

packages/schematics/angular/application/index.ts

@@ -239,7 +239,7 @@ function addAppToWorkspaceFile(
           outputPath: `dist/${folderName}`,
           index: `${sourceRoot}/index.html`,
           browser: `${sourceRoot}/main.ts`,
-          polyfills: ['zone.js'],
+          polyfills: options.experimentalZoneless ? [] : ['zone.js'],
           tsConfig: `${projectRoot}tsconfig.app.json`,
           inlineStyleLanguage,
           assets: [{ 'glob': '**/*', 'input': `${projectRoot}public` }],
@@ -279,7 +279,7 @@ function addAppToWorkspaceFile(
         : {
             builder: Builders.Karma,
             options: {
-              polyfills: ['zone.js', 'zone.js/testing'],
+              polyfills: options.experimentalZoneless ? [] : ['zone.js', 'zone.js/testing'],
               tsConfig: `${projectRoot}tsconfig.spec.json`,
               inlineStyleLanguage,
               assets: [{ 'glob': '**/*', 'input': `${projectRoot}public` }],

packages/schematics/angular/application/schema.json

@@ -117,6 +117,11 @@
       "type": "boolean",
       "default": false,
       "x-user-analytics": "ep.ng_ssr"
+    },
+    "experimentalZoneless": {
+      "description": "Create an application that does not utilize zone.js.",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": ["name"]

packages/schematics/angular/ng-new/index.ts

@@ -39,6 +39,7 @@ export default function (options: NgNewOptions): Rule {
     minimal: options.minimal,
     strict: options.strict,
     packageManager: options.packageManager,
+    experimentalZoneless: options.experimentalZoneless,
   };
   const applicationOptions: ApplicationOptions = {
     projectRoot: '',
@@ -57,6 +58,7 @@ export default function (options: NgNewOptions): Rule {
     minimal: options.minimal,
     standalone: options.standalone,
     ssr: options.ssr,
+    experimentalZoneless: options.experimentalZoneless,
   };
 
   return chain([

packages/schematics/angular/ng-new/index_spec.ts

@@ -95,12 +95,21 @@ describe('Ng New Schematic', () => {
     expect(confContent.projects.foo.e2e).toBeUndefined();
   });
 
-  it('should add packageManager option in angular.json', async () => {
+  fit('should add packageManager option in angular.json', async () => {
     const tree = await schematicRunner.runSchematic('ng-new', {
       ...defaultOptions,
       packageManager: 'npm',
     });
     const { cli } = JSON.parse(tree.readContent('/bar/angular.json'));
     expect(cli.packageManager).toBe('npm');
   });
+
+  it('should add provideExperimentalZonelessChangeDetection in app.config', async () => {
+    const tree = await schematicRunner.runSchematic('ng-new', {
+      ...defaultOptions,
+      experimentalZoneless: true,
+    });
+    const fileContent = tree.readContent('/foo/src/app/app.config.ts');
+    expect(fileContent).toContain('provideExperimentalZonelessChangeDetection()');
+  });
 });

packages/schematics/angular/ng-new/schema.json

@@ -138,6 +138,11 @@
       "description": "Creates an application with Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) enabled.",
       "type": "boolean",
       "x-user-analytics": "ep.ng_ssr"
+    },
+    "experimentalZoneless": {
+      "description": "Create an application that does not utilize zone.js.",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": ["name", "version"]

packages/schematics/angular/workspace/schema.json

@@ -41,6 +41,11 @@
       "description": "The package manager used to install dependencies.",
       "type": "string",
       "enum": ["npm", "yarn", "pnpm", "cnpm", "bun"]
+    },
+    "experimentalZoneless": {
+      "description": "Create an application without dependencies related to zone.js (zoneless)",
+      "type": "boolean",
+      "default": false
     }
   },
   "required": ["name", "version"]