# @aurelienbbn/oxlint-plugin-drizzle 中文文档

规范地址：https://npmcn.com/package/%40aurelienbbn/oxlint-plugin-drizzle/

版本：0\.1\.2
npm 元数据更新时间：2026-10-14T14:33:37.890Z
中文译文更新时间：2026-11-07T05:29:01.221Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aurelienbbn/oxlint-plugin-drizzle
原文对照：https://npmcn.com/package/%40aurelienbbn/oxlint-plugin-drizzle/?lang=original
项目主页：https://github.com/aurelienbobenrieth/harness/tree/main/packages/oxlint-plugin-drizzle#readme
源码仓库：https://github.com/aurelienbobenrieth/harness

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：46 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.19\.0 \|\| ^24\.11\.0
- 运行依赖：1 个
- peer 依赖：oxlint \>=1\.82\.0 \<2\.0\.0
- 首次发布：2026-09-25T10:27:34.561Z
- 最新版本发布：2026-10-14T14:33:37.543Z
- 近 30 天下载量：2423（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

Drizzle ORM schemas的自定义克林特规则.

## 安装

```sh
npm install @aurelienbbn/oxlint-plugin-drizzle
```

也可以使用：`pnpm add @aurelienbbn/oxlint-plugin-drizzle`、`yarn add @aurelienbbn/oxlint-plugin-drizzle`、`bun add @aurelienbbn/oxlint-plugin-drizzle`

## README

# @aurelienbn/克林特-插管-细雨

[![npm](https://img.shields.io/npm/v/@aurelienbbn/oxlint-plugin-drizzle)](https://www.npmjs.com/package/@aurelienbbn/oxlint-plugin-drizzle) [![downloads](https://img.shields.io/npm/dm/@aurelienbbn/oxlint-plugin-drizzle)](https://www.npmjs.com/package/@aurelienbbn/oxlint-plugin-drizzle) [![CI](https://github.com/aurelienbobenrieth/harness/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/aurelienbobenrieth/harness/actions/workflows/ci.yml) [![license](https://img.shields.io/npm/l/@aurelienbbn/oxlint-plugin-drizzle)](https://github.com/aurelienbobenrieth/harness/blob/main/packages/oxlint-plugin-drizzle/LICENSE) [![node](https://img.shields.io/node/v/@aurelienbbn/oxlint-plugin-drizzle)](https://github.com/aurelienbobenrieth/harness/blob/main/packages/oxlint-plugin-drizzle/package.json)

**1克克林特规则 Drizzle Postgres schemas:每个外键列会引导一个索引,在生产流量找到相继扫描之前.**

> \[注\] **释放候选人.** 还没有消费者校正过.

```sh
pnpm add -D @aurelienbbn/oxlint-plugin-drizzle oxlint   # oxlint >=1.82.0 <2.0.0
```

```json
{
  "jsPlugins": ["@aurelienbbn/oxlint-plugin-drizzle"],
  "rules": {
    "drizzle/fk-column-indexed": "error"
  }
}
```

没有预设,没有自定义:索引形状(单,复合,部分)是一种设计选择.

## 什么火吗

```ts
export const posts = pgTable("posts", {
  authorId: integer().references(() => users.id), // ❌ fk-column-indexed
});

export const indexedPosts = pgTable(
  "indexed_posts",
  { authorId: integer().references(() => users.id) },
  (t) => [index().on(t.authorId)], // ✅
);
```

**只有邮递员.** MySQL InnoDB 为每个外国密钥创建索引, 当不存在时, 所以 `mysqlTable` 这是超出范围。 也没有 `drizzle-kit` (0.31.11, 1.0.0-rc.4) 或 `eslint-plugin-drizzle` (0.2.3) 检查这个.

精确触发和范围

| \* 开火 | 由 / QQ 跳过 |
| --- | --- |
| (单位:千美元) `.references(...)` 栏,或 `foreignKey({ columns })`,没有覆盖构建器开始 | `index` 编号 : `uniqueIndex` 编号 : `unique` `.on(t.col, ...)` 或者说 `.using(method, t.col, ...)`, (中文(简体) ), `primaryKey({ columns: [t.col, ...] })`栏级 `.primaryKey()` 编号 : `.unique()`表格 `pgTable` 或者说 `pgSchema(...).table` 进口自 `drizzle-orm/pg-core`; 对象或回调列; 数组或 0.x 对象外置配置. qq 额外配置不是内线箭头返回字元, 或包含扩展 |

## 登记的合同库存

从软件包导出 `pnpm catalog`. 规则特定选项和限制在上文和源测试中都有描述.

| 规则/检查 | 触发或审查范围 |
| --- | --- |
| `fk-column-indexed` | 要求 Drizzle pgTable (. references () 或 外键 ()) 的每个外键列成为索引的第一列, 唯一的制约, 或主键 . |

### 信用概念

-   [https://www.postgresql.org/docs/current/ddl-constructints.html 页面存档备份,存于互联网档案馆](https://www.postgresql.org/docs/current/ddl-constraints.html) (激励;独立执行)
-   行星尺度/数据库技能/后架/参考/设计(MIT,概念)

## 常见问题

### @aurelienbbn/oxlint-plugin-drizzle 是什么？

Drizzle ORM schemas的自定义克林特规则\.

### 如何安装 @aurelienbbn/oxlint-plugin-drizzle？

在项目目录运行 npm install @aurelienbbn/oxlint-plugin-drizzle，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：oxlint（\>=1\.82\.0 \<2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aurelienbbn/oxlint-plugin-drizzle 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aurelienbbn/oxlint-plugin-drizzle 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aurelienbbn/oxlint-plugin-drizzle 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.19\.0 \|\| ^24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aurelienbbn/oxlint-plugin-drizzle 可以商用吗？

@aurelienbbn/oxlint-plugin-drizzle 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aurelienbbn/oxlint-plugin-drizzle 的下载量有多少？

根据 npm 官方下载统计，@aurelienbbn/oxlint-plugin-drizzle 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,423 次，日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aurelienbbn/oxlint-plugin-drizzle 还在维护吗？

最新版本 0\.1\.2 发布于 2026/10/14（24 天前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/09/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。