Set up ESLint in @convex-dev/eslint-plugin (#41767)

GitOrigin-RevId: 99824490b61f24e8243fe661bcbd86ad7cb268fe

Author: Nicolapps

npm-packages/@convex-dev/eslint-plugin/.eslintrc

@@ -0,0 +1,13 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import { defineConfig, globalIgnores } from "eslint/config";
+import tseslint from "typescript-eslint";
+import eslintPlugin from "eslint-plugin-eslint-plugin";
+
+export default defineConfig(
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  eslintPlugin.configs.recommended,
+  globalIgnores(["dist/**", "node_modules/**"]),
+);

npm-packages/@convex-dev/eslint-plugin/eslint.config.mjs

@@ -4,28 +4,28 @@
   "license": "Apache-2.0",
   "type": "module",
   "scripts": {
-    "dev": "npm-run-all --parallel dev:db dev:frontend",
-    "dev:db": "convex dev",
-    "dev:frontend": "vite --open --clearScreen false",
     "build": "tshy",
-    "preview": "vite preview",
     "test": "vitest run",
     "test:types": "tsc --noEmit",
     "test:watch": "vitest",
-    "prepare": "tshy"
+    "prepare": "tshy",
+    "lint": "eslint ."
   },
   "dependencies": {
     "@typescript-eslint/utils": "~8.38.0"
   },
   "devDependencies": {
+    "@eslint/js": "~9.34.0",
     "@types/eslint": "~9.6.1",
     "@types/node": "^18.17.0",
     "@typescript-eslint/rule-tester": "~8.38.0",
     "@typescript-eslint/types": "~8.38.0",
     "eslint": "^9.37.0",
     "eslint-doc-generator": "^1.7.1",
+    "eslint-plugin-eslint-plugin": "~7.0.0",
     "tshy": "^3.0.0",
     "typescript": "^5.9.2",
+    "typescript-eslint": "^8.45.0",
     "vitest": "^3.2.4"
   },
   "tshy": {

npm-packages/@convex-dev/eslint-plugin/package.json

@@ -8,7 +8,7 @@ const rules = {
   "no-args-without-validator": noArgsWithoutValidator,
   "no-missing-args-validator": noMissingArgs,
   "import-wrong-runtime": noImportUseNode,
-} satisfies Record<string, RuleModule<any>>;
+} satisfies Record<string, RuleModule<string, unknown[]>>;
 
 const recommendedRules = {
   // This rule is a good idea but bothersome to convert projects to later:
@@ -32,8 +32,10 @@ const isESM = typeof require === "undefined";
 const plugin = {
   // loose types so this can work with ESlint 8 and 9
   configs: {} as {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     recommended: any;
     /** Only available in ESlint 8 */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     recommendedRulesCustomConvexDirectoryLocation: any;
   },
   meta: {

npm-packages/@convex-dev/eslint-plugin/src/index.ts

@@ -1,6 +1,5 @@
 import path from "path";
 import fs from "fs";
-import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
 import { createRule, isEntryPoint } from "../util.js";
 
 export const noImportUseNode = createRule({

npm-packages/@convex-dev/eslint-plugin/src/lib/noImportUseNode.ts

@@ -1,5 +1,9 @@
 import type { TSESTree } from "@typescript-eslint/utils";
 import { CONVEX_REGISTRARS, createRule } from "../util.js";
+import {
+  ReportFixFunction,
+  RuleContext,
+} from "@typescript-eslint/utils/ts-eslint";
 
 /**
  * Helper function to check if an object expression has an args property
@@ -44,9 +48,9 @@ function getHandlerProperty(
  * Helper function to create a fix for missing args property
  */
 function createArgsFix(
-  context: any,
+  context: RuleContext<string, unknown[]>,
   objectArg: TSESTree.ObjectExpression,
-): ((fixer: any) => any) | undefined {
+): ReportFixFunction {
   return (fixer) => {
     const sourceCode = context.getSourceCode();
     const objectText = sourceCode.getText(objectArg);

npm-packages/@convex-dev/eslint-plugin/src/lib/noMissingArgs.ts

@@ -74,9 +74,6 @@ export const noOldRegisteredFunctionSyntax = createRule({
             node: node.init,
             messageId: "use-object-syntax",
             fix: (fixer) => {
-              // Get function parameters and body
-              const params = functionArg.params;
-
               // Check if the function has a second parameter (args)
               const hasArgsParam = hasFunctionArgs(functionArg);
 

npm-packages/@convex-dev/eslint-plugin/src/lib/noOldRegisteredFunctionSyntax.ts

@@ -108,6 +108,7 @@
     "@types/node": ["^20", "^22.5.4"],
     "@types/react": ["^18", "^18.3.17", "^18.2.65"],
     "@types/react-dom": ["^18", "^18.3.1", "^18.2.21"],
+    "typescript-eslint": ["^8.45.0"],
     "@typescript-eslint/eslint-plugin": ["^8.45.0"],
     //"eslint": ["^8"],
     "@eslint/eslintrc": ["^3"],