Use convex linter in deploy tool

Author: thomasballinger

app/lib/runtime/action-runner.ts

@@ -412,17 +412,26 @@ export class ActionRunner {
           };
 
           //         START         deploy tool call
-          //          /
-          //         /
-          //  codegen              `convex typecheck` includes typecheck of convex/ dir
-          // + typecheck
-          //       |
-          //       |
-          // app typecheck         `tsc --noEmit --project tsconfig.app.json
-          //         \
-          //          \
+          //          / \
+          //         /   \
+          //  codegen     \        `convex typecheck` includes typecheck of convex/ dir
+          // + typecheck   \
+          //       |       ESLint  `eslint` must not include rules that check imports
+          //       |        /
+          // app typecheck /       `tsc --noEmit --project tsconfig.app.json
+          //         \    /
+          //          \  /
           //         deploy        `deploy` can fail
 
+          // ESLint doesn't need to wait for codegen since we don't use rules like plugin-import to validate imports.
+          const runEslint = async () => {
+            if (await hasMatchingEslintConfig(container)) {
+              // ESLint results don't stream to the terminal
+              return await run(['eslint', 'convex'], outputLabels.convexLint);
+            }
+            return '';
+          };
+
           const runCodegenAndTypecheck = async (onOutput?: (output: string) => void) => {
             // Convex codegen does a convex directory typecheck, then tsc does a full-project typecheck.
             let output = await run(['convex', 'codegen'], outputLabels.convexTypecheck, onOutput);
@@ -435,9 +444,14 @@ export class ActionRunner {
           };
 
           const t0 = performance.now();
-          result += await runCodegenAndTypecheck((output) => {
-            this.terminalOutput.set(output);
-          });
+          const [eslintResult, codegenResult] = await Promise.all([
+            runEslint(),
+            runCodegenAndTypecheck((output) => {
+              this.terminalOutput.set(output);
+            }),
+          ]);
+          result += codegenResult;
+          result += eslintResult;
           result += await run(['convex', 'dev', '--once', '--typecheck=disable'], outputLabels.convexDeploy);
           const time = performance.now() - t0;
           logger.info('deploy action finished in', time);
@@ -513,3 +527,16 @@ function cleanConvexOutput(output: string) {
   }
   return result;
 }
+
+async function hasMatchingEslintConfig(container: WebContainer): Promise<boolean> {
+  // Only run eslint if the file we expect is present and contains '@convex-dev/eslint-plugin'.
+  let contents = '';
+  try {
+    contents = await container.fs.readFile('eslint.config.js', 'utf-8');
+  } catch (e: any) {
+    if (!e.message.includes('ENOENT: no such file or directory')) {
+      throw e;
+    }
+  }
+  return contents.includes('@convex-dev/eslint-plugin');
+}

app/lib/runtime/deployToolOutputLabels.ts

@@ -1,6 +1,8 @@
 export const outputLabels = {
+  convexCodegen: 'ConvexCodegen',
   convexTypecheck: 'ConvexTypecheck',
   frontendTypecheck: 'FrontendTypecheck',
+  convexLint: 'ConvexLint',
   convexDeploy: 'ConvexDeploy',
 } as const;
 export type OutputLabels = (typeof outputLabels)[keyof typeof outputLabels];

app/lib/stores/startup/useContainerSetup.ts

@@ -21,7 +21,7 @@ import { getFileUpdateCounter } from '~/lib/stores/fileUpdateCounter';
 import { chatSyncState } from '~/lib/stores/startup/history';
 import { FILE_EVENTS_DEBOUNCE_MS } from '~/lib/stores/files';
 
-const TEMPLATE_URL = '/template-snapshot-80c98556.bin';
+const TEMPLATE_URL = '/template-snapshot-86225363.bin';
 
 export function useNewChatContainerSetup() {
   const convex = useConvex();

public/template-snapshot-86225363.bin

@@ -3,6 +3,7 @@ import globals from "globals";
 import reactHooks from "eslint-plugin-react-hooks";
 import reactRefresh from "eslint-plugin-react-refresh";
 import tseslint from "typescript-eslint";
+import convexPlugin from "@convex-dev/eslint-plugin";
 
 export default tseslint.config(
   {
@@ -15,6 +16,8 @@ export default tseslint.config(
       "vite.config.ts",
     ],
   },
+  // limited, commonsense Convex function rules
+  ...convexPlugin.configs.recommended,
   {
     extends: [
       js.configs.recommended,

template/eslint.config.js

@@ -11,6 +11,7 @@
   },
   "dependencies": {
     "@convex-dev/auth": "^0.0.80",
+    "@convex-dev/eslint-plugin": "0.0.1-alpha.4",
     "clsx": "^2.1.1",
     "convex": "1.21.1-alpha.1",
     "react": "^19.0.0",