fix(devkit): await prettier format for v3 compatibility (#18664)

nrwl · Aug 20, 2023 · 2638bb0 · 2638bb0 · vercel · Aug 20, 2023
1 parent 7d4e2fe
commit 2638bb0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/packages/devkit/src/generators/format-files.ts b/packages/devkit/src/generators/format-files.ts
@@ -55,7 +55,10 @@ export async function formatFiles(tree: Tree): Promise<void> {
 
         tree.write(
           file.path,
-          prettier.format(file.content.toString('utf-8'), options)
+          // In prettier v3 the format result is a promise
+          await (prettier.format(file.content.toString('utf-8'), options) as
+            | Promise<string>
+            | string)
         );
       } catch (e) {
         console.warn(`Could not format ${file.path}. Error: "${e.message}"`);

diff --git a/packages/nx/src/generators/internal-utils/format-changed-files-with-prettier-if-available.ts b/packages/nx/src/generators/internal-utils/format-changed-files-with-prettier-if-available.ts
@@ -45,7 +45,10 @@ export async function formatChangedFilesWithPrettierIfAvailable(
 
         tree.write(
           file.path,
-          prettier.format(file.content.toString('utf-8'), options)
+          // In prettier v3 the format result is a promise
+          await (prettier.format(file.content.toString('utf-8'), options) as
+            | Promise<string>
+            | string)
         );
       } catch (e) {
         console.warn(`Could not format ${file.path}. Error: "${e.message}"`);

diff --git a/packages/workspace/src/utils/rules/format-files.ts b/packages/workspace/src/utils/rules/format-files.ts
@@ -63,7 +63,13 @@ export function formatFiles(
         }
 
         try {
-          host.overwrite(file.path, prettier.format(file.content, options));
+          host.overwrite(
+            file.path,
+            // In prettier v3 the format result is a promise
+            await (prettier.format(file.content, options) as
+              | Promise<string>
+              | string)
+          );
         } catch (e) {
           context.logger.warn(
             `Could not format ${file.path} because ${e.message}`