# @charcuterie/eslint-config 中文文档 规范地址：https://npmcn.com/package/%40charcuterie/eslint-config/ 版本：1\.7\.1 npm 元数据更新时间：2026-09-03T20:59:01.552Z 中文译文更新时间：2026-11-09T15:49:12.356Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40charcuterie/eslint-config 原文对照：https://npmcn.com/package/%40charcuterie/eslint-config/?lang=original 项目主页：https://github.com/Sawtaytoes/charcuterie#readme 源码仓库：https://github.com/Sawtaytoes/charcuterie ## 关键信息（来自 npm 元数据） - 包体积（解压后）：128 kB，29 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - 运行依赖：3 个 - peer 依赖：eslint \>=10 - 首次发布：2026-07-31T04:31:05.613Z - 最新版本发布：2026-09-03T20:59:01.206Z - 近 30 天下载量：2326（2026-10-10 至 2026-11-08，npm 官方下载统计） - 已发布版本数：10（近 12 个月 10 个） ## 中文简介 房屋ESLint规则 Biome不能表达:有类型意识的命名,标识长度,以及仅逻辑属性. ## 安装 ```sh npm install @charcuterie/eslint-config ``` 也可以使用：`pnpm add @charcuterie/eslint-config`、`yarn add @charcuterie/eslint-config`、`bun add @charcuterie/eslint-config` ## README # `@charcuterie/eslint-config` Biome负责格式化和大部分的林克. 这个包只持有什么 生物体 **无法** 表达式:需要类型脚本类型的信息的规则,以及一个自定义 AST查询. 从 `mux-magic/eslint.config.js`,每个公约的参考应用 在此 repo 中, apps 消耗一个导入, 而不是六个复制的配置文件 . ## 安装 ```sh yarn add --dev @charcuterie/eslint-config eslint ``` 两个包裹,和 `eslint` 只是因为CLI属于 消费者. `typescript-eslint`, (中文(简体) ), `eslint-plugin-react` 财务报告和审定财务报表 `@vitest/eslint-plugin` 为: 这个软件包本身的依赖性——一个共享的配置,其领养指令开始 "先安装这四个插件"的分享不多. **如果你的配置成像的话 `tseslint.configs.*` 从这里导入 :** ```js import { createAppConfig, tseslint, } from "@charcuterie/eslint-config" ``` 不是从你自己 `typescript-eslint`平面配置抛出 `Cannot redefine plugin "@typescript-eslint"` 当两个块注册命名空间时 有两个不同的对象, 和第二个副本 `typescript-eslint` 在树上 没错. `board-game-picker` 将预设套装在锁上 而这个包 解决了8.67.0 旁边 `eslint .` 彻底失败; `docket`, (中文(简体) ), 使用相同的申报范围,去除并工作。 哪个回扣是财产 它的锁文件, 而非它的配置—— 因此实例被再出口, 有一个导入 其分明者. ## 使用量 ```js // eslint.config.js — the whole file, in an app repo import { createAppConfig } from "@charcuterie/eslint-config" import { defineConfig } from "eslint/config" export default defineConfig( ...createAppConfig({ tsconfigRootDir: import.meta.dirname, }), ) ``` `createAppConfig` 是应用程序的默认答案。 由下面的工厂组成 按照正确的顺序, 缩小范围 `@charcuterie/ui`房子已经忽略了列表 已经就位。 如果不是,请写出来源所在 `src`数字 : ```js createAppConfig({ tsconfigRootDir: import.meta.dirname, appDirectories: ["packages/web"], // Repo-specific paths are *added* to `APP_IGNORES`, not // swapped for it. ignores: ["e2e/**"], }) ``` | 选项 | 默认 | 它会做什么 | | --- | --- | --- | | `tsconfigRootDir` | **所需经费** | 应用程序在哪里 `tsconfig.json` 活着. `projectService` 没有诚实的违约 别人的回扣. | | `appDirectories` | `["src"]` | 应用程序的自有来源. 这是使组件规则远离图书馆的范围. | | `ignores` | `[]` | 附录 `APP_IGNORES`。 。 。 . | | `componentChoice` | `"pickers"` | `"all"` 所有7个规则,一旦应用程序 扫过它的生锚和按钮; `"off"` 中期移民. | | `flexOverflow` | `"off"` | `"warn"` 或者说 `"error"` 以启动弹性家庭. | | `reactVersion` | `"19.0.0"` | | | `storyFiles` | `MULTI_COMPONENT_FILE_GLOBS` | 可声明多个组件的文件. | `react/no-multi-comp` 说些故事, `__fixtures__`, (中文(简体) ), **`*.test.tsx`图标 模块** (单位:千美元)`icons.tsx`, (中文(简体) ), `*Icons.tsx`) (中文(简体) ). 上两个发现 真正的应用程序运行的那一刻 预设, 并且是同样的论点 故事豁免已经做了—— 文件的工作是 保持一组。 需要包装器的组件测试 宣告了旁边的绳子 charcuterie没有故意的图标, 所以每个应用程序都有一个格言文件: 19岁 `mail-sifter/components/icons.tsx`十九个单行文件更糟糕, 没有人会写,规则就会被关闭. **为什么预设会存在**,因为下面的每个工厂都已经 `files`:因为8个应用程序各自由手组成,到2026-08-21 6 已经漂流。 四个手工注册的插件对象和两个拾取规则 名称——同一段的四份解释为何不打电话 `createComponentChoiceRules` 旁边是 两个人根本没接过电线 分舰队的一条机器强制采摘规则 在分舰队的一半被执行。 规则 图书馆的船,但每个消费者必须重新思考 是规则舰队不 已经. `componentChoice: "pickers"` 是默认,因为它是一个组件选择 家庭有长期决定,没有剩余积压: `Select` 实值 堕落, `Picker` 和每个拥有的应用程序被扫描到 `Listbox` 打开 2026-08-21. (中文(简体) ). 其他五个规则每个名字 一个扫描一个应用还没有完成 `no-raw-button` 单枪匹马地向舰队的每一个图标行开火 整个回波红色是一个被返回而不是迁移的配置. `flexOverflow` 默认为 `"off"` 出于同样的原因,向前再走一步: `no-shrink-0-with-flex-wrap` 是一个 `error`,所以捆绑它会 使"通过 预设 ” 和“ 擦去弹性错误” 相同的更改. ### 手工制作 使用预设的应用程序无法描述是否仍然直接调用工厂 因此没有第二个执行程序可以保留 步骤. `mux-magic` 这样做,因为它 层自己 `no-restricted-syntax` 选中的逻辑属性 . ```js // eslint.config.js import { createComponentChoiceRules, createFlexOverflowRules, createLogicalPropertiesRules, createPickerRules, createReactRules, createStoryOverrides, createTestRules, createTypedRules, } from "@charcuterie/eslint-config" import { defineConfig } from "eslint/config" export default defineConfig( { ignores: ["**/dist/**", "**/node_modules/**"] }, createTypedRules({ tsconfigRootDir: import.meta.dirname, }), createReactRules({ files: ["packages/ui/**/*.tsx"] }), createLogicalPropertiesRules({ files: ["packages/ui/**/*.tsx"], }), // The settled subset — `no-raw-select`, // `prefer-listbox-over-select`, and the suppression guard. createPickerRules({ files: ["packages/web/**/*.tsx"], }), // All seven. Opt-in, and pointed at app source rather than the // library. createComponentChoiceRules({ files: ["packages/web/**/*.tsx"], }), // Also opt-in. Warns by default; `severity: "error"` once the // app has been swept. createFlexOverflowRules({ files: ["packages/web/**/*.tsx"], }), createStoryOverrides({}), createTestRules({}), ) ``` 每个导出都是 **工厂 `files`** 而不是固定的配置数组。 A 类 共享硬码配置 `packages/web/**` 是个迷幻的装扮 共享名称; 消费者知道自己的布局, 而本套件没有. `createAppConfig` 不打破它,它从 `appDirectories` 而不是假设他们. `createTypedRules` 需求 `tsconfigRootDir` 因为它打开 `projectService` —— 说 没有诚实的默认 别人的tsconfig生活的地方. ## 规则 | 规则 | 它为什么在这里而不是在Biome | | --- | --- | | `@typescript-eslint/naming-convention` (是/有布尔斯) | 键关 `types: ["boolean"]`,需要类型检查器 | | `id-length` (单位2, `_` 财务报告和审定财务报表 `$` 豁免) | Biome没有等同物 | | `react/no-multi-comp` | 每个文件一个组件;故事关闭 `__fixtures__` | | `vitest/consistent-test-it` (单位:千美元)`test`没有 `it`(中文(简体) ) | 自动固定,这是唯一的原因 这个化妆品赚到一个插槽 | | `no-restricted-syntax` (仅逻辑属性) | **新来** - 见下文 | | `charcuterie/*` (构成部分选择) | **选入**,但拾取子集——见下文 | | `charcuterie/*` (弹性溢出) | **这里新建, 并选入** - 见下文 | 所有的东西 `charcuterie/*` 规矩在 **一个名称空间下的插件对象**页:1 内 `src/plugin.js`平面配置抛出 `Cannot redefine plugin` 当两个块注册时 一个带有两个不同对象的命名空间,下面两个块将启用 独立——所以两个工厂都给ESLint提供了同样的参考. 第二个命名空间 (单位:千美元)`charcuterie-layout`这是另一种选择,但被拒绝:你们必定要记住 每个规则在写禁用注释时所用的前缀,以及错误的前缀 `eslint-disable` 沉默无声. ## 仅逻辑属性 这舰队的每一个空间价值都是逻辑消耗的—— `ps-`编号 :`pe-`, (中文(简体) ), `ms-`编号 :`me-`, (中文(简体) ), `start-`编号 :`end-`, (中文(简体) ), `border-s`编号 :`border-e`, (中文(简体) ), `text-start`编号 :`text-end`。它没有代价 今天,并让RTL 几乎在以后自由, 这就是为什么它是一个灵通规则而不是一个 偏好:偏好持续到第一人匆忙. **范围故意狭窄** —— 说 `className` 字符串字节和模板块 只有这个 有形财产 _名称_ 样式对象( e)`left`, (中文(简体) ), `paddingRight`(没有) 匹配,因为 `left` 财务报告和审定财务报表 `right` 太多的合法身份识别器 地点 : `getBoundingClientRect().left`,浮动 UI 设置,渐变停止。 A 类 规则是哭狼被关闭, 而关闭规则执行 没什么 相同的推理使对比门 范围控制边界 而不是屏幕上的每行. 模式的锚是负载的,和 `__fixtures__/logicalDirectionClassName.tsx` 以证明: `border-red-500` 包含 `border-r`, (中文(简体) ), `rounded-lg` 包含 `rounded-l`, (中文(简体) ), `place-items-center` 开始于 `pl`这三个人必须保持干净. ## 构成部分选择——选入 2026-08-10测得的六起重案组 继续通过图书馆 原始内容。 文件一直没有到位,没有移动这些文件 数字,这是一个提示规则的整个参数: 医生读一次,规则是 执行每个保存. | 规则 | 着火了 | 联系到 | 在舰队中测量 | | --- | --- | --- | --- | | `charcuterie/no-raw-anchor` | `` | `TextLink`,或 `ButtonLink` 当导航显示为按钮时 | 14个在mux-magic,10个在画廊倒装,31个在bambuddy | | `charcuterie/no-raw-button` | `