Require user opt-in to typecheck components (#30327)

GitOrigin-RevId: ba30721ddf11ea3adea02b1a4bf1b083412d1b62
get-convex · Oct 4, 2024 · 96c5f6f · 96c5f6f
1 parent ecbf352
commit 96c5f6f
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 2 deletions.
diff --git a/npm-packages/convex/src/cli/deploy.ts b/npm-packages/convex/src/cli/deploy.ts
@@ -56,6 +56,11 @@ export const deploy = new Command("deploy")
       .choices(["enable", "try", "disable"] as const)
       .default("try" as const),
   )
+  .option(
+    "--typecheck-components",
+    "Check TypeScript files within component implementations with `tsc --noEmit`.",
+    false,
+  )
   .addOption(
     new Option(
       "--codegen <mode>",
@@ -167,6 +172,7 @@ async function deployToNewPreviewDeployment(
     cmd?: string | undefined;
     verbose?: boolean | undefined;
     typecheck: "enable" | "try" | "disable";
+    typecheckComponents: boolean;
     codegen: "enable" | "disable";
 
     debug?: boolean | undefined;
@@ -228,6 +234,7 @@ async function deployToNewPreviewDeployment(
     verbose: !!options.verbose,
     dryRun: false,
     typecheck: options.typecheck,
+    typecheckComponents: options.typecheckComponents,
     debug: !!options.debug,
     debugBundlePath: options.debugBundlePath,
     codegen: options.codegen === "enable",
@@ -265,6 +272,7 @@ async function deployToExistingDeployment(
     dryRun?: boolean | undefined;
     yes?: boolean | undefined;
     typecheck: "enable" | "try" | "disable";
+    typecheckComponents: boolean;
     codegen: "enable" | "disable";
     cmd?: string | undefined;
     cmdUrlEnvVarName?: string | undefined;
@@ -323,6 +331,7 @@ async function deployToExistingDeployment(
     verbose: !!options.verbose,
     dryRun: !!options.dryRun,
     typecheck: options.typecheck,
+    typecheckComponents: options.typecheckComponents,
     debug: !!options.debug,
     debugBundlePath: options.debugBundlePath,
     codegen: options.codegen === "enable",

diff --git a/npm-packages/convex/src/cli/dev.ts b/npm-packages/convex/src/cli/dev.ts
@@ -47,6 +47,11 @@ export const dev = new Command("dev")
       .choices(["enable", "try", "disable"] as const)
       .default("try" as const),
   )
+  .option(
+    "--typecheck-components",
+    "Check TypeScript files within component implementations with `tsc --noEmit`.",
+    false,
+  )
   .addOption(
     new Option("--codegen <mode>", "Regenerate code in `convex/_generated/`")
       .choices(["enable", "disable"] as const)
@@ -196,6 +201,7 @@ export const dev = new Command("dev")
           verbose: !!cmdOptions.verbose,
           dryRun: false,
           typecheck: cmdOptions.typecheck,
+          typecheckComponents: !!cmdOptions.typecheckComponents,
           debug: false,
           debugBundlePath: cmdOptions.debugBundlePath,
           codegen: cmdOptions.codegen === "enable",

diff --git a/npm-packages/convex/src/cli/lib/components.ts b/npm-packages/convex/src/cli/lib/components.ts
@@ -100,6 +100,7 @@ export async function runCodegen(ctx: Context, options: CodegenOptions) {
         verbose: options.dryRun,
         codegen: true,
         liveComponentSources: options.liveComponentSources,
+        typecheckComponents: false,
       },
     );
   } else {
@@ -140,6 +141,7 @@ async function startComponentsPushAndCodegen(
   configPath: string,
   options: {
     typecheck: TypeCheckMode;
+    typecheckComponents: boolean;
     adminKey: string;
     url: string;
     verbose: boolean;
@@ -331,8 +333,10 @@ async function startComponentsPushAndCodegen(
   changeSpinner(ctx, "Running TypeScript...");
   await parentSpan.enterAsync("typeCheckFunctionsInMode", async () => {
     await typeCheckFunctionsInMode(ctx, options.typecheck, rootComponent.path);
-    for (const directory of components.values()) {
-      await typeCheckFunctionsInMode(ctx, options.typecheck, directory.path);
+    if (options.typecheckComponents) {
+      for (const directory of components.values()) {
+        await typeCheckFunctionsInMode(ctx, options.typecheck, directory.path);
+      }
     }
   });
 

diff --git a/npm-packages/convex/src/cli/lib/push.ts b/npm-packages/convex/src/cli/lib/push.ts
@@ -18,6 +18,7 @@ export type PushOptions = {
   verbose: boolean;
   dryRun: boolean;
   typecheck: "enable" | "try" | "disable";
+  typecheckComponents: boolean;
   debug: boolean;
   debugBundlePath?: string;
   codegen: boolean;

diff --git a/npm-packages/convex/src/cli/run.ts b/npm-packages/convex/src/cli/run.ts
@@ -36,6 +36,11 @@ export const run = new Command("run")
       .choices(["enable", "try", "disable"] as const)
       .default("try" as const),
   )
+  .option(
+    "--typecheck-components",
+    "Check TypeScript files within component implementations with `tsc --noEmit`.",
+    false,
+  )
   .addOption(
     new Option("--codegen <mode>", "Regenerate code in `convex/_generated/`")
       .choices(["enable", "disable"] as const)
@@ -84,6 +89,7 @@ export const run = new Command("run")
           verbose: false,
           dryRun: false,
           typecheck: options.typecheck,
+          typecheckComponents: options.typecheckComponents,
           debug: false,
           codegen: options.codegen === "enable",
           url: deploymentUrl,