@schematics/angular 20.2.0-next.2 → 20.2.0-rc.0

package/migrations/karma/karma-config-comparer.js

@@ -0,0 +1,89 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDefaultKarmaConfig = generateDefaultKarmaConfig;
+exports.compareKarmaConfigs = compareKarmaConfigs;
+exports.hasDifferences = hasDifferences;
+exports.compareKarmaConfigToDefault = compareKarmaConfigToDefault;
+const promises_1 = require("node:fs/promises");
+const posix_1 = __importDefault(require("node:path/posix"));
+const node_util_1 = require("node:util");
+const paths_1 = require("../../utility/paths");
+const karma_config_analyzer_1 = require("./karma-config-analyzer");
+/**
+ * Generates the default Karma configuration file content as a string.
+ * @param relativePathToWorkspaceRoot The relative path from the Karma config file to the workspace root.
+ * @param projectName The name of the project.
+ * @param needDevkitPlugin A boolean indicating if the devkit plugin is needed.
+ * @returns The content of the default `karma.conf.js` file.
+ */
+async function generateDefaultKarmaConfig(relativePathToWorkspaceRoot, projectName, needDevkitPlugin) {
+    const templatePath = posix_1.default.join(__dirname, '../../config/files/karma.conf.js.template');
+    let template = await (0, promises_1.readFile)(templatePath, 'utf-8');
+    // TODO: Replace this with the actual schematic templating logic.
+    template = template
+        .replace(/<%= relativePathToWorkspaceRoot %>/g, posix_1.default.normalize(relativePathToWorkspaceRoot).replace(/\\/g, '/'))
+        .replace(/<%= folderName %>/g, projectName);
+    const devkitPluginRegex = /<% if \(needDevkitPlugin\) { %>(.*?)<% } %>/gs;
+    const replacement = needDevkitPlugin ? '$1' : '';
+    template = template.replace(devkitPluginRegex, replacement);
+    return template;
+}
+/**
+ * Compares two Karma configuration analyses and returns the difference.
+ * @param projectAnalysis The analysis of the project's configuration.
+ * @param defaultAnalysis The analysis of the default configuration to compare against.
+ * @returns A diff object representing the changes between the two configurations.
+ */
+function compareKarmaConfigs(projectAnalysis, defaultAnalysis) {
+    const added = new Map();
+    const removed = new Map();
+    const modified = new Map();
+    const allKeys = new Set([...projectAnalysis.settings.keys(), ...defaultAnalysis.settings.keys()]);
+    for (const key of allKeys) {
+        const projectValue = projectAnalysis.settings.get(key);
+        const defaultValue = defaultAnalysis.settings.get(key);
+        if (projectValue !== undefined && defaultValue === undefined) {
+            added.set(key, projectValue);
+        }
+        else if (projectValue === undefined && defaultValue !== undefined) {
+            removed.set(key, defaultValue);
+        }
+        else if (projectValue !== undefined && defaultValue !== undefined) {
+            if (!(0, node_util_1.isDeepStrictEqual)(projectValue, defaultValue)) {
+                modified.set(key, { projectValue, defaultValue });
+            }
+        }
+    }
+    return {
+        added,
+        removed,
+        modified,
+        isReliable: !projectAnalysis.hasUnsupportedValues && !defaultAnalysis.hasUnsupportedValues,
+    };
+}
+/**
+ * Checks if there are any differences in the provided Karma configuration diff.
+ * @param diff The Karma configuration diff object to check.
+ * @returns True if there are any differences; false otherwise.
+ */
+function hasDifferences(diff) {
+    return diff.added.size > 0 || diff.removed.size > 0 || diff.modified.size > 0;
+}
+async function compareKarmaConfigToDefault(projectConfigOrAnalysis, projectName, karmaConfigPath, needDevkitPlugin) {
+    const projectAnalysis = typeof projectConfigOrAnalysis === 'string'
+        ? (0, karma_config_analyzer_1.analyzeKarmaConfig)(projectConfigOrAnalysis)
+        : projectConfigOrAnalysis;
+    const defaultContent = await generateDefaultKarmaConfig((0, paths_1.relativePathToWorkspaceRoot)(posix_1.default.dirname(karmaConfigPath)), projectName, needDevkitPlugin);
+    const defaultAnalysis = (0, karma_config_analyzer_1.analyzeKarmaConfig)(defaultContent);
+    return compareKarmaConfigs(projectAnalysis, defaultAnalysis);
+}

