@nx/devkit 19.2.0-canary.20240604-0594deb → 19.2.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "19.2.0-canary.20240604-0594deb",
+  "version": "19.2.0-rc.0",
   "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": {
@@ -36,7 +36,7 @@
     "semver": "^7.5.3",
     "yargs-parser": "21.1.1",
     "minimatch": "9.0.3",
-    "@nrwl/devkit": "19.2.0-canary.20240604-0594deb"
+    "@nrwl/devkit": "19.2.0-rc.0"
   },
   "peerDependencies": {
     "nx": ">= 17 <= 20"

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/generators/generate-files.d.ts

@@ -1,4 +1,21 @@
-import { Tree } from 'nx/src/devkit-exports';
+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 { Tree } from 'nx/src/devkit-exports';
  * @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,10 +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 binary_extensions_1 = require("../utils/binary-extensions");
 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.
  *
@@ -26,8 +35,13 @@ const devkit_exports_1 = require("nx/src/devkit-exports");
  * @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) {
@@ -37,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);
             }