Add @convex-dev/eslint-plugin to the convex-helpers repo (#829)

Author: ianmacartney

convex/counter.ts

@@ -30,8 +30,11 @@ export const getCountersPaginated = query({
   },
 });
 
-export const getCounterOrThrow = query(
-  async (ctx, { counterName }: { counterName: string }): Promise<number> => {
+export const getCounterOrThrow = query({
+  args: {
+    counterName: v.string(),
+  },
+  handler: async (ctx, { counterName }): Promise<number> => {
     const counterDoc = await ctx.db
       .query("counter_table")
       .filter((q) => q.eq(q.field("name"), counterName))
@@ -41,7 +44,7 @@ export const getCounterOrThrow = query(
     }
     return counterDoc.counter;
   },
-);
+});
 
 export const upload = action({
   args: { data: v.any() },

convex/migrationsExample.ts

@@ -55,11 +55,12 @@ const standardMigrations = [
   internal.migrationsExample.cleanUpBrokenRefs,
 ];
 
-export const status = internalQuery(
-  async (ctx): Promise<MigrationStatus<"migrations">[]> => {
+export const status = internalQuery({
+  args: {},
+  handler: async (ctx): Promise<MigrationStatus<"migrations">[]> => {
     return await getStatus(ctx, { migrationTable: "migrations" });
   },
-);
+});
 
 export const cancel = internalMutation({
   args: { fn: v.string() },

convex/presence.ts

@@ -7,6 +7,7 @@
  * - Use Convex `auth` to authenticate users rather than passing up a "user"
  * - Check that the user is allowed to be in a given room.
  */
+import { v } from "convex/values";
 import { query, mutation } from "./_generated/server";
 
 const LIST_LIMIT = 20;
@@ -21,11 +22,13 @@ const LIST_LIMIT = 20;
  * page, chat channel, game instance.
  * @param user - The user associated with the presence data.
  */
-export const update = mutation(
-  async (
-    { db },
-    { room, user, data }: { room: string; user: string; data: any },
-  ) => {
+export const update = mutation({
+  args: {
+    room: v.string(),
+    user: v.string(),
+    data: v.any(),
+  },
+  handler: async ({ db }, { room, user, data }) => {
     const existing = await db
       .query("presence")
       .withIndex("user_room", (q) => q.eq("user", user).eq("room", room))
@@ -41,7 +44,7 @@ export const update = mutation(
       });
     }
   },
-);
+});
 
 /**
  * Updates the "updated" timestamp for a given user's presence in a room.
@@ -50,8 +53,12 @@ export const update = mutation(
  * page, chat channel, game instance.
  * @param user - The user associated with the presence data.
  */
-export const heartbeat = mutation(
-  async ({ db }, { room, user }: { room: string; user: string }) => {
+export const heartbeat = mutation({
+  args: {
+    room: v.string(),
+    user: v.string(),
+  },
+  handler: async ({ db }, { room, user }) => {
     const existing = await db
       .query("presence")
       .withIndex("user_room", (q) => q.eq("user", user).eq("room", room))
@@ -60,7 +67,7 @@ export const heartbeat = mutation(
       await db.patch(existing._id, { updated: Date.now() });
     }
   },
-);
+});
 
 /**
  * Lists the presence data for N users in a room, ordered by recent update.
@@ -70,16 +77,21 @@ export const heartbeat = mutation(
  * @returns A list of presence objects, ordered by recent update, limited to
  * the most recent N.
  */
-export const list = query(async ({ db }, { room }: { room: string }) => {
-  const presence = await db
-    .query("presence")
-    .withIndex("room_updated", (q) => q.eq("room", room))
-    .order("desc")
-    .take(LIST_LIMIT);
-  return presence.map(({ _creationTime, updated, user, data }) => ({
-    created: _creationTime,
-    updated,
-    user,
-    data,
-  }));
+export const list = query({
+  args: {
+    room: v.string(),
+  },
+  handler: async ({ db }, { room }) => {
+    const presence = await db
+      .query("presence")
+      .withIndex("room_updated", (q) => q.eq("room", room))
+      .order("desc")
+      .take(LIST_LIMIT);
+    return presence.map(({ _creationTime, updated, user, data }) => ({
+      created: _creationTime,
+      updated,
+      user,
+      data,
+    }));
+  },
 });

eslint.config.mjs

@@ -3,6 +3,7 @@ import pluginJs from "@eslint/js";
 import tseslint from "typescript-eslint";
 import reactPlugin from "eslint-plugin-react";
 import reactHooks from "eslint-plugin-react-hooks";
+import convexPlugin from "@convex-dev/eslint-plugin";
 
 export default [
   { files: ["src/**/*.{js,mjs,cjs,ts,tsx}", "convex/**/*.{ts,tsx}"] },
@@ -21,6 +22,14 @@ export default [
       "vitest.workspace.ts",
     ],
   },
+  {
+    files: ["convex/**/*.ts", "packages/convex-helpers/server/**/*.ts"],
+    ignores: ["packages/convex-helpers/server/_generated/**/*"],
+    plugins: {
+      "@convex-dev": convexPlugin,
+    },
+    rules: convexPlugin.configs.recommended[0].rules,
+  },
   {
     languageOptions: {
       globals: globals.worker,