@nx/devkit 20.1.0-canary.20241018-f971c1b → 20.1.0-canary.20241022-e57b851

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "20.1.0-canary.20241018-f971c1b",
+  "version": "20.1.0-canary.20241022-e57b851",
   "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": {

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

@@ -3,4 +3,10 @@ import { Tree } from 'nx/src/devkit-exports';
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
  */
-export declare function formatFiles(tree: Tree): Promise<void>;
+export declare function formatFiles(tree: Tree, options?: {
+    /**
+     * TODO(v21): Stop sorting tsconfig paths by default, paths are now less common/important
+     * in Nx workspace setups, and the sorting causes comments to be lost.
+     */
+    sortRootTsconfigPaths: boolean;
+}): Promise<void>;

package/src/generators/format-files.js

@@ -8,13 +8,21 @@ const devkit_internals_1 = require("nx/src/devkit-internals");
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
  */
-async function formatFiles(tree) {
+async function formatFiles(tree, options = {
+    /**
+     * TODO(v21): Stop sorting tsconfig paths by default, paths are now less common/important
+     * in Nx workspace setups, and the sorting causes comments to be lost.
+     */
+    sortRootTsconfigPaths: true,
+}) {
     let prettier;
     try {
         prettier = await Promise.resolve().then(() => require('prettier'));
     }
     catch { }
-    sortTsConfig(tree);
+    if (options.sortRootTsconfigPaths) {
+        sortTsConfig(tree);
+    }
     if (!prettier)
         return;
     const files = new Set(tree.listChanges().filter((file) => file.type !== 'DELETE'));