@nx/devkit 19.9.0-canary.20240921-a510b36 → 20.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "19.9.0-canary.20240921-a510b36",
+  "version": "20.0.0-beta.1",
   "private": false,
   "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more. Learn more about [extending Nx by leveraging the Nx Devkit](https://nx.dev/extending-nx/intro/getting-started) on our docs.",
   "repository": {
@@ -29,14 +29,13 @@
   "homepage": "https://nx.dev",
   "dependencies": {
     "ejs": "^3.1.7",
-    "enquirer": "~2.3.6",
     "ignore": "^5.0.4",
     "tmp": "~0.2.1",
     "tslib": "^2.3.0",
     "semver": "^7.5.3",
     "yargs-parser": "21.1.1",
     "minimatch": "9.0.3",
-    "@nrwl/devkit": "19.9.0-canary.20240921-a510b36"
+    "@nrwl/devkit": "20.0.0-beta.1"
   },
   "peerDependencies": {
     "nx": ">= 17 <= 20"

package/src/generators/artifact-name-and-directory-utils.d.ts

@@ -1,20 +1,12 @@
-import { Tree } from 'nx/src/devkit-exports';
-export type NameAndDirectoryFormat = 'as-provided' | 'derived';
+import { type Tree } from 'nx/src/devkit-exports';
+export type NameAndDirectoryFormat = 'as-provided';
 export type ArtifactGenerationOptions = {
-    artifactType: string;
-    callingGenerator: string | null;
     name: string;
     directory?: string;
-    disallowPathInNameForDerived?: boolean;
     fileExtension?: 'js' | 'jsx' | 'ts' | 'tsx' | 'vue';
     fileName?: string;
-    flat?: boolean;
     nameAndDirectoryFormat?: NameAndDirectoryFormat;
-    pascalCaseDirectory?: boolean;
-    pascalCaseFile?: boolean;
-    project?: string;
     suffix?: string;
-    derivedDirectory?: string;
 };
 export type NameAndDirectoryOptions = {
     /**

package/src/generators/artifact-name-and-directory-utils.js

@@ -3,65 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.determineArtifactNameAndDirectoryOptions = determineArtifactNameAndDirectoryOptions;
 exports.getRelativeCwd = getRelativeCwd;
 exports.setCwd = setCwd;
-const enquirer_1 = require("enquirer");
-const path_1 = require("path");
-const names_1 = require("../utils/names");
 const devkit_exports_1 = require("nx/src/devkit-exports");
 const devkit_internals_1 = require("nx/src/devkit-internals");
+const path_1 = require("path");
 async function determineArtifactNameAndDirectoryOptions(tree, options) {
-    if (!options.nameAndDirectoryFormat &&
-        (process.env.NX_INTERACTIVE !== 'true' || !isTTY())) {
-        options.nameAndDirectoryFormat = 'derived';
-    }
-    const formats = getNameAndDirectoryOptionFormats(tree, options);
-    const format = options.nameAndDirectoryFormat ?? (await determineFormat(formats, options));
-    validateResolvedProject(tree, formats[format]?.project, options, formats[format]?.directory);
-    if (format === 'derived' && options.callingGenerator) {
-        logDeprecationMessage(options, formats);
-    }
+    const nameAndDirectoryOptions = getNameAndDirectoryOptions(tree, options);
+    validateResolvedProject(tree, nameAndDirectoryOptions.project, options, nameAndDirectoryOptions.directory);
     return {
-        ...formats[format],
-        nameAndDirectoryFormat: format,
+        ...nameAndDirectoryOptions,
+        nameAndDirectoryFormat: 'as-provided',
     };
 }
-async function determineFormat(formats, options) {
-    if (!formats.derived) {
-        return 'as-provided';
-    }
-    const asProvidedDescription = `As provided: ${formats['as-provided'].filePath}`;
-    const asProvidedSelectedValue = formats['as-provided'].filePath;
-    const derivedDescription = `Derived:     ${formats['derived'].filePath}`;
-    const derivedSelectedValue = formats['derived'].filePath;
-    if (asProvidedSelectedValue === derivedSelectedValue) {
-        return 'as-provided';
-    }
-    const result = await (0, enquirer_1.prompt)({
-        type: 'select',
-        name: 'format',
-        message: `Where should the ${options.artifactType} be generated?`,
-        choices: [
-            {
-                message: asProvidedDescription,
-                name: asProvidedSelectedValue,
-            },
-            {
-                message: derivedDescription,
-                name: derivedSelectedValue,
-            },
-        ],
-        initial: 0,
-    }).then(({ format }) => format === asProvidedSelectedValue ? 'as-provided' : 'derived');
-    return result;
-}
-function logDeprecationMessage(options, formats) {
-    devkit_exports_1.logger.warn(`
-In Nx 20, generating a ${options.artifactType} will no longer support providing a project and deriving the directory.
-Please provide the exact directory in the future.
-Example: nx g ${options.callingGenerator} ${formats['derived'].artifactName} --directory ${formats['derived'].directory}
-NOTE: The example above assumes the command is being run from the workspace root. If the command is being run from a subdirectory, the directory option should be adjusted accordingly.
-`);
-}
-function getNameAndDirectoryOptionFormats(tree, options) {
+function getNameAndDirectoryOptions(tree, options) {
     const directory = options.directory
         ? (0, devkit_exports_1.normalizePath)(options.directory.replace(/^\.?\//, ''))
         : undefined;
@@ -77,43 +30,7 @@ function getNameAndDirectoryOptionFormats(tree, options) {
         fileExtension,
         name: extractedName,
     });
-    if (!options.project) {
-        validateResolvedProject(tree, asProvidedOptions.project, options, asProvidedOptions.directory);
-    }
-    if (options.nameAndDirectoryFormat === 'as-provided') {
-        return {
-            'as-provided': asProvidedOptions,
-            derived: undefined,
-        };
-    }
-    if (options.disallowPathInNameForDerived && options.name.includes('/')) {
-        if (!options.nameAndDirectoryFormat) {
-            devkit_exports_1.output.warn({
-                title: `The provided name "${options.name}" contains a path and this is not supported by the "${options.callingGenerator}" when using the "derived" format.`,
-                bodyLines: [
-                    `The generator will try to generate the ${options.artifactType} using the "as-provided" format at "${asProvidedOptions.filePath}".`,
-                ],
-            });
-            return {
-                'as-provided': asProvidedOptions,
-                derived: undefined,
-            };
-        }
-        throw new Error(`The provided name "${options.name}" contains a path and this is not supported by the "${options.callingGenerator}" when using the "derived" format. ` +
-            `Please provide a name without a path or use the "as-provided" format.`);
-    }
-    const derivedOptions = getDerivedOptions(tree, {
-        ...options,
-        directory,
-        fileExtension,
-        name: extractedName,
-    }, asProvidedOptions, !options.disallowPathInNameForDerived && extractedDirectory
-        ? extractedDirectory
-        : undefined);
-    return {
-        'as-provided': asProvidedOptions,
-        derived: derivedOptions,
-    };
+    return asProvidedOptions;
 }
 function getAsProvidedOptions(tree, options) {
     const relativeCwd = getRelativeCwd();
@@ -143,61 +60,6 @@ function getAsProvidedOptions(tree, options) {
         project: asProvidedProject,
     };
 }
-function getDerivedOptions(tree, options, asProvidedOptions, extractedDirectory) {
-    const projects = (0, devkit_exports_1.getProjects)(tree);
-    if (options.project && !projects.has(options.project)) {
-        throw new Error(`The provided project "${options.project}" does not exist! Please provide an existing project name.`);
-    }
-    const projectName = options.project ?? asProvidedOptions.project;
-    const project = projects.get(projectName);
-    const derivedName = options.name;
-    const baseDirectory = options.directory
-        ? (0, names_1.names)(options.directory).fileName
-        : (0, devkit_exports_1.joinPathFragments)(project.sourceRoot ?? (0, devkit_exports_1.joinPathFragments)(project.root, 'src'), project.projectType === 'application' ? 'app' : 'lib', extractedDirectory ?? '');
-    const derivedDirectory = typeof options.derivedDirectory === 'string'
-        ? (0, devkit_exports_1.joinPathFragments)(project.sourceRoot ?? project.root, options.derivedDirectory, options.flat
-            ? ''
-            : options.pascalCaseDirectory
-                ? (0, names_1.names)(derivedName).className
-                : (0, names_1.names)(derivedName).fileName)
-        : options.flat
-            ? (0, devkit_exports_1.normalizePath)(baseDirectory)
-            : (0, devkit_exports_1.joinPathFragments)(baseDirectory, options.pascalCaseDirectory
-                ? (0, names_1.names)(derivedName).className
-                : (0, names_1.names)(derivedName).fileName);
-    if (options.directory &&
-        !isDirectoryUnderProjectRoot(derivedDirectory, project.root)) {
-        if (!options.nameAndDirectoryFormat) {
-            devkit_exports_1.output.warn({
-                title: `The provided directory "${options.directory}" is not under the provided project root "${project.root}".`,
-                bodyLines: [
-                    `The generator will try to generate the ${options.artifactType} using the "as-provided" format.`,
-                    `With the "as-provided" format, the "project" option is ignored and the ${options.artifactType} will be generated at "${asProvidedOptions.filePath}" (<cwd>/<provided directory>).`,
-                ],
-            });
-            return undefined;
-        }
-        throw new Error(`The provided directory "${options.directory}" is not under the provided project root "${project.root}". ` +
-            `Please provide a directory that is under the provided project root or use the "as-provided" format and only provide the directory.`);
-    }
-    let derivedFileName = options.fileName;
-    if (!derivedFileName) {
-        derivedFileName = options.suffix
-            ? `${derivedName}.${options.suffix}`
-            : derivedName;
-        derivedFileName = options.pascalCaseFile
-            ? (0, names_1.names)(derivedFileName).className
-            : (0, names_1.names)(derivedFileName).fileName;
-    }
-    const derivedFilePath = (0, devkit_exports_1.joinPathFragments)(derivedDirectory, `${derivedFileName}.${options.fileExtension}`);
-    return {
-        artifactName: derivedName,
-        directory: derivedDirectory,
-        fileName: derivedFileName,
-        filePath: derivedFilePath,
-        project: projectName,
-    };
-}
 function validateResolvedProject(tree, project, options, normalizedDirectory) {
     if (project) {
         return;
@@ -218,15 +80,6 @@ function findProjectFromPath(tree, path) {
     const projectRootMappings = (0, devkit_internals_1.createProjectRootMappingsFromProjectConfigurations)(projectConfigurations);
     return (0, devkit_internals_1.findProjectForPath)(path, projectRootMappings);
 }
-function isDirectoryUnderProjectRoot(directory, projectRoot) {
-    const normalizedDirectory = (0, devkit_exports_1.joinPathFragments)(devkit_exports_1.workspaceRoot, directory);
-    const normalizedProjectRoot = (0, devkit_exports_1.joinPathFragments)(devkit_exports_1.workspaceRoot, projectRoot).replace(/\/$/, '');
-    return (normalizedDirectory === normalizedProjectRoot ||
-        normalizedDirectory.startsWith(`${normalizedProjectRoot}/`));
-}
-function isTTY() {
-    return !!process.stdout.isTTY && process.env['CI'] !== 'true';
-}
 function getRelativeCwd() {
     return (0, devkit_exports_1.normalizePath)((0, path_1.relative)(devkit_exports_1.workspaceRoot, getCwd()));
 }

package/src/generators/project-name-and-root-utils.d.ts

@@ -1,13 +1,12 @@
-import { ProjectType, Tree } from 'nx/src/devkit-exports';
-export type ProjectNameAndRootFormat = 'as-provided' | 'derived';
+import { type ProjectType, type Tree } from 'nx/src/devkit-exports';
+export type ProjectNameAndRootFormat = 'as-provided';
 export type ProjectGenerationOptions = {
     name: string;
     projectType: ProjectType;
-    callingGenerator: string | null;
     directory?: string;
     importPath?: string;
-    projectNameAndRootFormat?: ProjectNameAndRootFormat;
     rootProject?: boolean;
+    projectNameAndRootFormat?: ProjectNameAndRootFormat;
 };
 export type ProjectNameAndRootOptions = {
     /**

package/src/generators/project-name-and-root-utils.js

@@ -2,31 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.determineProjectNameAndRootOptions = determineProjectNameAndRootOptions;
 exports.setCwd = setCwd;
-const enquirer_1 = require("enquirer");
-const path_1 = require("path");
-const get_workspace_layout_1 = require("../utils/get-workspace-layout");
-const names_1 = require("../utils/names");
 const devkit_exports_1 = require("nx/src/devkit-exports");
+const path_1 = require("path");
 async function determineProjectNameAndRootOptions(tree, options) {
-    if (!options.projectNameAndRootFormat &&
-        (process.env.NX_INTERACTIVE !== 'true' || !isTTY())) {
-        options.projectNameAndRootFormat = 'derived';
-    }
-    validateName(options.name, options.projectNameAndRootFormat);
-    const formats = getProjectNameAndRootFormats(tree, options);
-    const format = options.projectNameAndRootFormat ?? (await determineFormat(formats));
-    if (format === 'derived' && options.callingGenerator) {
-        logDeprecationMessage(options.callingGenerator, formats);
-    }
+    validateName(options.name);
+    const projectNameAndRootOptions = getProjectNameAndRootOptions(tree, options);
     return {
-        ...formats[format],
-        projectNameAndRootFormat: format,
+        ...projectNameAndRootOptions,
+        projectNameAndRootFormat: 'as-provided',
     };
 }
-function validateName(name, projectNameAndRootFormat) {
-    if (projectNameAndRootFormat === 'derived' && name.startsWith('@')) {
-        throw new Error(`The project name "${name}" cannot start with "@" when the "projectNameAndRootFormat" is "derived".`);
-    }
+function validateName(name) {
     /**
      * Matches two types of project names:
      *
@@ -43,47 +29,7 @@ function validateName(name, projectNameAndRootFormat) {
         throw new Error(`The project name should match the pattern "${pattern}". The provided value "${name}" does not match.`);
     }
 }
-function logDeprecationMessage(callingGenerator, formats) {
-    devkit_exports_1.logger.warn((0, devkit_exports_1.stripIndents) `
-    In Nx 20, generating projects will no longer derive the name and root.
-    Please provide the exact project name and root in the future.
-    Example: nx g ${callingGenerator} ${formats['derived'].projectName} --directory ${formats['derived'].projectRoot}
-  `);
-}
-async function determineFormat(formats) {
-    if (!formats.derived) {
-        return 'as-provided';
-    }
-    const asProvidedDescription = `As provided:
-    Name: ${formats['as-provided'].projectName}
-    Root: ${formats['as-provided'].projectRoot}`;
-    const asProvidedSelectedValue = `${formats['as-provided'].projectName} @ ${formats['as-provided'].projectRoot}`;
-    const derivedDescription = `Derived:
-    Name: ${formats['derived'].projectName}
-    Root: ${formats['derived'].projectRoot}`;
-    const derivedSelectedValue = `${formats['derived'].projectName} @ ${formats['derived'].projectRoot}`;
-    if (asProvidedSelectedValue === derivedSelectedValue) {
-        return 'as-provided';
-    }
-    const result = await (0, enquirer_1.prompt)({
-        type: 'select',
-        name: 'format',
-        message: 'What should be the project name and where should it be generated?',
-        choices: [
-            {
-                message: asProvidedDescription,
-                name: asProvidedSelectedValue,
-            },
-            {
-                message: derivedDescription,
-                name: derivedSelectedValue,
-            },
-        ],
-        initial: 0,
-    }).then(({ format }) => format === asProvidedSelectedValue ? 'as-provided' : 'derived');
-    return result;
-}
-function getProjectNameAndRootFormats(tree, options) {
+function getProjectNameAndRootOptions(tree, options) {
     const directory = options.directory
         ? (0, devkit_exports_1.normalizePath)(options.directory.replace(/^\.?\//, ''))
         : undefined;
@@ -97,38 +43,7 @@ function getProjectNameAndRootFormats(tree, options) {
         directory: directory ?? asProvidedParsedDirectory,
         name: asProvidedParsedName,
     });
-    if (options.projectNameAndRootFormat === 'as-provided') {
-        return {
-            'as-provided': asProvidedOptions,
-            derived: undefined,
-        };
-    }
-    if (asProvidedOptions.projectName.startsWith('@')) {
-        if (!options.projectNameAndRootFormat) {
-            devkit_exports_1.output.warn({
-                title: `The provided name "${options.name}" contains a scoped project name and this is not supported by the "${options.callingGenerator}" when using the "derived" format.`,
-                bodyLines: [
-                    `The generator will try to generate the project "${asProvidedOptions.projectName}" using the "as-provided" format at "${asProvidedOptions.projectRoot}".`,
-                ],
-            });
-            return {
-                'as-provided': asProvidedOptions,
-                derived: undefined,
-            };
-        }
-        throw new Error(`The provided name "${options.name}" contains a scoped project name and this is not supported by the "${options.callingGenerator}" when using the "derived" format. ` +
-            `Please provide a name without "@" or use the "as-provided" format.`);
-    }
-    const { name: derivedParsedName, directory: derivedParsedDirectory } = parseNameForDerived(options.name);
-    const derivedOptions = getDerivedOptions(tree, {
-        ...options,
-        directory: directory ?? derivedParsedDirectory,
-        name: derivedParsedName,
-    });
-    return {
-        'as-provided': asProvidedOptions,
-        derived: derivedOptions,
-    };
+    return asProvidedOptions;
 }
 function getAsProvidedOptions(tree, options) {
     let projectSimpleName;
@@ -191,54 +106,6 @@ function getAsProvidedOptions(tree, options) {
         projectRoot,
     };
 }
-function getDerivedOptions(tree, options) {
-    const name = (0, names_1.names)(options.name).fileName;
-    let { projectDirectory, layoutDirectory } = getDirectories(tree, options.directory, options.projectType);
-    const projectDirectoryWithoutLayout = projectDirectory
-        ? `${(0, names_1.names)(projectDirectory).fileName}/${name}`
-        : options.rootProject
-            ? '.'
-            : name;
-    // the project name uses the directory without the layout directory
-    const projectName = projectDirectoryWithoutLayout === '.'
-        ? name
-        : projectDirectoryWithoutLayout.replace(/\//g, '-');
-    const projectSimpleName = name;
-    let projectRoot = projectDirectoryWithoutLayout;
-    if (projectDirectoryWithoutLayout !== '.') {
-        // prepend the layout directory
-        projectRoot = (0, devkit_exports_1.joinPathFragments)(layoutDirectory, projectRoot);
-    }
-    let importPath;
-    if (options.projectType === 'library') {
-        importPath = options.importPath;
-        if (!importPath) {
-            const npmScope = getNpmScope(tree);
-            importPath =
-                projectRoot === '.'
-                    ? (0, devkit_exports_1.readJson)(tree, 'package.json').name ??
-                        getImportPath(npmScope, projectName)
-                    : getImportPath(npmScope, projectDirectoryWithoutLayout);
-        }
-    }
-    return {
-        projectName,
-        names: {
-            projectSimpleName,
-            projectFileName: projectName,
-        },
-        importPath,
-        projectRoot,
-    };
-}
-function getDirectories(tree, directory, projectType) {
-    let { projectDirectory, layoutDirectory } = (0, get_workspace_layout_1.extractLayoutDirectory)(directory);
-    if (!layoutDirectory) {
-        const { appsDir, libsDir } = (0, get_workspace_layout_1.getWorkspaceLayout)(tree);
-        layoutDirectory = projectType === 'application' ? appsDir : libsDir;
-    }
-    return { projectDirectory, layoutDirectory };
-}
 function getImportPath(npmScope, name) {
     return npmScope ? `${npmScope === '@' ? '' : '@'}${npmScope}/${name}` : name;
 }
@@ -248,9 +115,6 @@ function getNpmScope(tree) {
         : { name: null };
     return name?.startsWith('@') ? name.split('/')[0].substring(1) : undefined;
 }
-function isTTY() {
-    return !!process.stdout.isTTY && process.env['CI'] !== 'true';
-}
 /**
  * When running a script with the package manager (e.g. `npm run`), the package manager will
  * traverse the directory tree upwards until it finds a `package.json` and will set `process.cwd()`
@@ -288,9 +152,3 @@ function parseNameForAsProvided(rawName) {
     }
     return { name: rawName, directory: undefined };
 }
-function parseNameForDerived(rawName) {
-    const parsedName = (0, devkit_exports_1.normalizePath)(rawName).split('/');
-    const name = parsedName.pop();
-    const directory = parsedName.length ? parsedName.join('/') : undefined;
-    return { name, directory };
-}