@nx/angular 23.0.0-pr.35465.2bc2643 → 23.0.0-rc.0

package/dist/src/generators/library/schema.d.ts

@@ -0,0 +1,40 @@
+import type { Linter, LinterType } from '@nx/eslint';
+import type { UnitTestRunner } from '../../utils/test-runners';
+
+export interface Schema {
+  directory: string;
+  name?: string;
+  skipFormat?: boolean;
+  addModuleSpec?: boolean;
+  sourceDir?: string;
+  buildable?: boolean;
+  publishable?: boolean;
+  importPath?: string;
+  spec?: boolean;
+  flat?: boolean;
+  commonModule?: boolean;
+  prefix?: string;
+  routing?: boolean;
+  lazy?: boolean;
+  parent?: string;
+  tags?: string;
+  strict?: boolean;
+  linter?: Linter | LinterType;
+  unitTestRunner?: UnitTestRunner;
+  compilationMode?: 'full' | 'partial';
+  setParserOptionsProject?: boolean;
+  skipModule?: boolean;
+  skipPackageJson?: boolean;
+  standalone?: boolean;
+  displayBlock?: boolean;
+  inlineStyle?: boolean;
+  inlineTemplate?: boolean;
+  viewEncapsulation?: 'Emulated' | 'None' | 'ShadowDom';
+  changeDetection?: 'Default' | 'OnPush';
+  style?: 'css' | 'scss' | 'sass' | 'less' | 'none';
+  skipTests?: boolean;
+  selector?: string;
+  skipSelector?: boolean;
+  addPlugin?: boolean;
+  skipTsConfig?: boolean;
+}

package/dist/src/generators/library/schema.json

@@ -0,0 +1,186 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "GeneratorAngularLibrary",
+  "title": "Create a library",
+  "description": "Creates an Angular library.",
+  "type": "object",
+  "cli": "nx",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the library.",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the library is placed.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "Which directory do you want to create the library in?"
+    },
+    "publishable": {
+      "type": "boolean",
+      "default": false,
+      "description": "Generate a publishable library.",
+      "x-priority": "important"
+    },
+    "buildable": {
+      "type": "boolean",
+      "default": false,
+      "description": "Generate a buildable library.",
+      "x-priority": "important"
+    },
+    "prefix": {
+      "type": "string",
+      "format": "html-selector",
+      "description": "The prefix to apply to generated selectors.",
+      "alias": "p"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "addModuleSpec": {
+      "description": "Add a module spec file.",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "skipTsConfig": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not update `tsconfig.json` for development experience."
+    },
+    "routing": {
+      "type": "boolean",
+      "default": false,
+      "description": "Add router configuration. See `lazy` for more information.",
+      "x-priority": "important"
+    },
+    "lazy": {
+      "type": "boolean",
+      "default": false,
+      "description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.",
+      "x-priority": "important"
+    },
+    "parent": {
+      "type": "string",
+      "description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to.",
+      "x-priority": "important"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the library (used for linting)."
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["vitest-angular", "vitest-analog", "jest", "none"],
+      "description": "Test runner to use for unit tests. `vitest-angular` uses the `@nx/angular:unit-test` executor (requires Angular v21+ and a buildable/publishable library). `vitest-analog` uses AnalogJS-based setup with `@nx/vitest`. It defaults to `vitest-angular` for buildable/publishable libraries on Angular >= 21.0.0, `vitest-analog` for non-buildable libraries on Angular >= 21.0.0, otherwise `jest`.",
+      "x-prompt": "Which unit test runner would you like to use?"
+    },
+    "importPath": {
+      "type": "string",
+      "description": "The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name."
+    },
+    "strict": {
+      "type": "boolean",
+      "description": "Create a library with stricter type checking and build optimization options.",
+      "default": true
+    },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["eslint", "none"],
+      "default": "eslint"
+    },
+    "compilationMode": {
+      "description": "Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.",
+      "type": "string",
+      "enum": ["full", "partial"]
+    },
+    "setParserOptionsProject": {
+      "type": "boolean",
+      "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
+      "default": false
+    },
+    "skipModule": {
+      "type": "boolean",
+      "description": "Whether to skip the creation of a default module when generating the library.",
+      "default": false
+    },
+    "standalone": {
+      "type": "boolean",
+      "description": "Generate a library that uses a standalone component instead of a module as the entry point.",
+      "default": true
+    },
+    "displayBlock": {
+      "description": "Specifies if the component generated style will contain `:host { display: block; }`. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "type": "boolean",
+      "default": false,
+      "alias": "b"
+    },
+    "inlineStyle": {
+      "description": "Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "type": "boolean",
+      "default": false,
+      "alias": "s"
+    },
+    "inlineTemplate": {
+      "description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "type": "boolean",
+      "default": false,
+      "alias": "t"
+    },
+    "viewEncapsulation": {
+      "description": "The view encapsulation strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "enum": ["Emulated", "None", "ShadowDom"],
+      "type": "string",
+      "alias": "v"
+    },
+    "changeDetection": {
+      "description": "The change detection strategy to use in the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "enum": ["Default", "OnPush"],
+      "type": "string",
+      "default": "Default",
+      "alias": "c"
+    },
+    "style": {
+      "description": "The file extension or preprocessor to use for style files, or `none` to skip generating the style file. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "type": "string",
+      "default": "css",
+      "enum": ["css", "scss", "sass", "less", "none"]
+    },
+    "skipTests": {
+      "type": "boolean",
+      "description": "Do not create `spec.ts` test files for the new component. Disclaimer: This option is only valid when `--standalone` is set to `true`.",
+      "default": false
+    },
+    "selector": {
+      "type": "string",
+      "format": "html-selector",
+      "description": "The HTML selector to use for this component. Disclaimer: This option is only valid when `--standalone` is set to `true`."
+    },
+    "skipSelector": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies if the component should have a selector or not. Disclaimer: This option is only valid when `--standalone` is set to `true`."
+    },
+    "flat": {
+      "type": "boolean",
+      "default": false,
+      "description": "Ensure the generated standalone component is not placed in a subdirectory. Disclaimer: This option is only valid when `--standalone` is set to `true`."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["directory"],
+  "examplesFile": "../../../docs/library-examples.md"
+}