package/migrations/karma/migration.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+import type { Rule } from '@angular-devkit/schematics';
+export default function (): Rule;

package/migrations/karma/migration.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const workspace_1 = require("../../utility/workspace");
+const workspace_models_1 = require("../../utility/workspace-models");
+const karma_config_analyzer_1 = require("./karma-config-analyzer");
+const karma_config_comparer_1 = require("./karma-config-comparer");
+function updateProjects(tree) {
+    return (0, workspace_1.updateWorkspace)(async (workspace) => {
+        const removableKarmaConfigs = new Map();
+        for (const [projectName, project] of workspace.projects) {
+            for (const [, target] of project.targets) {
+                let needDevkitPlugin = false;
+                switch (target.builder) {
+                    case workspace_models_1.Builders.Karma:
+                        needDevkitPlugin = true;
+                        break;
+                    case workspace_models_1.Builders.BuildKarma:
+                        break;
+                    default:
+                        continue;
+                }
+                for (const [, options] of (0, workspace_1.allTargetOptions)(target, false)) {
+                    const karmaConfig = options['karmaConfig'];
+                    if (typeof karmaConfig !== 'string') {
+                        continue;
+                    }
+                    let isRemovable = removableKarmaConfigs.get(karmaConfig);
+                    if (isRemovable === undefined && tree.exists(karmaConfig)) {
+                        const content = tree.readText(karmaConfig);
+                        const analysis = (0, karma_config_analyzer_1.analyzeKarmaConfig)(content);
+                        if (analysis.hasUnsupportedValues) {
+                            // Cannot safely determine if the file is removable.
+                            isRemovable = false;
+                        }
+                        else {
+                            const diff = await (0, karma_config_comparer_1.compareKarmaConfigToDefault)(analysis, projectName, karmaConfig, needDevkitPlugin);
+                            isRemovable = !(0, karma_config_comparer_1.hasDifferences)(diff) && diff.isReliable;
+                        }
+                        removableKarmaConfigs.set(karmaConfig, isRemovable);
+                        if (isRemovable) {
+                            tree.delete(karmaConfig);
+                        }
+                    }
+                    if (isRemovable) {
+                        delete options['karmaConfig'];
+                    }
+                }
+            }
+        }
+    });
+}
+function default_1() {
+    return updateProjects;
+}

package/migrations/migration-collection.json

@@ -27,6 +27,11 @@
       "optional": true,
       "recommended": true,
       "documentation": "tools/cli/build-system-migration"
+    },
+    "remove-default-karma-config": {
+      "version": "20.2.0",
+      "factory": "./karma/migration",
+      "description": "Remove any karma configuration files that only contain the default content. The default configuration is automatically available without a specific project file."
     }
   }
 }

package/migrations/replace-provide-server-rendering-import/migration.js

