@angular-devkit/build-angular 17.1.0-next.2 → 17.1.0-rc.0

package/src/builders/web-test-runner/schema.d.ts

@@ -0,0 +1,188 @@
+/**
+ * Web Test Runner target options for Build Facade.
+ */
+export interface Schema {
+    /**
+     * List of static application assets.
+     */
+    assets?: AssetPattern[];
+    /**
+     * Override which browsers tests are run against.
+     */
+    browsers?: string;
+    /**
+     * Output a code coverage report.
+     */
+    codeCoverage?: boolean;
+    /**
+     * Globs to exclude from code coverage.
+     */
+    codeCoverageExclude?: string[];
+    /**
+     * Globs of files to exclude, relative to the project root.
+     */
+    exclude?: string[];
+    /**
+     * Replace compilation source files with other compilation source files in the build.
+     */
+    fileReplacements?: FileReplacement[];
+    /**
+     * Globs of files to include, relative to project root.
+     * There are 2 special cases:
+     * - when a path to directory is provided, all spec files ending ".spec.@(ts|tsx)" will be
+     * included
+     * - when a path to a file is provided, and a matching spec file exists it will be included
+     * instead.
+     */
+    include?: string[];
+    /**
+     * The stylesheet language to use for the application's inline component styles.
+     */
+    inlineStyleLanguage?: InlineStyleLanguage;
+    /**
+     * The name of the main entry-point file.
+     */
+    main?: string;
+    /**
+     * Enable and define the file watching poll time period in milliseconds.
+     */
+    poll?: number;
+    /**
+     * Polyfills to be included in the build.
+     */
+    polyfills?: Polyfills;
+    /**
+     * Do not use the real path when resolving modules. If unset then will default to `true` if
+     * NodeJS option --preserve-symlinks is set.
+     */
+    preserveSymlinks?: boolean;
+    /**
+     * Log progress to the console while building.
+     */
+    progress?: boolean;
+    /**
+     * Global scripts to be included in the build.
+     */
+    scripts?: ScriptElement[];
+    /**
+     * Output source maps for scripts and styles. For more information, see
+     * https://angular.io/guide/workspace-config#source-map-configuration.
+     */
+    sourceMap?: SourceMapUnion;
+    /**
+     * Options to pass to style preprocessors
+     */
+    stylePreprocessorOptions?: StylePreprocessorOptions;
+    /**
+     * Global styles to be included in the build.
+     */
+    styles?: StyleElement[];
+    /**
+     * The name of the TypeScript configuration file.
+     */
+    tsConfig: string;
+    /**
+     * Run build when files change.
+     */
+    watch?: boolean;
+    /**
+     * TypeScript configuration for Web Worker modules.
+     */
+    webWorkerTsConfig?: string;
+}
+export type AssetPattern = AssetPatternClass | string;
+export interface AssetPatternClass {
+    /**
+     * The pattern to match.
+     */
+    glob: string;
+    /**
+     * An array of globs to ignore.
+     */
+    ignore?: string[];
+    /**
+     * The input directory path in which to apply 'glob'. Defaults to the project root.
+     */
+    input: string;
+    /**
+     * Absolute path within the output.
+     */
+    output: string;
+}
+export interface FileReplacement {
+    replace?: string;
+    replaceWith?: string;
+    src?: string;
+    with?: string;
+}
+/**
+ * The stylesheet language to use for the application's inline component styles.
+ */
+export declare enum InlineStyleLanguage {
+    Css = "css",
+    Less = "less",
+    Sass = "sass",
+    Scss = "scss"
+}
+/**
+ * Polyfills to be included in the build.
+ */
+export type Polyfills = string[] | string;
+export type ScriptElement = ScriptClass | string;
+export interface ScriptClass {
+    /**
+     * The bundle name for this extra entry point.
+     */
+    bundleName?: string;
+    /**
+     * If the bundle will be referenced in the HTML file.
+     */
+    inject?: boolean;
+    /**
+     * The file to include.
+     */
+    input: string;
+}
+/**
+ * Output source maps for scripts and styles. For more information, see
+ * https://angular.io/guide/workspace-config#source-map-configuration.
+ */
+export type SourceMapUnion = boolean | SourceMapClass;
+export interface SourceMapClass {
+    /**
+     * Output source maps for all scripts.
+     */
+    scripts?: boolean;
+    /**
+     * Output source maps for all styles.
+     */
+    styles?: boolean;
+    /**
+     * Resolve vendor packages source maps.
+     */
+    vendor?: boolean;
+}
+/**
+ * Options to pass to style preprocessors
+ */
+export interface StylePreprocessorOptions {
+    /**
+     * Paths to include. Paths will be resolved to workspace root.
+     */
+    includePaths?: string[];
+}
+export type StyleElement = StyleClass | string;
+export interface StyleClass {
+    /**
+     * The bundle name for this extra entry point.
+     */
+    bundleName?: string;
+    /**
+     * If the bundle will be referenced in the HTML file.
+     */
+    inject?: boolean;
+    /**
+     * The file to include.
+     */
+    input: string;
+}