package/dist/src/generators/library-secondary-entry-point/lib/add-files.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { NormalizedGeneratorOptions } from '../schema';
+export declare function addFiles(tree: Tree, options: NormalizedGeneratorOptions): void;

package/dist/src/generators/library-secondary-entry-point/lib/add-path-mapping.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { NormalizedGeneratorOptions } from '../schema';
+export declare function addPathMapping(tree: Tree, options: NormalizedGeneratorOptions): void;

package/dist/src/generators/library-secondary-entry-point/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './add-files';
+export * from './add-path-mapping';
+export * from './normalize-options';
+export * from './update-tsconfig-included-files';

package/dist/src/generators/library-secondary-entry-point/lib/normalize-options.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from '@nx/devkit';
+import type { GeneratorOptions, NormalizedGeneratorOptions } from '../schema';
+export declare function normalizeOptions(tree: Tree, options: GeneratorOptions): NormalizedGeneratorOptions;

package/dist/src/generators/library-secondary-entry-point/lib/update-tsconfig-included-files.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from '@nx/devkit';
+import type { NormalizedGeneratorOptions } from '../schema';
+export declare function updateTsConfigIncludedFiles(tree: Tree, options: NormalizedGeneratorOptions): void;

package/dist/src/generators/library-secondary-entry-point/library-secondary-entry-point.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { GeneratorOptions } from './schema';
+export declare function librarySecondaryEntryPointGenerator(tree: Tree, rawOptions: GeneratorOptions): Promise<void>;
+export default librarySecondaryEntryPointGenerator;

