Don't prettierignore generated README and tsconfig.json (#29446)

Stop prettierignore-ing generated README and tsconfig.json

GitOrigin-RevId: c7b3b807d2ac94a9e234b94814c152c19ef589d2

Author: thomasballinger

demo/convex/README.md

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 # Welcome to your Convex functions directory!
 
 Write your Convex functions here.
@@ -90,5 +88,3 @@ function handleButtonPress() {
 Use the Convex CLI to push your functions to a deployment. See everything
 the Convex CLI can do by running `npx convex -h` in your project root
 directory. To learn more, launch the docs with `npx convex docs`.
-
-/* prettier-ignore-end */

demo/convex/tsconfig.json

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 {
   /* This TypeScript project config describes the environment that
    * Convex functions run in and is used to typecheck them.
@@ -25,5 +23,3 @@
   "include": ["./**/*"],
   "exclude": ["./_generated"]
 }
-
-/* prettier-ignore-end */

npm-packages/convex/src/cli/lib/codegen.ts

@@ -259,7 +259,7 @@ export async function doFinalComponentCodegen(
     serverContents,
     "typescript",
     serverDTSPath,
-    opts,
+    { prettierIgnore: true, ...opts },
   );
 
   const apiDTSPath = path.join(codegenDir, "api.d.ts");
@@ -269,14 +269,10 @@ export async function doFinalComponentCodegen(
     rootComponent,
     componentDirectory,
   );
-  await writeFormattedFile(
-    ctx,
-    tmpDir,
-    apiContents,
-    "typescript",
-    apiDTSPath,
-    opts,
-  );
+  await writeFormattedFile(ctx, tmpDir, apiContents, "typescript", apiDTSPath, {
+    prettierIgnore: true,
+    ...opts,
+  });
 
   if (opts?.generateCommonJSApi || projectConfig.generateCommonJSApi) {
     const apiCjsDTSPath = path.join(codegenDir, "api_cjs.d.ts");
@@ -286,7 +282,7 @@ export async function doFinalComponentCodegen(
       apiContents,
       "typescript",
       apiCjsDTSPath,
-      opts,
+      { prettierIgnore: true, ...opts },
     );
   }
 }
