SuperAPI AI 工具集

convex-eslint

编程与开发

查看项目

更新于 10-16 01:27

技能介绍

用途:编写所有 Convex 函数时默认通过 @convex-dev/eslint-plugin 的规则检查,以减少常见缺陷、安全隐患并保证代码质量。

安装与配置:运行 npm i @convex-dev/eslint-plugin --save-dev 安装。在 eslint.config.js 中引入并启用推荐配置,例如 import { defineConfig } from "eslint/config" 与 import convexPlugin from "@convex-dev/eslint-plugin",并导出 defineConfig([...convexPlugin.configs.recommended])。

主要规则:no-old-registered-function-syntax 要求使用带 handler 属性的对象语法,而非裸函数语法;require-argument-validators 要求所有函数都带 args 对象,即使为空也要写 args: {};explicit-table-ids 要求数据库操作中显式写明表名(Convex 1.31.0+),如 ctx.db.get("messages", messageId)、patch、replace、delete 均传表名;import-wrong-runtime 禁止把 Node 运行时文件(带 "use node")导入到 Convex 运行时文件。

使用方式:提交前运行 npx eslint convex/ 检查;可用 npx eslint convex/ --fix 自动修复迁移。explicit-table-ids 提供迁移 codemod:npx @convex-dev/codemod@latest explicit-ids。建议接入 CI 以及时捕获违规,并在编辑器中配置实时反馈。

限制:资料仅列出上述规则与配置方式,未提供其他规则、收费、价格、平台或效果信息。