package/dist/src/generators/library-secondary-entry-point/library-secondary-entry-point.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.librarySecondaryEntryPointGenerator = librarySecondaryEntryPointGenerator;
+const devkit_1 = require("@nx/devkit");
+const assert_supported_angular_version_1 = require("../../utils/assert-supported-angular-version");
+const lib_1 = require("./lib");
+async function librarySecondaryEntryPointGenerator(tree, rawOptions) {
+    (0, assert_supported_angular_version_1.assertSupportedAngularVersion)(tree);
+    const options = (0, lib_1.normalizeOptions)(tree, rawOptions);
+    (0, lib_1.addFiles)(tree, options);
+    (0, lib_1.addPathMapping)(tree, options);
+    (0, lib_1.updateTsConfigIncludedFiles)(tree, options);
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.default = librarySecondaryEntryPointGenerator;

package/dist/src/generators/move/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './update-module-name';
+export * from './update-ng-package';
+export * from './update-secondary-entry-points';

package/dist/src/generators/move/lib/types.d.ts

@@ -0,0 +1,4 @@
+export type MoveImplOptions = {
+    oldProjectName: string;
+    newProjectName: string;
+};

package/dist/src/generators/move/lib/update-module-name.d.ts

@@ -0,0 +1,11 @@
+import { Tree } from '@nx/devkit';
+import type { MoveImplOptions } from './types';
+/**
+ * Updates the Angular module name (including the spec file and index.ts)
+ *
+ * Again, if the user has deviated from the expected folder
+ * structure, they are very much on their own.
+ *
+ * @param schema The options provided to the schematic
+ */
+export declare function updateModuleName(tree: Tree, { oldProjectName, newProjectName }: MoveImplOptions): void;

package/dist/src/generators/move/lib/update-module-name.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateModuleName = updateModuleName;
+const devkit_1 = require("@nx/devkit");
+const internal_1 = require("@nx/js/internal");
+/**
+ * Updates the Angular module name (including the spec file and index.ts)
+ *
+ * Again, if the user has deviated from the expected folder
+ * structure, they are very much on their own.
+ *
+ * @param schema The options provided to the schematic
+ */
+function updateModuleName(tree, { oldProjectName, newProjectName }) {
+    const unscopedNewProjectName = newProjectName.startsWith('@')
+        ? newProjectName.split('/')[1]
+        : newProjectName;
+    if (oldProjectName === unscopedNewProjectName) {
+        return;
+    }
+    const project = (0, devkit_1.readProjectConfiguration)(tree, newProjectName);
+    if (project.projectType === 'application') {
+        // Expect the module to be something like 'app.module.ts' regardless of the folder name,
+        // Therefore, nothing to do.
+        return;
+    }
+    const moduleName = {
+        from: `${(0, devkit_1.names)(oldProjectName).className}Module`,
+        to: `${(0, devkit_1.names)(unscopedNewProjectName).className}Module`,
+    };
+    const findModuleName = new RegExp(`\\b${moduleName.from}`, 'g');
+    const moduleFiles = [
+        {
+            from: `${oldProjectName}.module`,
+            fromRegex: new RegExp(`\\b${oldProjectName}\\.module`, 'g'),
+            to: `${unscopedNewProjectName}.module`,
+        },
+        {
+            from: `${oldProjectName}-module`,
+            fromRegex: new RegExp(`\\b${oldProjectName}-module`, 'g'),
+            to: `${unscopedNewProjectName}-module`,
+        },
+    ];
+    const sourceRoot = (0, internal_1.getProjectSourceRoot)(project, tree);
+    const filesToRename = moduleFiles.flatMap((moduleFile) => [
+        {
+            from: `${sourceRoot}/lib/${moduleFile.from}.ts`,
+            to: `${sourceRoot}/lib/${moduleFile.to}.ts`,
+        },
+        {
+            from: `${sourceRoot}/lib/${moduleFile.from}.spec.ts`,
+            to: `${sourceRoot}/lib/${moduleFile.to}.spec.ts`,
+        },
+    ].filter((rename) => rename.from !== rename.to));
+    if (filesToRename.length === 0) {
+        return;
+    }
+    const replacements = [
+        ...moduleFiles.map((moduleFile) => ({
+            regex: moduleFile.fromRegex,
+            replaceWith: moduleFile.to,
+        })),
+        {
+            regex: findModuleName,
+            replaceWith: moduleName.to,
+        },
+    ];
+    // Update the module file and its spec file
+    filesToRename.forEach((file) => {
+        if (tree.exists(file.from)) {
+            updateFileContent(tree, replacements, file.from, file.to);
+            tree.delete(file.from);
+        }
+    });
+    // update index file
+    const indexFile = (0, devkit_1.joinPathFragments)(sourceRoot, 'index.ts');
+    if (tree.exists(indexFile)) {
+        updateFileContent(tree, replacements, indexFile);
+    }
+    const skipFiles = [...filesToRename.map((file) => file.to), indexFile];
+    // Update any files which import the module
+    for (const [, definition] of (0, devkit_1.getProjects)(tree)) {
+        (0, devkit_1.visitNotIgnoredFiles)(tree, definition.root, (file) => {
+            const normalizedFile = (0, devkit_1.normalizePath)(file);
+            // skip files that were already modified
+            if (skipFiles.includes(normalizedFile)) {
+                return;
+            }
+            updateFileContent(tree, replacements, normalizedFile);
+        });
+    }
+}
+function updateFileContent(tree, replacements, fileName, newFileName) {
+    let content = tree.read(fileName, 'utf-8');
+    if (content) {
+        let updated = false;
+        replacements.forEach((replacement) => {
+            if (replacement.regex.test(content)) {
+                content = content.replace(replacement.regex, replacement.replaceWith);
+                updated = true;
+            }
+        });
+        if (updated) {
+            tree.write(newFileName ?? fileName, content);
+        }
+    }
+}

package/dist/src/generators/move/lib/update-ng-package.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import type { MoveImplOptions } from './types';
+export declare function updateNgPackage(tree: Tree, schema: MoveImplOptions): void;

package/dist/src/generators/move/lib/update-secondary-entry-points.d.ts

@@ -0,0 +1,3 @@
+import type { Tree } from '@nx/devkit';
+import type { MoveImplOptions } from './types';
+export declare function updateSecondaryEntryPoints(tree: Tree, schema: MoveImplOptions): void;

package/dist/src/generators/move/move-impl.d.ts

@@ -0,0 +1,7 @@
+import { type Tree } from '@nx/devkit';
+import type { MoveImplOptions } from './lib/types';
+/**
+ * Angular-specific logic to move a project to another directory.
+ * This is invoked by the `@nx/workspace:move` generator.
+ */
+export declare function move(tree: Tree, options: MoveImplOptions): Promise<void>;

package/dist/src/generators/ng-add/migrate-from-angular-cli.d.ts

@@ -0,0 +1,3 @@
+import type { GeneratorCallback, Tree } from '@nx/devkit';
+import type { GeneratorOptions } from './schema';
+export declare function migrateFromAngularCli(tree: Tree, options: GeneratorOptions): Promise<GeneratorCallback>;

package/dist/src/generators/ng-add/migrators/builders/angular-build-unit-test.migrator.d.ts

@@ -0,0 +1,15 @@
+import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo } from '../../utilities';
+import { BuilderMigrator } from './builder.migrator';
+export declare class AngularBuildUnitTestMigrator extends BuilderMigrator {
+    constructor(tree: Tree, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger);
+    migrate(): void;
+    private moveConfigFiles;
+    private moveCustomReporterFiles;
+    private updateTargetConfiguration;
+    private updateConfigurationOptions;
+    private updateReporterPaths;
+    private updateTsConfigFileUsedByTestTarget;
+    private handleRootProjectConfigFiles;
+    private getRunnerOption;
+}

