@nx/devkit 0.0.0-pr-22179-271588f → 0.0.0-pr-26482-ebe2dba

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Narwhal Technologies Inc.
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "0.0.0-pr-22179-271588f",
+  "version": "0.0.0-pr-26482-ebe2dba",
   "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": {
@@ -19,7 +19,7 @@
     "Cypress",
     "CLI"
   ],
-  "main": "./index.js",
+  "main": "./index",
   "typings": "./index.d.ts",
   "author": "Victor Savkin",
   "license": "MIT",
@@ -35,10 +35,11 @@
     "tslib": "^2.3.0",
     "semver": "^7.5.3",
     "yargs-parser": "21.1.1",
-    "@nrwl/devkit": "0.0.0-pr-22179-271588f"
+    "minimatch": "9.0.3",
+    "@nrwl/devkit": "0.0.0-pr-26482-ebe2dba"
   },
   "peerDependencies": {
-    "nx": ">= 16 <= 18"
+    "nx": ">= 17 <= 20"
   },
   "publishConfig": {
     "access": "public"

package/public-api.d.ts

@@ -14,7 +14,7 @@ export { formatFiles } from './src/generators/format-files';
 /**
  * @category Generators
  */
-export { generateFiles } from './src/generators/generate-files';
+export { generateFiles, OverwriteStrategy, } from './src/generators/generate-files';
 /**
  * @category Generators
  */

package/public-api.js

@@ -9,7 +9,7 @@
  *   a. We might need to duplicate code instead of importing from nx until all supported versions of nx contain the file.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.moveFilesToNewDirectory = exports.convertNxExecutor = exports.convertNxGenerator = exports.offsetFromRoot = exports.ChangeType = exports.applyChangesToString = exports.extractLayoutDirectory = exports.getWorkspaceLayout = exports.names = exports.installPackagesTask = exports.NX_VERSION = exports.removeDependenciesFromPackageJson = exports.ensurePackage = exports.addDependenciesToPackageJson = exports.readTargetOptions = exports.targetToTargetString = exports.parseTargetString = exports.visitNotIgnoredFiles = exports.runTasksInSerial = exports.updateTsConfigsToJs = exports.toJS = exports.generateFiles = exports.formatFiles = void 0;
+exports.moveFilesToNewDirectory = exports.convertNxExecutor = exports.convertNxGenerator = exports.offsetFromRoot = exports.ChangeType = exports.applyChangesToString = exports.extractLayoutDirectory = exports.getWorkspaceLayout = exports.names = exports.installPackagesTask = exports.NX_VERSION = exports.removeDependenciesFromPackageJson = exports.ensurePackage = exports.addDependenciesToPackageJson = exports.readTargetOptions = exports.targetToTargetString = exports.parseTargetString = exports.visitNotIgnoredFiles = exports.runTasksInSerial = exports.updateTsConfigsToJs = exports.toJS = exports.OverwriteStrategy = exports.generateFiles = exports.formatFiles = void 0;
 /**
  * @category Generators
  */
@@ -20,6 +20,7 @@ Object.defineProperty(exports, "formatFiles", { enumerable: true, get: function
  */
 var generate_files_1 = require("./src/generators/generate-files");
 Object.defineProperty(exports, "generateFiles", { enumerable: true, get: function () { return generate_files_1.generateFiles; } });
+Object.defineProperty(exports, "OverwriteStrategy", { enumerable: true, get: function () { return generate_files_1.OverwriteStrategy; } });
 /**
  * @category Generators
  */

package/src/executors/parse-target-string.d.ts

@@ -1,6 +1,4 @@
-import type { Target } from 'nx/src/command-line/run/run';
-import type { ProjectGraph } from 'nx/src/config/project-graph';
-import type { ExecutorContext } from 'nx/src/devkit-exports';
+import { ExecutorContext, ProjectGraph, Target } from 'nx/src/devkit-exports';
 /**
  * @deprecated(v17) A project graph should be passed to parseTargetString for best accuracy.
  */

package/src/executors/parse-target-string.js

@@ -1,32 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.targetToTargetString = exports.parseTargetString = void 0;
-const nx_1 = require("../../nx");
-let { readCachedProjectGraph, splitTarget, splitByColons } = (0, nx_1.requireNx)();
-// TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
-splitTarget = splitTarget ?? require('nx/src/utils/split-target').splitTarget;
-splitByColons =
-    splitByColons ?? ((s) => s.split(':'));
+const devkit_exports_1 = require("nx/src/devkit-exports");
+const devkit_internals_1 = require("nx/src/devkit-internals");
 function parseTargetString(targetString, projectGraphOrCtx) {
     let projectGraph = projectGraphOrCtx && 'projectGraph' in projectGraphOrCtx
         ? projectGraphOrCtx.projectGraph
         : projectGraphOrCtx;
     if (!projectGraph) {
         try {
-            projectGraph = readCachedProjectGraph();
+            projectGraph = (0, devkit_exports_1.readCachedProjectGraph)();
         }
         catch (e) {
             projectGraph = { nodes: {} };
         }
     }
-    const [maybeProject] = splitByColons(targetString);
+    const [maybeProject] = (0, devkit_internals_1.splitByColons)(targetString);
     if (!projectGraph.nodes[maybeProject] &&
         projectGraphOrCtx &&
         'projectName' in projectGraphOrCtx &&
         maybeProject !== projectGraphOrCtx.projectName) {
         targetString = `${projectGraphOrCtx.projectName}:${targetString}`;
     }
-    const [project, target, configuration] = splitTarget(targetString, projectGraph);
+    const [project, target, configuration] = (0, devkit_internals_1.splitTarget)(targetString, projectGraph);
     if (!project || !target) {
         throw new Error(`Invalid Target String: ${targetString}`);
     }

package/src/executors/read-target-options.d.ts

@@ -1,5 +1,4 @@
-import type { Target } from 'nx/src/command-line/run/run';
-import type { ExecutorContext } from 'nx/src/config/misc-interfaces';
+import type { ExecutorContext, Target } from 'nx/src/devkit-exports';
 /**
  * Reads and combines options for a given target.
  *

package/src/executors/read-target-options.js

@@ -1,13 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readTargetOptions = void 0;
-const nx_1 = require("../../nx");
 const path_1 = require("path");
-let { Workspaces, getExecutorInformation, calculateDefaultProjectName, combineOptionsForExecutor, } = (0, nx_1.requireNx)();
-// TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
-combineOptionsForExecutor =
-    combineOptionsForExecutor ??
-        require('nx/src/utils/params').combineOptionsForExecutor;
+const devkit_internals_1 = require("nx/src/devkit-internals");
 /**
  * Reads and combines options for a given target.
  *
@@ -22,17 +17,9 @@ function readTargetOptions({ project, target, configuration }, context) {
     if (!targetConfiguration) {
         throw new Error(`Unable to find target ${target} for project ${project}`);
     }
-    // TODO(v19): remove Workspaces.
-    const ws = new Workspaces(context.root);
     const [nodeModule, executorName] = targetConfiguration.executor.split(':');
-    const { schema } = getExecutorInformation
-        ? getExecutorInformation(nodeModule, executorName, context.root, context.projectsConfigurations?.projects ?? context.workspace.projects)
-        : // TODO(v19): remove readExecutor. This is to be backwards compatible with Nx 16.5 and below.
-            ws.readExecutor(nodeModule, executorName);
-    const defaultProject = calculateDefaultProjectName
-        ? calculateDefaultProjectName(context.cwd, context.root, { version: 2, projects: context.projectsConfigurations.projects }, context.nxJsonConfiguration)
-        : // TODO(v19): remove calculateDefaultProjectName. This is to be backwards compatible with Nx 16.5 and below.
-            ws.calculateDefaultProjectName(context.cwd, { version: 2, projects: context.projectsConfigurations.projects }, context.nxJsonConfiguration);
-    return combineOptionsForExecutor({}, configuration ?? targetConfiguration.defaultConfiguration ?? '', targetConfiguration, schema, defaultProject, (0, path_1.relative)(context.root, context.cwd));
+    const { schema } = (0, devkit_internals_1.getExecutorInformation)(nodeModule, executorName, context.root, context.projectsConfigurations?.projects ?? context.workspace.projects);
+    const defaultProject = (0, devkit_internals_1.calculateDefaultProjectName)(context.cwd, context.root, { version: 2, projects: context.projectsConfigurations.projects }, context.nxJsonConfiguration);
+    return (0, devkit_internals_1.combineOptionsForExecutor)({}, configuration ?? targetConfiguration.defaultConfiguration ?? '', targetConfiguration, schema, defaultProject, (0, path_1.relative)(context.root, context.cwd));
 }
 exports.readTargetOptions = readTargetOptions;

package/src/generators/add-build-target-defaults.d.ts

@@ -1,2 +1,2 @@
-import type { Tree } from 'nx/src/devkit-exports';
+import { Tree } from 'nx/src/devkit-exports';
 export declare function addBuildTargetDefaults(tree: Tree, executorName: string, buildTargetName?: string): void;

package/src/generators/add-build-target-defaults.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addBuildTargetDefaults = void 0;
-const nx_1 = require("../../nx");
-const { readNxJson, updateNxJson } = (0, nx_1.requireNx)();
+const devkit_exports_1 = require("nx/src/devkit-exports");
 function addBuildTargetDefaults(tree, executorName, buildTargetName = 'build') {
-    const nxJson = readNxJson(tree);
+    const nxJson = (0, devkit_exports_1.readNxJson)(tree);
     nxJson.targetDefaults ??= {};
     nxJson.targetDefaults[executorName] ??= {
         cache: true,
@@ -13,6 +12,6 @@ function addBuildTargetDefaults(tree, executorName, buildTargetName = 'build') {
             ? ['production', '^production']
             : ['default', '^default'],
     };
-    updateNxJson(tree, nxJson);
+    (0, devkit_exports_1.updateNxJson)(tree, nxJson);
 }
 exports.addBuildTargetDefaults = addBuildTargetDefaults;

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

@@ -1,4 +1,4 @@
-import type { Tree } from 'nx/src/generators/tree';
+import { Tree } from 'nx/src/devkit-exports';
 export type NameAndDirectoryFormat = 'as-provided' | 'derived';
 export type ArtifactGenerationOptions = {
     artifactType: string;

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

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setCwd = exports.getRelativeCwd = exports.determineArtifactNameAndDirectoryOptions = void 0;
 const enquirer_1 = require("enquirer");
 const path_1 = require("path");
-const nx_1 = require("../../nx");
 const names_1 = require("../utils/names");
-const { createProjectRootMappingsFromProjectConfigurations, findProjectForPath, getProjects, joinPathFragments, logger, normalizePath, output, workspaceRoot, } = (0, nx_1.requireNx)();
+const devkit_exports_1 = require("nx/src/devkit-exports");
+const devkit_internals_1 = require("nx/src/devkit-internals");
 async function determineArtifactNameAndDirectoryOptions(tree, options) {
     if (!options.nameAndDirectoryFormat &&
         (process.env.NX_INTERACTIVE !== 'true' || !isTTY())) {
@@ -53,8 +53,8 @@ async function determineFormat(formats, options) {
     return result;
 }
 function logDeprecationMessage(options, formats) {
-    logger.warn(`
-In Nx 19, generating a ${options.artifactType} will no longer support providing a project and deriving the directory.
+    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.
@@ -62,7 +62,7 @@ NOTE: The example above assumes the command is being run from the workspace root
 }
 function getNameAndDirectoryOptionFormats(tree, options) {
     const directory = options.directory
-        ? normalizePath(options.directory.replace(/^\.?\//, ''))
+        ? (0, devkit_exports_1.normalizePath)(options.directory.replace(/^\.?\//, ''))
         : undefined;
     const fileExtension = options.fileExtension ?? 'ts';
     const { name: extractedName, directory: extractedDirectory } = extractNameAndDirectoryFromName(options.name);
@@ -87,7 +87,7 @@ function getNameAndDirectoryOptionFormats(tree, options) {
     }
     if (options.disallowPathInNameForDerived && options.name.includes('/')) {
         if (!options.nameAndDirectoryFormat) {
-            output.warn({
+            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}".`,
@@ -116,13 +116,24 @@ function getNameAndDirectoryOptionFormats(tree, options) {
 }
 function getAsProvidedOptions(tree, options) {
     const relativeCwd = getRelativeCwd();
-    const asProvidedDirectory = options.directory
-        ? joinPathFragments(relativeCwd, options.directory)
-        : relativeCwd;
+    let asProvidedDirectory;
+    if (options.directory) {
+        // append the directory to the current working directory if it doesn't start with it
+        if (options.directory === relativeCwd ||
+            options.directory.startsWith(`${relativeCwd}/`)) {
+            asProvidedDirectory = options.directory;
+        }
+        else {
+            asProvidedDirectory = (0, devkit_exports_1.joinPathFragments)(relativeCwd, options.directory);
+        }
+    }
+    else {
+        asProvidedDirectory = relativeCwd;
+    }
     const asProvidedProject = findProjectFromPath(tree, asProvidedDirectory);
     const asProvidedFileName = options.fileName ??
         (options.suffix ? `${options.name}.${options.suffix}` : options.name);
-    const asProvidedFilePath = joinPathFragments(asProvidedDirectory, `${asProvidedFileName}.${options.fileExtension}`);
+    const asProvidedFilePath = (0, devkit_exports_1.joinPathFragments)(asProvidedDirectory, `${asProvidedFileName}.${options.fileExtension}`);
     return {
         artifactName: options.name,
         directory: asProvidedDirectory,
@@ -132,7 +143,7 @@ function getAsProvidedOptions(tree, options) {
     };
 }
 function getDerivedOptions(tree, options, asProvidedOptions, extractedDirectory) {
-    const projects = getProjects(tree);
+    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.`);
     }
@@ -141,22 +152,22 @@ function getDerivedOptions(tree, options, asProvidedOptions, extractedDirectory)
     const derivedName = options.name;
     const baseDirectory = options.directory
         ? (0, names_1.names)(options.directory).fileName
-        : joinPathFragments(project.sourceRoot ?? joinPathFragments(project.root, 'src'), project.projectType === 'application' ? 'app' : 'lib', extractedDirectory ?? '');
+        : (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'
-        ? joinPathFragments(project.sourceRoot ?? project.root, options.derivedDirectory, options.flat
+        ? (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
-            ? normalizePath(baseDirectory)
-            : joinPathFragments(baseDirectory, options.pascalCaseDirectory
+            ? (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) {
-            output.warn({
+            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.`,
@@ -177,7 +188,7 @@ function getDerivedOptions(tree, options, asProvidedOptions, extractedDirectory)
             ? (0, names_1.names)(derivedFileName).className
             : (0, names_1.names)(derivedFileName).fileName;
     }
-    const derivedFilePath = joinPathFragments(derivedDirectory, `${derivedFileName}.${options.fileExtension}`);
+    const derivedFilePath = (0, devkit_exports_1.joinPathFragments)(derivedDirectory, `${derivedFileName}.${options.fileExtension}`);
     return {
         artifactName: derivedName,
         directory: derivedDirectory,
@@ -199,16 +210,16 @@ function validateResolvedProject(tree, project, options, normalizedDirectory) {
 }
 function findProjectFromPath(tree, path) {
     const projectConfigurations = {};
-    const projects = getProjects(tree);
+    const projects = (0, devkit_exports_1.getProjects)(tree);
     for (const [projectName, project] of projects) {
         projectConfigurations[projectName] = project;
     }
-    const projectRootMappings = createProjectRootMappingsFromProjectConfigurations(projectConfigurations);
-    return findProjectForPath(path, projectRootMappings);
+    const projectRootMappings = (0, devkit_internals_1.createProjectRootMappingsFromProjectConfigurations)(projectConfigurations);
+    return (0, devkit_internals_1.findProjectForPath)(path, projectRootMappings);
 }
 function isDirectoryUnderProjectRoot(directory, projectRoot) {
-    const normalizedDirectory = joinPathFragments(workspaceRoot, directory);
-    const normalizedProjectRoot = joinPathFragments(workspaceRoot, projectRoot).replace(/\/$/, '');
+    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}/`));
 }
@@ -216,23 +227,23 @@ function isTTY() {
     return !!process.stdout.isTTY && process.env['CI'] !== 'true';
 }
 function getRelativeCwd() {
-    return normalizePath((0, path_1.relative)(workspaceRoot, getCwd()));
+    return (0, devkit_exports_1.normalizePath)((0, path_1.relative)(devkit_exports_1.workspaceRoot, getCwd()));
 }
 exports.getRelativeCwd = getRelativeCwd;
 /**
  * Function for setting cwd during testing
  */
 function setCwd(path) {
-    process.env.INIT_CWD = (0, path_1.join)(workspaceRoot, path);
+    process.env.INIT_CWD = (0, path_1.join)(devkit_exports_1.workspaceRoot, path);
 }
 exports.setCwd = setCwd;
 function getCwd() {
-    return process.env.INIT_CWD?.startsWith(workspaceRoot)
+    return process.env.INIT_CWD?.startsWith(devkit_exports_1.workspaceRoot)
         ? process.env.INIT_CWD
         : process.cwd();
 }
 function extractNameAndDirectoryFromName(rawName) {
-    const parsedName = normalizePath(rawName).split('/');
+    const parsedName = (0, devkit_exports_1.normalizePath)(rawName).split('/');
     const name = parsedName.pop();
     const directory = parsedName.length ? parsedName.join('/') : undefined;
     return { name, directory };

package/src/generators/executor-options-utils.d.ts

@@ -1,5 +1,4 @@
-import type { Tree } from 'nx/src/generators/tree';
-import type { ProjectGraph } from 'nx/src/config/project-graph';
+import { ProjectGraph, Tree } from 'nx/src/devkit-exports';
 type CallBack<T> = (currentValue: T, project: string, target: string, configuration?: string) => void;
 /**
  * Calls a function for each different options that an executor is configured with

package/src/generators/executor-options-utils.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.forEachExecutorOptionsInGraph = exports.forEachExecutorOptions = void 0;
-const nx_1 = require("../../nx");
-const { getProjects } = (0, nx_1.requireNx)();
+const devkit_exports_1 = require("nx/src/devkit-exports");
 /**
  * Calls a function for each different options that an executor is configured with
  */
@@ -15,7 +14,7 @@ executorName,
  * Callback that is called for each options configured for a builder
  */
 callback) {
-    forEachProjectConfig(getProjects(tree), executorName, callback);
+    forEachProjectConfig((0, devkit_exports_1.getProjects)(tree), executorName, callback);
 }
 exports.forEachExecutorOptions = forEachExecutorOptions;
 /**
@@ -34,9 +33,7 @@ function forEachProjectConfig(projects, executorName, callback) {
             if (executorName !== target.executor) {
                 continue;
             }
-            if (target.options) {
-                callback(target.options, projectName, targetName);
-            }
+            callback(target.options ?? {}, projectName, targetName);
             if (!target.configurations) {
                 continue;
             }

package/src/generators/format-files.d.ts

@@ -1,4 +1,4 @@
-import type { Tree } from 'nx/src/generators/tree';
+import { Tree } from 'nx/src/devkit-exports';
 /**
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree

package/src/generators/format-files.js

@@ -2,11 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatFiles = void 0;
 const path = require("path");
-const nx_1 = require("../../nx");
-let { updateJson, readJson, sortObjectByKeys } = (0, nx_1.requireNx)();
-// TODO: Remove this in Nx 19 when Nx 16.7.0 is no longer supported
-sortObjectByKeys =
-    sortObjectByKeys ?? require('nx/src/utils/object-sort').sortObjectByKeys;
+const devkit_exports_1 = require("nx/src/devkit-exports");
+const devkit_internals_1 = require("nx/src/devkit-internals");
 /**
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
@@ -56,11 +53,11 @@ function sortTsConfig(tree) {
         if (!tsConfigPath) {
             return;
         }
-        updateJson(tree, tsConfigPath, (tsconfig) => ({
+        (0, devkit_exports_1.updateJson)(tree, tsConfigPath, (tsconfig) => ({
             ...tsconfig,
             compilerOptions: {
                 ...tsconfig.compilerOptions,
-                paths: sortObjectByKeys(tsconfig.compilerOptions.paths),
+                paths: (0, devkit_internals_1.sortObjectByKeys)(tsconfig.compilerOptions.paths),
             },
         }));
     }
@@ -79,7 +76,7 @@ function getRootTsConfigPath(tree) {
 function getChangedPrettierConfigInTree(tree) {
     if (tree.listChanges().find((file) => file.path === '.prettierrc')) {
         try {
-            return readJson(tree, '.prettierrc');
+            return (0, devkit_exports_1.readJson)(tree, '.prettierrc');
         }
         catch {
             return null;

package/src/generators/generate-files.d.ts

@@ -1,4 +1,21 @@
-import type { Tree } from 'nx/src/generators/tree';
+import { type Tree } from 'nx/src/devkit-exports';
+/**
+ * Specify what should be done when a file is generated but already exists on the system
+ */
+export declare enum OverwriteStrategy {
+    Overwrite = "overwrite",
+    KeepExisting = "keepExisting",
+    ThrowIfExisting = "throwIfExisting"
+}
+/**
+ * Options for the generateFiles function
+ */
+export interface GenerateFilesOptions {
+    /**
+     * Specify what should be done when a file is generated but already exists on the system
+     */
+    overwriteStrategy?: OverwriteStrategy;
+}
 /**
  * Generates a folder of files based on provided templates.
  *
@@ -20,7 +37,8 @@ import type { Tree } from 'nx/src/generators/tree';
  * @param srcFolder - the source folder of files (absolute path)
  * @param target - the target folder (relative to the tree root)
  * @param substitutions - an object of key-value pairs
+ * @param options - See {@link GenerateFilesOptions}
  */
 export declare function generateFiles(tree: Tree, srcFolder: string, target: string, substitutions: {
     [k: string]: any;
-}): void;
+}, options?: GenerateFilesOptions): void;

package/src/generators/generate-files.js

@@ -1,11 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFiles = void 0;
+exports.generateFiles = exports.OverwriteStrategy = void 0;
 const fs_1 = require("fs");
 const path = require("path");
-const nx_1 = require("../../nx");
 const binary_extensions_1 = require("../utils/binary-extensions");
-const { logger } = (0, nx_1.requireNx)();
+const devkit_exports_1 = require("nx/src/devkit-exports");
+/**
+ * Specify what should be done when a file is generated but already exists on the system
+ */
+var OverwriteStrategy;
+(function (OverwriteStrategy) {
+    OverwriteStrategy["Overwrite"] = "overwrite";
+    OverwriteStrategy["KeepExisting"] = "keepExisting";
+    OverwriteStrategy["ThrowIfExisting"] = "throwIfExisting";
+})(OverwriteStrategy || (exports.OverwriteStrategy = OverwriteStrategy = {}));
 /**
  * Generates a folder of files based on provided templates.
  *
@@ -27,8 +35,13 @@ const { logger } = (0, nx_1.requireNx)();
  * @param srcFolder - the source folder of files (absolute path)
  * @param target - the target folder (relative to the tree root)
  * @param substitutions - an object of key-value pairs
+ * @param options - See {@link GenerateFilesOptions}
  */
-function generateFiles(tree, srcFolder, target, substitutions) {
+function generateFiles(tree, srcFolder, target, substitutions, options = {
+    overwriteStrategy: OverwriteStrategy.Overwrite,
+}) {
+    options ??= {};
+    options.overwriteStrategy ??= OverwriteStrategy.Overwrite;
     const ejs = require('ejs');
     const files = allFilesInDir(srcFolder);
     if (files.length === 0) {
@@ -38,6 +51,15 @@ function generateFiles(tree, srcFolder, target, substitutions) {
         files.forEach((filePath) => {
             let newContent;
             const computedPath = computePath(srcFolder, target, filePath, substitutions);
+            if (tree.exists(computedPath)) {
+                if (options.overwriteStrategy === OverwriteStrategy.KeepExisting) {
+                    return;
+                }
+                else if (options.overwriteStrategy === OverwriteStrategy.ThrowIfExisting) {
+                    throw new Error(`Generated file already exists, not allowed by overwrite strategy in generator (${computedPath})`);
+                }
+                // else: file should be overwritten, so just fall through to file generation
+            }
             if ((0, binary_extensions_1.isBinaryPath)(filePath)) {
                 newContent = (0, fs_1.readFileSync)(filePath);
             }
@@ -49,7 +71,7 @@ function generateFiles(tree, srcFolder, target, substitutions) {
                     });
                 }
                 catch (e) {
-                    logger.error(`Error in ${filePath.replace(`${tree.root}/`, '')}:`);
+                    devkit_exports_1.logger.error(`Error in ${filePath.replace(`${tree.root}/`, '')}:`);
                     throw e;
                 }
             }

package/src/generators/plugin-migrations/executor-to-plugin-migrator.d.ts

@@ -0,0 +1,10 @@
+import { ProjectGraph, TargetConfiguration, Tree, CreateNodes, CreateNodesV2 } from 'nx/src/devkit-exports';
+type PluginOptionsBuilder<T> = (targetName: string) => T;
+type PostTargetTransformer = (targetConfiguration: TargetConfiguration, tree: Tree, projectDetails: {
+    projectName: string;
+    root: string;
+}, inferredTargetConfiguration: TargetConfiguration) => TargetConfiguration;
+type SkipTargetFilter = (targetConfiguration: TargetConfiguration) => [boolean, string];
+export declare function migrateExecutorToPlugin<T>(tree: Tree, projectGraph: ProjectGraph, executor: string, pluginPath: string, pluginOptionsBuilder: PluginOptionsBuilder<T>, postTargetTransformer: PostTargetTransformer, createNodes: CreateNodesV2<T>, specificProjectToMigrate?: string, skipTargetFilter?: SkipTargetFilter): Promise<Map<string, Set<string>>>;
+export declare function migrateExecutorToPluginV1<T>(tree: Tree, projectGraph: ProjectGraph, executor: string, pluginPath: string, pluginOptionsBuilder: PluginOptionsBuilder<T>, postTargetTransformer: PostTargetTransformer, createNodes: CreateNodes<T>, specificProjectToMigrate?: string, skipTargetFilter?: SkipTargetFilter): Promise<Map<string, Set<string>>>;
+export {};