package/src/builders/web-test-runner/schema.js

@@ -0,0 +1,15 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED. TO UPDATE THIS FILE YOU NEED TO CHANGE THE
+// CORRESPONDING JSON SCHEMA FILE, THEN RUN devkit-admin build (or bazel build ...).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InlineStyleLanguage = void 0;
+/**
+ * The stylesheet language to use for the application's inline component styles.
+ */
+var InlineStyleLanguage;
+(function (InlineStyleLanguage) {
+    InlineStyleLanguage["Css"] = "css";
+    InlineStyleLanguage["Less"] = "less";
+    InlineStyleLanguage["Sass"] = "sass";
+    InlineStyleLanguage["Scss"] = "scss";
+})(InlineStyleLanguage || (exports.InlineStyleLanguage = InlineStyleLanguage = {}));

package/src/builders/web-test-runner/schema.json

@@ -0,0 +1,291 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "Web Test Runner Target",
+  "description": "Web Test Runner target options for Build Facade.",
+  "type": "object",
+  "properties": {
+    "main": {
+      "type": "string",
+      "description": "The name of the main entry-point file."
+    },
+    "tsConfig": {
+      "type": "string",
+      "description": "The name of the TypeScript configuration file."
+    },
+    "polyfills": {
+      "description": "Polyfills to be included in the build.",
+      "oneOf": [
+        {
+          "type": "array",
+          "description": "A list of polyfills to include in the build. Can be a full path for a file, relative to the current workspace or module specifier. Example: 'zone.js'.",
+          "items": {
+            "type": "string",
+            "uniqueItems": true
+          },
+          "default": []
+        },
+        {
+          "type": "string",
+          "description": "The full path for the polyfills file, relative to the current workspace or a module specifier. Example: 'zone.js'."
+        }
+      ]
+    },
+    "assets": {
+      "type": "array",
+      "description": "List of static application assets.",
+      "default": [],
+      "items": {
+        "$ref": "#/definitions/assetPattern"
+      }
+    },
+    "scripts": {
+      "description": "Global scripts to be included in the build.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "input": {
+                "type": "string",
+                "description": "The file to include.",
+                "pattern": "\\.[cm]?jsx?$"
+              },
+              "bundleName": {
+                "type": "string",
+                "pattern": "^[\\w\\-.]*$",
+                "description": "The bundle name for this extra entry point."
+              },
+              "inject": {
+                "type": "boolean",
+                "description": "If the bundle will be referenced in the HTML file.",
+                "default": true
+              }
+            },
+            "additionalProperties": false,
+            "required": ["input"]
+          },
+          {
+            "type": "string",
+            "description": "The file to include.",
+            "pattern": "\\.[cm]?jsx?$"
+          }
+        ]
+      }
+    },
+    "styles": {
+      "description": "Global styles to be included in the build.",
+      "type": "array",
+      "default": [],
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "input": {
+                "type": "string",
+                "description": "The file to include.",
+                "pattern": "\\.(?:css|scss|sass|less)$"
+              },
+              "bundleName": {
+                "type": "string",
+                "pattern": "^[\\w\\-.]*$",
+                "description": "The bundle name for this extra entry point."
+              },
+              "inject": {
+                "type": "boolean",
+                "description": "If the bundle will be referenced in the HTML file.",
+                "default": true
+              }
+            },
+            "additionalProperties": false,
+            "required": ["input"]
+          },
+          {
+            "type": "string",
+            "description": "The file to include.",
+            "pattern": "\\.(?:css|scss|sass|less)$"
+          }
+        ]
+      }
+    },
+    "inlineStyleLanguage": {
+      "description": "The stylesheet language to use for the application's inline component styles.",
+      "type": "string",
+      "default": "css",
+      "enum": ["css", "less", "sass", "scss"]
+    },
+    "stylePreprocessorOptions": {
+      "description": "Options to pass to style preprocessors",
+      "type": "object",
+      "properties": {
+        "includePaths": {
+          "description": "Paths to include. Paths will be resolved to workspace root.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        }
+      },
+      "additionalProperties": false
+    },
+    "include": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": ["**/*.spec.ts"],
+      "description": "Globs of files to include, relative to project root. \nThere are 2 special cases:\n - when a path to directory is provided, all spec files ending \".spec.@(ts|tsx)\" will be included\n - when a path to a file is provided, and a matching spec file exists it will be included instead."
+    },
+    "exclude": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": [],
+      "description": "Globs of files to exclude, relative to the project root."
+    },
+    "sourceMap": {
+      "description": "Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.",
+      "default": true,
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "scripts": {
+              "type": "boolean",
+              "description": "Output source maps for all scripts.",
+              "default": true
+            },
+            "styles": {
+              "type": "boolean",
+              "description": "Output source maps for all styles.",
+              "default": true
+            },
+            "vendor": {
+              "type": "boolean",
+              "description": "Resolve vendor packages source maps.",
+              "default": false
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    },
+    "progress": {
+      "type": "boolean",
+      "description": "Log progress to the console while building.",
+      "default": true
+    },
+    "watch": {
+      "type": "boolean",
+      "description": "Run build when files change."
+    },
+    "poll": {
+      "type": "number",
+      "description": "Enable and define the file watching poll time period in milliseconds."
+    },
+    "preserveSymlinks": {
+      "type": "boolean",
+      "description": "Do not use the real path when resolving modules. If unset then will default to `true` if NodeJS option --preserve-symlinks is set."
+    },
+    "browsers": {
+      "type": "string",
+      "description": "Override which browsers tests are run against."
+    },
+    "codeCoverage": {
+      "type": "boolean",
+      "description": "Output a code coverage report.",
+      "default": false
+    },
+    "codeCoverageExclude": {
+      "type": "array",
+      "description": "Globs to exclude from code coverage.",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "fileReplacements": {
+      "description": "Replace compilation source files with other compilation source files in the build.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "replaceWith": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["src", "replaceWith"]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "replace": {
+                "type": "string"
+              },
+              "with": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["replace", "with"]
+          }
+        ]
+      },
+      "default": []
+    },
+    "webWorkerTsConfig": {
+      "type": "string",
+      "description": "TypeScript configuration for Web Worker modules."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["tsConfig"],
+  "definitions": {
+    "assetPattern": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "glob": {
+              "type": "string",
+              "description": "The pattern to match."
+            },
+            "input": {
+              "type": "string",
+              "description": "The input directory path in which to apply 'glob'. Defaults to the project root."
+            },
+            "output": {
+              "type": "string",
+              "description": "Absolute path within the output."
+            },
+            "ignore": {
+              "description": "An array of globs to ignore.",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false,
+          "required": ["glob", "input", "output"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    }
+  }
+}

package/src/builders/web-test-runner/test_page.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf8">
+    <title>Unit tests</title>
+
+    <script type="module">
+      (async () => {
+        // To initialize tests correctly we load things in a very particular order.
+
+        // Step 1. Load user polyfills (including `zone.js`). Does *not* include `zone.js/testing`, which gets executed after Jasmine.
+        await import('./polyfills.js');
+
+        // Step 2. Import Jasmine.
+        // Jasmine gets wrapped into a CommonJS context by the bundling process which makes it think it is running in NodeJS, so it does not
+        // find the `window` global. Assign this to the NodeJS `global` symbol so Jasmine initializes correctly.
+        window.global = window;
+        const { default: jasmineRequire } = await import('./jasmine.js');
+        delete window.global; // Avoid leaking `global` into user tests or libraries, which might think they are running in NodeJS.
+
+        // Step 3. Initialize Jasmine on the page. Doing this after `zone.js` means Zone can patch browser globals before Jasmine runs.
+        // Doing this before `zone.js/testing`, means Zone can patch Jasmine-defined globals.
+        const jasmine = jasmineRequire.core(jasmineRequire);
+        const jasmineGlobal = jasmine.getGlobal();
+        jasmineGlobal.jasmine = jasmine;
+        const jasmineEnv = jasmine.getEnv();
+        Object.assign(window, jasmineRequire.interface(jasmine, jasmineEnv));
+
+        // Step 4. Import `zone.js/testing`, which will find and patch Jasmine globals from steps 2. and 3.
+        // https://github.com/angular/angular/blob/af4f5df150d527a1b523def1eb51d2b661a25f83/packages/zone.js/lib/jasmine/jasmine.ts
+        await import('./testing.js');
+
+        // Step 5. Run the actual tests.
+        const { runJasmineTests } = await import('./jasmine_runner.js');
+        await runJasmineTests(jasmineEnv);
+      })();
+    </script>
+  </head>
+  <body></body>
+</html>

package/src/tools/esbuild/angular/angular-host.js

@@ -46,7 +46,7 @@ function createAngularCompilerHost(compilerOptions, hostOptions) {
             return null;
         }
         const result = await hostOptions.transformStylesheet(data, context.containingFile, context.resourceFile ?? undefined);
-        return result ? { content: result } : null;
+        return typeof result === 'string' ? { content: result } : null;
     };
     // Allow the AOT compiler to request the set of changed templates and styles
     host.getModifiedResourceFiles = function () {

package/src/tools/esbuild/angular/compiler-plugin.js

@@ -35,7 +35,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCompilerPlugin = void 0;
 const node_assert_1 = __importDefault(require("node:assert"));
-const node_fs_1 = require("node:fs");
 const path = __importStar(require("node:path"));
 const environment_options_1 = require("../../../utils/environment-options");
 const javascript_transformer_1 = require("../javascript-transformer");
@@ -54,18 +53,6 @@ function createCompilerPlugin(pluginOptions, styleOptions) {
         async setup(build) {
             let setupWarnings = [];
             const preserveSymlinks = build.initialOptions.preserveSymlinks;
-            let tsconfigPath = pluginOptions.tsconfig;
-            if (!preserveSymlinks) {
-                // Use the real path of the tsconfig if not preserving symlinks.
-                // This ensures the TS source file paths are based on the real path of the configuration.
-                // NOTE: promises.realpath should not be used here since it uses realpath.native which
-                // can cause case conversion and other undesirable behavior on Windows systems.
-                // ref: https://github.com/nodejs/node/issues/7726
-                try {
-                    tsconfigPath = (0, node_fs_1.realpathSync)(tsconfigPath);
-                }
-                catch { }
-            }
             // Initialize a worker pool for JavaScript transformations
             const javascriptTransformer = new javascript_transformer_1.JavaScriptTransformer(pluginOptions, environment_options_1.maxWorkers);
             // Setup defines based on the values used by the Angular compiler-cli
@@ -132,14 +119,14 @@ function createCompilerPlugin(pluginOptions, styleOptions) {
                         else {
                             stylesheetResult = await stylesheetBundler.bundleInline(data, containingFile, styleOptions.inlineStyleLanguage);
                         }
-                        const { contents, resourceFiles, referencedFiles, errors, warnings } = stylesheetResult;
+                        const { contents, outputFiles, metafile, referencedFiles, errors, warnings } = stylesheetResult;
                         if (errors) {
                             (result.errors ??= []).push(...errors);
                         }
                         (result.warnings ??= []).push(...warnings);
                         additionalResults.set(stylesheetFile ?? containingFile, {
-                            outputFiles: resourceFiles,
-                            metafile: stylesheetResult.metafile,
+                            outputFiles,
+                            metafile,
                         });
                         if (referencedFiles) {
                             referencedFileTracker.add(containingFile, referencedFiles);
@@ -185,7 +172,7 @@ function createCompilerPlugin(pluginOptions, styleOptions) {
                 // In watch mode, previous build state will be reused.
                 let referencedFiles;
                 try {
-                    const initializationResult = await compilation.initialize(tsconfigPath, hostOptions, createCompilerOptionsTransformer(setupWarnings, pluginOptions, preserveSymlinks));
+                    const initializationResult = await compilation.initialize(pluginOptions.tsconfig, hostOptions, createCompilerOptionsTransformer(setupWarnings, pluginOptions, preserveSymlinks));
                     shouldTsIgnoreJs = !initializationResult.compilerOptions.allowJs;
                     referencedFiles = initializationResult.referencedFiles;
                 }
@@ -401,22 +388,19 @@ function createCompilerOptionsTransformer(setupWarnings, pluginOptions, preserve
 function bundleWebWorker(build, pluginOptions, workerFile) {
     try {
         return build.esbuild.buildSync({
+            ...build.initialOptions,
             platform: 'browser',
             write: false,
             bundle: true,
             metafile: true,
             format: 'esm',
-            mainFields: ['es2020', 'es2015', 'browser', 'module', 'main'],
-            logLevel: 'silent',
-            sourcemap: pluginOptions.sourcemap,
             entryNames: 'worker-[hash]',
             entryPoints: [workerFile],
-            absWorkingDir: build.initialOptions.absWorkingDir,
-            outdir: build.initialOptions.outdir,
-            minifyIdentifiers: build.initialOptions.minifyIdentifiers,
-            minifySyntax: build.initialOptions.minifySyntax,
-            minifyWhitespace: build.initialOptions.minifyWhitespace,
-            target: build.initialOptions.target,
+            sourcemap: pluginOptions.sourcemap,
+            // Zone.js is not used in Web workers so no need to disable
+            supported: undefined,
+            // Plugins are not supported in sync esbuild calls
+            plugins: undefined,
         });
     }
     catch (error) {

package/src/tools/esbuild/angular/component-stylesheets.d.ts

@@ -26,9 +26,7 @@ export declare class ComponentStylesheetBundler {
         errors: import("esbuild").Message[] | undefined;
         warnings: import("esbuild").Message[];
         contents: string;
-        map: string | undefined;
-        path: string | undefined;
-        resourceFiles: OutputFile[];
+        outputFiles: OutputFile[];
         metafile: import("esbuild").Metafile | undefined;
         referencedFiles: Set<string> | undefined;
     }>;
@@ -36,12 +34,11 @@ export declare class ComponentStylesheetBundler {
         errors: import("esbuild").Message[] | undefined;
         warnings: import("esbuild").Message[];
         contents: string;
-        map: string | undefined;
-        path: string | undefined;
-        resourceFiles: OutputFile[];
+        outputFiles: OutputFile[];
         metafile: import("esbuild").Metafile | undefined;
         referencedFiles: Set<string> | undefined;
     }>;
     invalidate(files: Iterable<string>): void;
     dispose(): Promise<void>;
+    private extractResult;
 }