package/dist/src/generators/ng-add/migrators/builders/angular-devkit-karma.migrator.d.ts

@@ -0,0 +1,9 @@
+import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo } from '../../utilities';
+import { BuilderMigrator } from './builder.migrator';
+export declare class AngularDevkitKarmaMigrator extends BuilderMigrator {
+    constructor(tree: Tree, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger);
+    migrate(): void;
+    private updateTargetConfiguration;
+    private updateTsConfigFileUsedByTestTarget;
+}

package/dist/src/generators/ng-add/migrators/builders/angular-devkit-ng-packagr.migrator.d.ts

@@ -0,0 +1,10 @@
+import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo } from '../../utilities';
+import { BuilderMigrator } from './builder.migrator';
+export declare class AngularDevkitNgPackagrMigrator extends BuilderMigrator {
+    constructor(tree: Tree, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger);
+    migrate(): void;
+    private updateTargetConfiguration;
+    private updateNgPackageJson;
+    private updateTsConfigs;
+}

package/dist/src/generators/ng-add/migrators/builders/angular-eslint-lint.migrator.d.ts

@@ -0,0 +1,12 @@
+import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo } from '../../utilities';
+import { BuilderMigrator } from './builder.migrator';
+export declare class AngularEslintLintMigrator extends BuilderMigrator {
+    private oldEsLintConfigPath;
+    private newEsLintConfigPath;
+    constructor(tree: Tree, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger);
+    migrate(): void;
+    private updateTargetConfiguration;
+    private updateEsLintConfig;
+    private convertEsLintConfigExtendToNewPath;
+}

