# @bitfactory/eslint-config 中文文档

规范地址：https://npmcn.com/package/%40bitfactory/eslint-config/

版本：14\.0\.3
npm 元数据更新时间：2026-09-07T18:21:22.104Z
中文译文更新时间：2026-11-08T04:31:30.934Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bitfactory/eslint-config
原文对照：https://npmcn.com/package/%40bitfactory/eslint-config/?lang=original
项目主页：https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory#readme
源码仓库：https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory

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

- 包体积（解压后）：162 kB，42 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：^22\.22\.2 \|\| ^24\.15\.0
- 运行依赖：0 个
- peer 依赖：eslint ^9\.38\.0 \|\| ^10\.0\.0，globals \>=16\.0\.0，@eslint/js ^9\.38\.0 \|\| ^10\.0\.0，typescript \>=4\.8\.4 \<6\.1\.0，tailwindcss ^3\.4\.0 \|\| ^4\.0\.0，eslint-plugin-vue \>=10\.8\.0，vue-eslint-parser \>=10\.3\.0，@nuxt/eslint-config \>=1\.15\.0 \<2\.0\.0，eslint-plugin-jsdoc \>=62\.7\.0 \<65\.0\.0，eslint-plugin-jsonc \>=3\.0\.0，eslint-plugin-unicorn \>=62\.0\.0 \<66\.0\.0，eslint-plugin-import-x ^4\.17\.0，@stylistic/eslint-plugin \>=5\.9\.0，@typescript-eslint/parser \>=8\.58\.0，eslint-plugin-tailwindcss ^3\.18\.0 \|\| ^4\.0\.0，eslint-plugin-package-json \>=1\.3\.0，eslint-plugin-perfectionist \>=4\.15\.0，eslint-config-flat-gitignore \>=2\.2\.1 \<3\.0\.0，@typescript-eslint/eslint-plugin \>=8\.58\.0，eslint-plugin-vuejs-accessibility \>=2\.4\.2，eslint-plugin-sort-destructure-keys \>=3\.0\.0
- 首次发布：2020-04-17T09:03:52.723Z
- 最新版本发布：2026-09-07T16:03:45.107Z
- 近 30 天下载量：4745（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：128（近 12 个月 69 个）

## 中文简介

用于 NOBEARS (前位素 NL) 项目的 ESLint 可切换配置

## 安装

```sh
npm install @bitfactory/eslint-config
```

也可以使用：`pnpm add @bitfactory/eslint-config`、`yarn add @bitfactory/eslint-config`、`bun add @bitfactory/eslint-config`

## README

# @ bitfactory/ slint- config