@@ -356,7 +352,7 @@ async function doDataModelCodegen(
     schemaContent.DTS,
     "typescript",
     path.join(codegenDir, "dataModel.d.ts"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
   return ["dataModel.d.ts"];
 }
@@ -374,7 +370,7 @@ async function doServerCodegen(
     serverContent.JS,
     "typescript",
     path.join(codegenDir, "server.js"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
 
   await writeFormattedFile(
@@ -383,7 +379,7 @@ async function doServerCodegen(
     serverContent.DTS,
     "typescript",
     path.join(codegenDir, "server.d.ts"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
 
   return ["server.js", "server.d.ts"];
@@ -402,7 +398,7 @@ async function doInitialComponentServerCodegen(
     componentServerJS(),
     "typescript",
     path.join(codegenDir, "server.js"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
 
   // Don't write our stub if the file already exists: It probably
@@ -415,7 +411,7 @@ async function doInitialComponentServerCodegen(
       componentServerStubDTS(isRoot),
       "typescript",
       path.join(codegenDir, "server.d.ts"),
-      opts,
+      { prettierIgnore: true, ...opts },
     );
   }
 
@@ -437,7 +433,7 @@ async function doInitialComponentApiCodegen(
     apiJS,
     "typescript",
     path.join(codegenDir, "api.js"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
 
   // Don't write the `.d.ts` stub if it already exists.
@@ -450,7 +446,7 @@ async function doInitialComponentApiCodegen(
       apiStubDTS,
       "typescript",
       apiDTSPath,
-      opts,
+      { prettierIgnore: true, ...opts },
     );
   }
 
@@ -464,7 +460,7 @@ async function doInitialComponentApiCodegen(
       apiCjsJS,
       "typescript",
       path.join(codegenDir, "api_cjs.cjs"),
-      opts,
+      { prettierIgnore: true, ...opts },
     );
 
     const cjsStubPath = path.join(codegenDir, "api_cjs.d.cts");
@@ -475,7 +471,7 @@ async function doInitialComponentApiCodegen(
         apiStubDTS,
         "typescript",
         cjsStubPath,
-        opts,
+        { prettierIgnore: true, ...opts },
       );
     }
     writtenFiles.push("api_cjs.cjs", "api_cjs.d.cts");
@@ -502,15 +498,15 @@ async function doApiCodegen(
     apiContent.JS,
     "typescript",
     path.join(codegenDir, "api.js"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
   await writeFormattedFile(
     ctx,
     tmpDir,
     apiContent.DTS,
     "typescript",
     path.join(codegenDir, "api.d.ts"),
-    opts,
+    { prettierIgnore: true, ...opts },
   );
   const writtenFiles = ["api.js", "api.d.ts"];
 
@@ -522,15 +518,15 @@ async function doApiCodegen(
       apiCjsContent.JS,
       "typescript",
       path.join(codegenDir, "api_cjs.cjs"),
-      opts,
+      { prettierIgnore: true, ...opts },
     );
     await writeFormattedFile(
       ctx,
       tmpDir,
       apiCjsContent.DTS,
       "typescript",
       path.join(codegenDir, "api_cjs.d.cts"),
-      opts,
+      { prettierIgnore: true, ...opts },
     );
     writtenFiles.push("api_cjs.cjs", "api_cjs.d.cts");
   }
@@ -547,6 +543,7 @@ async function writeFormattedFile(
   options?: {
     dryRun?: boolean;
     debug?: boolean;
+    prettierIgnore?: boolean;
   },
 ) {
   // Run prettier so we don't have to think about formatting!
@@ -558,11 +555,13 @@ async function writeFormattedFile(
     pluginSearchDirs: false,
   });
   // Then add prettierignore comments so we don't fight with users' prettier configs
-  formattedContents = `/* prettier-ignore-start */
+  if (options?.prettierIgnore) {
+    formattedContents = `/* prettier-ignore-start */
 
 ${formattedContents}
 /* prettier-ignore-end */
 `;
+  }
   if (options?.debug) {
     // NB: The `test_codegen_projects_are_up_to_date` smoke test depends
     // on this output format.

npm-packages/system-udfs/convex/README.md

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 # Welcome to your Convex functions directory!
 
 Write your Convex functions here.
@@ -90,5 +88,3 @@ function handleButtonPress() {
 Use the Convex CLI to push your functions to a deployment. See everything
 the Convex CLI can do by running `npx convex -h` in your project root
 directory. To learn more, launch the docs with `npx convex docs`.
-
-/* prettier-ignore-end */

npm-packages/system-udfs/convex/tsconfig.json

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 {
   /* This TypeScript project config describes the environment that
    * Convex functions run in and is used to typecheck them.
@@ -25,5 +23,3 @@
   "include": ["./**/*"],
   "exclude": ["./_generated"]
 }
-
-/* prettier-ignore-end */

npm-packages/udf-tests/convex/README.md

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 # Welcome to your Convex functions directory!
 
 Write your Convex functions here.
@@ -90,5 +88,3 @@ function handleButtonPress() {
 Use the Convex CLI to push your functions to a deployment. See everything
 the Convex CLI can do by running `npx convex -h` in your project root
 directory. To learn more, launch the docs with `npx convex docs`.
-
-/* prettier-ignore-end */

npm-packages/udf-tests/convex/tsconfig.json

@@ -1,5 +1,3 @@
-/* prettier-ignore-start */
-
 {
   /* This TypeScript project config describes the environment that
    * Convex functions run in and is used to typecheck them.
@@ -25,5 +23,3 @@
   "include": ["./**/*"],
   "exclude": ["./_generated"]
 }
-
-/* prettier-ignore-end */