package/dist/src/generators/ng-add/migrators/builders/builder-migrator-class.type.d.ts

@@ -0,0 +1,6 @@
+import type { ProjectConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo } from '../../utilities';
+import type { BuilderMigrator } from './builder.migrator';
+export type BuilderMigratorClassType = {
+    new (tree: Tree, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger): BuilderMigrator;
+};

package/dist/src/generators/ng-add/migrators/builders/builder.migrator.d.ts

@@ -0,0 +1,13 @@
+import type { ProjectConfiguration, TargetConfiguration, Tree } from '@nx/devkit';
+import type { Logger, ProjectMigrationInfo, ValidationResult, WorkspaceRootFileType } from '../../utilities';
+import { Migrator } from '../migrator';
+export declare abstract class BuilderMigrator extends Migrator {
+    readonly possibleBuilderNames: string[];
+    readonly rootFileType: WorkspaceRootFileType | undefined;
+    targets: Map<string, TargetConfiguration>;
+    protected skipMigration: boolean;
+    constructor(tree: Tree, possibleBuilderNames: string[], rootFileType: WorkspaceRootFileType | undefined, project: ProjectMigrationInfo, projectConfig: ProjectConfiguration, logger: Logger);
+    validate(): ValidationResult;
+    isBuilderUsed(): boolean;
+    protected collectBuilderTargets(): void;
+}

package/dist/src/generators/ng-add/migrators/builders/index.d.ts

@@ -0,0 +1,6 @@
+export * from './angular-build-unit-test.migrator';
+export * from './angular-devkit-karma.migrator';
+export * from './angular-devkit-ng-packagr.migrator';
+export * from './angular-eslint-lint.migrator';
+export * from './builder-migrator-class.type';
+export * from './builder.migrator';

package/dist/src/generators/ng-add/migrators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './builders';
+export * from './projects';

package/dist/src/generators/ng-add/migrators/migrator.d.ts

@@ -0,0 +1,23 @@
+import type { ProjectConfiguration, TargetConfiguration, Tree } from '@nx/devkit';
+import type { Logger } from '../utilities/logger';
+import type { ProjectMigrationInfo, ValidationResult } from '../utilities/types';
+export declare abstract class Migrator {
+    protected readonly tree: Tree;
+    protected projectConfig: ProjectConfiguration;
+    protected readonly logger: Logger;
+    protected project: ProjectMigrationInfo;
+    protected readonly originalProjectConfig: ProjectConfiguration;
+    constructor(tree: Tree, projectConfig: ProjectConfiguration, logger: Logger);
+    abstract migrate(): Promise<void> | void;
+    abstract validate(): ValidationResult;
+    protected convertAsset(asset: string | any): string | any;
+    protected convertRootPath(originalPath: string): string;
+    protected convertSourceRootPath(originalPath: string): string;
+    protected moveFile(from: string, to: string, required?: boolean): void;
+    protected moveFilePathsFromTargetToProjectRoot(target: TargetConfiguration, options: string[]): void;
+    protected moveProjectRootFile(filePath: string, isRequired?: boolean): void;
+    protected updateCacheableOperations(targetNames: string[]): void;
+    protected updateTsConfigFile(tsConfigPath: string, rootTsConfigFile: string, projectOffsetFromRoot: string): void;
+    private getTargetValuesForOption;
+    private getValueForOption;
+}