[![Release](https://img.shields.io/badge/Release-14.x.x-ED4934)](https://www.npmjs.com/package/@bitfactory/eslint-config) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/) [![ESLint](https://img.shields.io/badge/ESLint-%5E9.38%20%7C%7C%20%5E10-4B3263?logo=eslint&logoColor=white)](https://eslint.org/) [![NodeJS](https://img.shields.io/badge/Node.js-%5E22.22.2%20%7C%7C%20%5E24.15.0-6da55f?logo=node.js)](https://nodejs.org/) [![NPM package version](https://badgen.net/npm/v/@bitfactory/eslint-config)](https://npmjs.com/package/@bitfactory/eslint-config)

ESLint v9+平面配置(ESM)的可共享ESLint配置. 所有规则和配置都是预先配置的. 规则可以根据需要被推翻.

> \[大 此软件包仅是平面配置( ESM) , 需要 ESLint `^9.38.0 || ^10.0.0`从老年阶段升级 少校吗? 开始于 [14.0.0 移徙指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/migration-v14.md), (中文(简体) ), 它按工程形状排列: 堆栈的入站点, 它忽略了它, 以及如何 分阶段采用规则修改。 这个 [安装指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/01-installation.md) 列出每个分页 依次为每个有一本的移民指南.

> \[尖叫声\] 这个配置拥有 `import-x` 命名空间, 因此如果您的项目注册了第二个, 运行可以中止 `eslint-plugin-import-x` 复制件,不会用这个来解析, 对于两个注册覆盖的文件。 见 [已知问题: `import` 插件命名空间相撞](https://unpkg.com/@bitfactory/eslint-config@14/docs/known-issue-import-namespace.md) 治疗方法.

> \[尖叫声\] 在ESLint 9上,针 `@eslint/js` 改为 `9.38.0` 或更新 `9.x`中选择 ESLint 区域 10 构建它自己的对等点排除 ESLint 9, 安装失败 。 见 [已知问题: `@eslint/js` 决定以ESLint 9为基础开发ESLint 10](https://unpkg.com/@bitfactory/eslint-config@14/docs/known-issue-eslint-js-peer.md) 用于一行补救.

-   [@ bitfactory/ slint- config](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-bitfactoryeslint-config)
    -   [快速启动](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-quick-start)
    -   [捐款](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-contributing)
    -   [安装](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-installation)
    -   [配置](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-configuration)
    -   [Vue 3 和 Nuxt 数据](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-vue-3-and-nuxt)
    -   [贾森](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-json)
    -   [尾风 CSS](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-tailwind-css)
    -   [CLI 使用量](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-cli-usage)
    -   [编辑器集成](https://npmcn.com/package/%40bitfactory/eslint-config/#readme-editor-integration)

## 快速启动

关于带有基本安装和配置的快速启动指南,见 [QUICKSTART.md (中文(简体) )](https://unpkg.com/@bitfactory/eslint-config@14/QUICKSTART.md)。 。 。 .

## 捐款

有关该项目贡献的信息,包括出版指南、本地开发设置和调试提示,参见: `CONTRIBUTING.md` 在仓库。 它没有发布到 npm.

## 安装

关于详细的安装指令,包括同级依赖和Vue/TypeScript设置,参见 [安装指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/01-installation.md)。 。 。 .

## 版本支持

主要线路 `latest` 点是支持的点,它上的每一个补丁都可以安装。 线条是 退休 - 整体贬值,从那时起没有后港 - 当其继任的主要出版时. 什麽 将这个主线带到上游通常是生命的终结:最古老的ESLint主线的对等范围 承认,或最古老的节点线 `engines.node` 宣布,不再支持;见 [ESLint 的版本支持](https://eslint.org/version-support) 编辑 [节点.js发布时间表](https://github.com/nodejs/release#release-schedule) 这些日期.

单个版本只有在存在缺陷时才会贬值,其信息名称为第一个版本 没有缺陷. `npm view @bitfactory/eslint-config@<version> deprecated` 显示任何版本的信息.

## 配置

关于配置实例(Vue, TypeScript)和高级配置选项(自定义插件, ECMAScript 版本覆盖),参见 [配置指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/02-configuration.md)。 。 。 .

## Vue 3 和 Nuxt 数据

选入 `/vue3` 财务报告和审定财务报表 `/nuxt` 入境点,包括使用秘方和同行要求,见 [Vue 3 和 Nuxt 指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/05-vue-and-nuxt.md)。 。 。 .

## 贾森

连接 JSON 文件的进入点, 以 `eslint-plugin-jsonc` 财务报告和审定财务报表 `eslint-plugin-package-json`。 是添加剂,但基建配置不能启用:

```bash
pnpm add -D eslint-plugin-jsonc eslint-plugin-package-json
```

```js
import bitfactory from '@bitfactory/eslint-config';
import json from '@bitfactory/eslint-config/json';

export default [
    ...bitfactory,
    ...json,
];
```

这个 `/json` 输入点 `.json`, (中文(简体) ), `.json5`,以及 `.jsonc` 文件、 排序密钥并强制设置双空格 缩进。 阵列值只排序于 `tsconfig*.json` 财务报告和审定财务报表 `jsconfig.json`,只有那里的数组 已经设定。 评论意见属于 `.jsonc` 财务报告和审定财务报表 `.json5` 语法,允许进入 `tsconfig*.json`, (中文(简体) ), `jsconfig.json`,以及 `.vscode/*.json` 还有.

`package.json` 顺序改为 `eslint-plugin-package-json`,所以一个仓库运行 `sort-package-json` 作为单独的一步,可以放弃它。 检查显示,无论哪一个字段 申报是好的, 而且没有两次宣布依赖性.

Markdown不是在这里被倒下。 使用 [马克倒挂](https://github.com/DavidAnson/markdownlint) 直接:它 包括约50个规则,其中17个是入口,其中9个是重复的 马克德林特已经.

### 已发布软件包

`/package-json` 实值 `/json` 加上要求公布的软件包实际宣布这些字段 归属( e)`author` 或者说 `contributors`, (中文(简体) ), `exports`, (中文(简体) ), `engines`, (中文(简体) ), `keywords`其余的 - 而那个没有 依赖决定了本地路径. 用它来代替 `/json` 项目向登记册公布时。 应用程序保存 `/json`,哪个 从不需要一个领域 它没有理由宣布.

```js
import bitfactory from '@bitfactory/eslint-config';
import packageJson from '@bitfactory/eslint-config/package-json';

export default [
    ...bitfactory,
    ...packageJson,
];
```

## 尾风 CSS

连接 Tailwind CSS 类使用的切入点 `eslint-plugin-tailwindcss`。它是添加剂,不能通过基础配置来实现,它支持两台 Tailwind majors。 两种出口都给解析器带来了它们光谱的需要,超出了ESLint的默认值,所以两者都导入 `@typescript-eslint/parser`,以及 `/tailwind-vue` 进口 `vue-eslint-parser`。安装匹配您 Tailwind major 的插件版本, 加上您工程还没有的任意解析器; 您的工程已有 `tailwindcss` 安装提供其余:

```bash
# Tailwind 4
pnpm add -D eslint-plugin-tailwindcss@4

# Tailwind 3
pnpm add -D eslint-plugin-tailwindcss@3
```

```js
import bitfactory from '@bitfactory/eslint-config';
import tailwind from '@bitfactory/eslint-config/tailwind';

export default [
    ...bitfactory,
    ...tailwind,
];
```

插件不提供它自己的解析器, 因此一个声称的切入点 `.vue` 必须带一个。 一个Vue项目 类名称以模板形式存在, 所以 `/tailwind-vue` 带同样的规则 `.vue` 用品 `vue-eslint-parser`数字 :

```js
import bitfactoryVue3 from '@bitfactory/eslint-config/vue3';
import tailwind from '@bitfactory/eslint-config/tailwind';
import tailwindVue from '@bitfactory/eslint-config/tailwind-vue';

export default [
    ...bitfactoryVue3,
    ...tailwind,
    ...tailwindVue,
];
```

插件需要您项目本身的 Tailwind 入口, 没有共享配置可以提供, 以及每个 major读取了不同的密钥。 插件 v4 取自样式表 `cssConfigPath`,默认为 `src/style.css`,并中止整个运行 `ENOENT` 当文件丢失时 :

```js
{
    settings: {
        tailwindcss: {
            cssConfigPath: 'resources/css/app.css',
        },
    },
},
```

插件 v3 没有 `cssConfigPath`它写着: `config`名称 `tailwind.config.js` 而不是一个 样式表,当它无法加载该文件时,它会回到Tailwind的默认主题而无需警告, 所以阶级名称被评为非您的主题.

两个切入点都允许 `tailwindcss/classnames-order` 时间 `warn`,而它是自动固定的,所以编辑器 在保存的集成指南中设置。 它只满足每个切入点的延伸要求 -- `.js`, (中文(简体) ), `.jsx`, (中文(简体) ), `.ts`, (中文(简体) ), `.tsx` 财务报告和审定财务报表 `.vue` - 所以一个前题插件仍然覆盖 `.mjs`, (中文(简体) ), `.cjs`, (中文(简体) ), `.mts` 财务报告和审定财务报表 `.cts`。 。 。 . 在删除其他插件前先设置上方的切入点 .

两者均没有应用自己的房屋规则集: 每一个都带有 Tailwind 插件对其命名的文件的规则, 每一个都分析那些文件 所以每个文件都单独运作 双方都需要上述的切入点。 切入点适应 以安装的插件为主(v3's) `flat/recommended` 数组或 v4's `recommended` conf.

## CLI 使用量

关于 CLI 使用指令和命令示例,参见 [CLI 使用指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/03-cli-usage.md)。 。 。 .

## 编辑器集成

关于编辑器集成指令(Visual Studio Code, PhpStorm),参见 [编辑器集成指南](https://unpkg.com/@bitfactory/eslint-config@14/docs/04-editor-integration.md)。 。 。 .

## 常见问题

### @bitfactory/eslint-config 是什么？

用于 NOBEARS \(前位素 NL\) 项目的 ESLint 可切换配置

### 如何安装 @bitfactory/eslint-config？

在项目目录运行 npm install @bitfactory/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^9\.38\.0 \|\| ^10\.0\.0）、globals（\>=16\.0\.0）、@eslint/js（^9\.38\.0 \|\| ^10\.0\.0）、eslint-plugin-jsdoc（\>=62\.7\.0 \<65\.0\.0）、eslint-plugin-unicorn（\>=62\.0\.0 \<66\.0\.0）、eslint-plugin-import-x（^4\.17\.0）、@stylistic/eslint-plugin（\>=5\.9\.0）、eslint-plugin-perfectionist（\>=4\.15\.0）、eslint-config-flat-gitignore（\>=2\.2\.1 \<3\.0\.0）、eslint-plugin-sort-destructure-keys（\>=3\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bitfactory/eslint-config 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bitfactory\_\_eslint-config 是否存在。

### @bitfactory/eslint-config 支持 ESM 还是 CommonJS？

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

### @bitfactory/eslint-config 需要什么版本的 Node\.js？

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

### @bitfactory/eslint-config 可以商用吗？

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

### @bitfactory/eslint-config 的下载量有多少？

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

### @bitfactory/eslint-config 还在维护吗？

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