@fitzzero/ quickdraw-lint (英语)

快速draw oxlint 插件和配置 (设计: docs/rfcs/0003-v5.md页:1 规矩是错的 与 5.0 API 相关: 写入订阅者永远不会看到, 帧由 手,读取与表一起生长,绕过被键入的客户端,和 4.x 这已经不复存在。 每个规则都经过测试,每个规则都可以 采用时不首先固定旧代码(基线,以下).

bun add -d @fitzzero/quickdraw-lint oxlint

// .oxlintrc.json in your app
{
  "extends": [
    "./node_modules/@fitzzero/quickdraw-lint/oxlint.base.jsonc",
    // or, in an app built from the quickdraw template, the template config
    // instead: it extends the base and adds the design-system rules
    // "./node_modules/@fitzzero/quickdraw-lint/oxlint.template.jsonc",
  ],
  // plugins, ignorePatterns, env, globals and settings are not inherited
  "plugins": ["typescript", "import", "react", "nextjs", "jsx_a11y"],
  "ignorePatterns": ["**/dist/**", "**/node_modules/**"],
}

配置通过相对自身的路径加载插件, 所以是一个应用程序 需要没有 jsPlugins 进入它自己的。 顶端的评论 oxlint.base.jsonc 列出扩展配置继承什么。 它的路径 覆盖( 明确类型在 packages/shared 财务报告和审定财务报表 packages/db网络 应用的放松预算) **/- 前置, 因此它们是否应用 lint 运行 从应用程序的根或每个软件包目录。 插件运行在 牛林一万五千二或后出.

规则

每个规则都是综合的:克林特的JS插件看到一个文件的语法,没有 类型。 如果一个规则需要猜测,它宁愿缺少一个案件而不是报告 正确的代码; 每一个规则的文件都说它留下了什么.

基础配置打开 除了最后三个 error时,除 no-unused-baseline, (中文(简体) ), no-todo-schema, (中文(简体) ), prefer-kit, (中文(简体) ), require-describe 财务报告和审定财务报表 no-plain-error-refusal警告他们。 警告不会失败升级; 一旦应用程序没有 报告从一个,它可以设置规则到 "error" 在它自己的配置中 (单位:千美元)"quickdraw/require-describe": "error",说)所以新代码不能添加任何. oxlint.template.jsonc 扩展基数并添加后三个基数.

哪些文件是规则检查

一个只检查该层文件的规则。 默认跟随 模板的布局。 这些规则涉及服务、工作和路线, no-raw-socket, (中文(简体) ), prefer-kit 财务报告和审定财务报表 require-describe 跳过测试( e)__tests__/, (中文(简体) ), test/, (中文(简体) ), tests/, (中文(简体) ), *.test.*, (中文(简体) ), *.spec.*哪些种子、检查和探测;其他规则检查 测试也.

客户端代码也是任何导入的文件 @tanstack/react-query, (中文(简体) ), socket.io-client 或者说 @fitzzero/quickdraw-core/client,所以钩在 .ts 文件检查 oxlint 的出处、 应用程序根或 apps/web 相同; 对于客户端规则, globs 会在其中添加文件 .

每个文件范围的规则 files 财务报告和审定财务报表 ignore 光滑,与 相对于牛林运行地点的路径( 保留它们) **/- 前缀 :

{
  "rules": {
    "quickdraw/no-unbounded-read": ["error", { "files": ["**/server/services/**"] }],
  },
}

其他选项: clients (数据库客户端的名称为: ["db", "tx"] 写作规则,加 prisma 关于规则 查看数据库的电话; modules (未跟踪客户端的说明符) 模块) no-untracked-write· ; emitters 打开 no-manual-emit· ; sockets, (中文(简体) ), allowedEvents 财务报告和审定财务报表 allowedPrefixes 打开 no-raw-socket· ; clients (类型) 客户姓名, ["qd"]继续 no-untyped-client 财务报告和审定财务报表 no-manual-refetch· ; minWords (静态描述中最少的字,默认为3) require-describe· ; shared 财务报告和审定财务报表 allow (单位:千美元){ "<service>": ["<service>/<file>"] }继续 no-cross-service-internal-imports每一个规则的选项都在它的计划, 所以一个拼错的选项在启动时会失败克林特.