@@ -6,43 +6,13 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.dev/license
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = default_1;
-const ts = __importStar(require("../../third_party/github.com/Microsoft/TypeScript/lib/typescript"));
-const dependencies_1 = require("../../utility/dependencies");
+const typescript_1 = __importDefault(require("../../third_party/github.com/Microsoft/TypeScript/lib/typescript"));
+const dependency_1 = require("../../utility/dependency");
 const latest_versions_1 = require("../../utility/latest-versions");
 function* visit(directory) {
     for (const path of directory.subfiles) {
@@ -67,20 +37,20 @@ function* visit(directory) {
 }
 function default_1() {
     return async (tree) => {
-        let angularSSRAdded = false;
+        let rule;
         for (const [filePath, content] of visit(tree.root)) {
             let updatedContent = content;
             const ssrImports = new Set();
             const platformServerImports = new Set();
-            const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true);
+            const sourceFile = typescript_1.default.createSourceFile(filePath, content, typescript_1.default.ScriptTarget.Latest, true);
             sourceFile.forEachChild((node) => {
-                if (ts.isImportDeclaration(node)) {
+                if (typescript_1.default.isImportDeclaration(node)) {
                     const moduleSpecifier = node.moduleSpecifier.getText(sourceFile);
                     if (moduleSpecifier.includes('@angular/platform-server')) {
                         const importClause = node.importClause;
                         if (importClause &&
                             importClause.namedBindings &&
-                            ts.isNamedImports(importClause.namedBindings)) {
+                            typescript_1.default.isNamedImports(importClause.namedBindings)) {
                             const namedImports = importClause.namedBindings.elements.map((e) => e.getText(sourceFile));
                             namedImports.forEach((importName) => {
                                 if (importName === 'provideServerRendering') {
@@ -97,7 +67,7 @@ function default_1() {
                         const importClause = node.importClause;
                         if (importClause &&
                             importClause.namedBindings &&
-                            ts.isNamedImports(importClause.namedBindings)) {
+                            typescript_1.default.isNamedImports(importClause.namedBindings)) {
                             importClause.namedBindings.elements.forEach((e) => {
                                 ssrImports.add(e.getText(sourceFile));
                             });
@@ -118,16 +88,11 @@ function default_1() {
             }
             if (content !== updatedContent) {
                 tree.overwrite(filePath, updatedContent);
-                if (!angularSSRAdded) {
-                    (0, dependencies_1.addPackageJsonDependency)(tree, {
-                        name: '@angular/ssr',
-                        version: latest_versions_1.latestVersions.AngularSSR,
-                        type: dependencies_1.NodeDependencyType.Default,
-                        overwrite: false,
-                    });
-                    angularSSRAdded = true;
+                if (rule === undefined) {
+                    rule = (0, dependency_1.addDependency)('@angular/ssr', latest_versions_1.latestVersions.AngularSSR);
                 }
             }
         }
+        return rule;
     };
 }

package/migrations/use-application-builder/migration.js

@@ -10,13 +10,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = default_1;
 const schematics_1 = require("@angular-devkit/schematics");
 const posix_1 = require("node:path/posix");
-const dependencies_1 = require("../../utility/dependencies");
 const dependency_1 = require("../../utility/dependency");
 const json_file_1 = require("../../utility/json-file");
 const latest_versions_1 = require("../../utility/latest-versions");
 const workspace_1 = require("../../utility/workspace");
 const workspace_models_1 = require("../../utility/workspace-models");
-const css_import_lexer_1 = require("./css-import-lexer");
+const stylesheet_updates_1 = require("./stylesheet-updates");
 function* updateBuildTarget(projectName, buildTarget, serverTarget, tree, context) {
     // Update builder target and options
     buildTarget.builder = workspace_models_1.Builders.Application;
@@ -141,7 +140,7 @@ function updateProjects(tree, context) {
             }
             // Update CSS/Sass import specifiers
             const projectSourceRoot = (0, posix_1.join)(project.root, project.sourceRoot ?? 'src');
-            updateStyleImports(tree, projectSourceRoot, buildTarget);
+            (0, stylesheet_updates_1.updateStyleImports)(tree, projectSourceRoot, buildTarget);
         }
         // Check for @angular-devkit/build-angular Webpack usage
         let hasAngularDevkitUsage = false;
@@ -195,17 +194,13 @@ function updateProjects(tree, context) {
             // Add direct @angular/build dependencies and remove @angular-devkit/build-angular
             rules.push((0, dependency_1.addDependency)('@angular/build', latest_versions_1.latestVersions.DevkitBuildAngular, {
                 type: dependency_1.DependencyType.Dev,
-                // Always is set here since removePackageJsonDependency below does not automatically
-                // trigger the package manager execution.
-                install: dependency_1.InstallBehavior.Always,
                 existing: dependency_1.ExistingBehavior.Replace,
-            }));
-            (0, dependencies_1.removePackageJsonDependency)(tree, '@angular-devkit/build-angular');
+            }), (0, dependency_1.removeDependency)('@angular-devkit/build-angular'));
             // Add less dependency if any projects contain a Less stylesheet file.
             // This check does not consider Node.js packages due to the performance
             // cost of searching such a large directory structure. A build time error
             // will provide instructions to install the package in this case.
-            if (hasLessStylesheets(tree)) {
+            if ((0, stylesheet_updates_1.hasLessStylesheets)(tree)) {
                 rules.push((0, dependency_1.addDependency)('less', latest_versions_1.latestVersions['less'], {
                     type: dependency_1.DependencyType.Dev,
                     existing: dependency_1.ExistingBehavior.Skip,
@@ -214,7 +209,7 @@ function updateProjects(tree, context) {
             // Add postcss dependency if any projects have a custom postcss configuration file.
             // The build system only supports files in a project root or workspace root with
             // names of either 'postcss.config.json' or '.postcssrc.json'.
-            if (hasPostcssConfiguration(tree, workspace)) {
+            if ((0, stylesheet_updates_1.hasPostcssConfiguration)(tree, workspace)) {
                 rules.push((0, dependency_1.addDependency)('postcss', latest_versions_1.latestVersions['postcss'], {
                     type: dependency_1.DependencyType.Dev,
                     existing: dependency_1.ExistingBehavior.Replace,
@@ -247,138 +242,6 @@ function updateProjects(tree, context) {
         return (0, schematics_1.chain)(rules);
     });
 }
-/**
- * Searches the schematic tree for files that have a `.less` extension.
- *
- * @param tree A Schematics tree instance to search
- * @returns true if Less stylesheet files are found; otherwise, false
- */
-function hasLessStylesheets(tree) {
-    const directories = [tree.getDir('/')];
-    let current;
-    while ((current = directories.pop())) {
-        for (const path of current.subfiles) {
-            if (path.endsWith('.less')) {
-                return true;
-            }
-        }
-        for (const path of current.subdirs) {
-            if (path === 'node_modules' || path.startsWith('.')) {
-                continue;
-            }
-            directories.push(current.dir(path));
-        }
-    }
-}
-/**
- * Searches for a Postcss configuration file within the workspace root
- * or any of the project roots.
- *
- * @param tree A Schematics tree instance to search
- * @param workspace A Workspace to check for projects
- * @returns true, if a Postcss configuration file is found; otherwise, false
- */
-function hasPostcssConfiguration(tree, workspace) {
-    // Add workspace root
-    const searchDirectories = [''];
-    // Add each project root
-    for (const { root } of workspace.projects.values()) {
-        if (root) {
-            searchDirectories.push(root);
-        }
-    }
-    return searchDirectories.some((dir) => tree.exists((0, posix_1.join)(dir, 'postcss.config.json')) || tree.exists((0, posix_1.join)(dir, '.postcssrc.json')));
-}
-function* visit(directory) {
-    for (const path of directory.subfiles) {
-        const sass = path.endsWith('.scss');
-        if (path.endsWith('.css') || sass) {
-            const entry = directory.file(path);
-            if (entry) {
-                const content = entry.content;
-                yield [entry.path, content.toString(), sass];
-            }
-        }
-    }
-    for (const path of directory.subdirs) {
-        if (path === 'node_modules' || path.startsWith('.')) {
-            continue;
-        }
-        yield* visit(directory.dir(path));
-    }
-}
-// Based on https://github.com/sass/dart-sass/blob/44d6bb6ac72fe6b93f5bfec371a1fffb18e6b76d/lib/src/importer/utils.dart
-function* potentialSassImports(specifier, base, fromImport) {
-    const directory = (0, posix_1.join)(base, (0, posix_1.dirname)(specifier));
-    const extension = (0, posix_1.extname)(specifier);
-    const hasStyleExtension = extension === '.scss' || extension === '.sass' || extension === '.css';
-    // Remove the style extension if present to allow adding the `.import` suffix
-    const filename = (0, posix_1.basename)(specifier, hasStyleExtension ? extension : undefined);
-    if (hasStyleExtension) {
-        if (fromImport) {
-            yield (0, posix_1.join)(directory, filename + '.import' + extension);
-            yield (0, posix_1.join)(directory, '_' + filename + '.import' + extension);
-        }
-        yield (0, posix_1.join)(directory, filename + extension);
-        yield (0, posix_1.join)(directory, '_' + filename + extension);
-    }
-    else {
-        if (fromImport) {
-            yield (0, posix_1.join)(directory, filename + '.import.scss');
-            yield (0, posix_1.join)(directory, filename + '.import.sass');
-            yield (0, posix_1.join)(directory, filename + '.import.css');
-            yield (0, posix_1.join)(directory, '_' + filename + '.import.scss');
-            yield (0, posix_1.join)(directory, '_' + filename + '.import.sass');
-            yield (0, posix_1.join)(directory, '_' + filename + '.import.css');
-        }
-        yield (0, posix_1.join)(directory, filename + '.scss');
-        yield (0, posix_1.join)(directory, filename + '.sass');
-        yield (0, posix_1.join)(directory, filename + '.css');
-        yield (0, posix_1.join)(directory, '_' + filename + '.scss');
-        yield (0, posix_1.join)(directory, '_' + filename + '.sass');
-        yield (0, posix_1.join)(directory, '_' + filename + '.css');
-    }
-}
-function updateStyleImports(tree, projectSourceRoot, buildTarget) {
-    const external = new Set();
-    let needWorkspaceIncludePath = false;
-    for (const file of visit(tree.getDir(projectSourceRoot))) {
-        const [path, content, sass] = file;
-        const relativeBase = (0, posix_1.dirname)(path);
-        let updater;
-        for (const { start, specifier, fromUse } of (0, css_import_lexer_1.findImports)(content, sass)) {
-            if (specifier[0] === '~') {
-                updater ??= tree.beginUpdate(path);
-                // start position includes the opening quote
-                updater.remove(start + 1, 1);
-            }
-            else if (specifier[0] === '^') {
-                updater ??= tree.beginUpdate(path);
-                // start position includes the opening quote
-                updater.remove(start + 1, 1);
-                // Add to externalDependencies
-                external.add(specifier.slice(1));
-            }
-            else if (sass &&
-                [...potentialSassImports(specifier, relativeBase, !fromUse)].every((v) => !tree.exists(v)) &&
-                [...potentialSassImports(specifier, '/', !fromUse)].some((v) => tree.exists(v))) {
-                needWorkspaceIncludePath = true;
-            }
-        }
-        if (updater) {
-            tree.commitUpdate(updater);
-        }
-    }
-    if (needWorkspaceIncludePath) {
-        buildTarget.options ??= {};
-        buildTarget.options['stylePreprocessorOptions'] ??= {};
-        (buildTarget.options['stylePreprocessorOptions']['includePaths'] ??= []).push('.');
-    }
-    if (external.size > 0) {
-        buildTarget.options ??= {};
-        (buildTarget.options['externalDependencies'] ??= []).push(...external);
-    }
-}
 function deleteFile(path) {
     return (tree) => {
         tree.delete(path);

package/migrations/use-application-builder/stylesheet-updates.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.dev/license
+ */
+import { Tree } from '@angular-devkit/schematics';
+import { TargetDefinition, WorkspaceDefinition } from '../../utility/workspace';
+/**
+ * Searches the schematic tree for files that have a `.less` extension.
+ * This is used to determine if the `less` package should be added as a dependency.
+ *
+ * @param tree A Schematics tree instance to search.
+ * @returns `true` if Less stylesheet files are found; otherwise, `false`.
+ */
+export declare function hasLessStylesheets(tree: Tree): boolean;
+/**
+ * Searches for a PostCSS configuration file within the workspace root or any of the project roots.
+ * This is used to determine if the `postcss` package should be added as a dependency.
+ *
+ * @param tree A Schematics tree instance to search.
+ * @param workspace A Workspace to check for projects.
+ * @returns `true` if a PostCSS configuration file is found; otherwise, `false`.
+ */
+export declare function hasPostcssConfiguration(tree: Tree, workspace: WorkspaceDefinition): boolean;
+/**
+ * The main orchestrator function for updating stylesheets.
+ * It iterates through all stylesheets in a project, analyzes them, and applies the necessary
+ * changes to the files and the build configuration.
+ *
+ * @param tree A Schematics tree instance.
+ * @param projectSourceRoot The source root of the project being updated.
+ * @param buildTarget The build target of the project being updated.
+ */
+export declare function updateStyleImports(tree: Tree, projectSourceRoot: string, buildTarget: TargetDefinition): void;