写作规则( :no-untracked-write, (中文(简体) ), no-nested-write, (中文(简体) ), no-foreign-write(中文(简体) ) 也取一个客户端的快取 Tracked<...> 或者说 TrackedTransaction<...> 担任跟踪客户,无论其名称为何:a 参数或变量,一个其模式类型给予它的已解结构绑定 1( 类型字词, 或此文件的接口或类型别名 : { db }: { db: Tracked<Db> }),或 this.<member> 其类别宣布为(财产,或 构造器的参数属性). 类型在文件导入时计数 从 @fitzzero/quickdraw-core 或者说 @fitzzero/quickdraw-core/prisma下页 任何名称或通过命名空间导入,或通过此文件的别名类型 说吧 应用程序的一类名称 Tracked,或从 另一个模块(包含再导出)不读:规则查看一个文件, 而只有速战速决的型态 将客户端控制在履带式的.

基线

应用程序采用基础配置而不修正所有已有的违规情况 首先,快活的规则 和克林特自己的:

bunx quickdraw-lint baseline -c .oxlintrc.json   # writes .quickdraw-lint-baseline.json

// .oxlintrc.json: every rule reads the file
{
  "settings": { "quickdraw": { "baseline": ".quickdraw-lint-baseline.json" } },
}

// package.json: lint through quickdraw-lint check (per package: -c ../../.oxlintrc.json src)
{ "scripts": { "lint": "quickdraw-lint check -c .oxlintrc.json ." } }

quickdraw-lint baseline 使用您的配置运行牛林( r)-c 选择一个; 选项后的路径,默认情况下当前目录)并记录 a 规则、档案和散列 的线条的修剪文本。 然后,只有当 其指纹没有被记录,或者发生频率超过记录。 这么说吧 修复旧的违规情况,并在同一份文件中增加一个新的违规情况 新一条,在其行上,同时编辑文件的其他地方(移动行) 没有改变它们) 扰动什么。 禁用注释的违反 封面没有记录,也没有使用备忘,文件牛林无法解析 永远不会被记录:没有基线存在语法错误。 提交文件 .

快速画规则应用文件本身,所以简单 oxlint 运行( a) 编辑部也把记录的违纪事件排除在外。 牛林自己的规矩 (单位:千美元)no-unused-vars, (中文(简体) ), no-shadow,.)在本地运行,其中JS插件无法运行 联系他们: quickdraw-lint check 运行克林特 并留下他们的记录 也违反,所以它是一个应用程序的指针。 每一次都会传来 选项它不知道 (-c, (中文(简体) ), --fix,路径)到牛林,打印什么是 左为 file:line:column: message [Severity/rule] (单位:千美元)--format json 页:1 牛林的JSON报告,过滤,取 --quiet, (中文(简体) ), --deny-warnings 财务报告和审定财务报表 --max-warnings <n> 和 oxlint 一样,当错误发生时退出 1 .

记录的违规情况一旦确定,其津贴即予使用 no-unused-baseline 在文件的顶端警告( i)quickdraw-lint check 以同样方式报告牛林本身的规则未使用的津贴 基线命令再次生效,使文件缩水,没有新的信息可以带走 津贴地点。 一个规则将文件作为选项,而不是 设置 : ["error", { "baseline": ".quickdraw-lint-baseline.json" }]A级 相对路径从每个已挂起的文件目录向上查找, 所以一个 寄存器根的文件还服务从软件包启动的 lint 运行 目录. 快速规则按着它的名字 任何其他规则按着它 代码为:

{
  "version": 2,
  "files": {
    "apps/api/src/services/task.ts": {
      "eslint(no-unused-vars)": { "9a0364b9e99bb480": 1 },
      "no-unbounded-read": { "5d41402abc4b2a76": 1, "7d793037a0760186": 2 }
    }
  }
}

1版本文件(每个文件的计数,从早先的 5.0 预释)是 拒绝留言,说要再次写给指挥部.

从4.1规则

4.1规则在5.0之前不变地移到这里;5.0代替. A 类 仍然为已删除规则命名的配置无法装入, 因此删除这些名称 从您的覆盖 :

发展中国家

bun run --filter @fitzzero/quickdraw-lint test 运行每个规则的案件 由牛林自己负责 RuleTester (单位:千美元)oxlint/plugins-dev:克林特的剖析器和 插件运行时间, in vitest),以及 plugin/test/oxlint.test.mjs 运行牛林 带有已运出配置的 CLI : 每条规则必须在此报告其实例( 使用 模板配置, 核心软件包的固定程序必须通过 判断服务定义的规则和基线命令 圆通相去. plugin/test/check.test.mjs 运行配置路径覆盖 从应用程序根和软件包目录中,以及 quickdraw-lint check。 。 。 . 该插件的 .mjs 文档和 bin/ 船是怎样的,没有建筑.