# @headlamp-k8s/eslint-config 中文文档

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

版本：0\.7\.0
npm 元数据更新时间：2024-11-11T19:52:26.669Z
中文译文更新时间：2026-11-17T18:16:49.903Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40headlamp-k8s/eslint-config
原文对照：https://npmcn.com/package/%40headlamp-k8s/eslint-config/?lang=original
项目主页：https://github.com/headlamp-k8s/headlamp/eslint-config/README.md
源码仓库：https://github.com/headlamp-k8s/headlamp

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

- 包体积（解压后）：17.8 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- peer 依赖：eslint ^8\.57\.1，eslint-plugin-react 7\.37\.2，eslint-plugin-import ^2\.31\.0，eslint-config-prettier ^9\.1\.0，eslint-plugin-jsx-a11y ^6\.10\.2，eslint-plugin-react-hooks ^5\.0\.0，eslint-plugin-unused-imports ^4\.1\.4，@typescript-eslint/eslint-plugin ^8\.13\.0，eslint-plugin-simple-import-sort ^12\.1\.1
- 首次发布：2024-08-28T13:26:33.322Z
- 最新版本发布：2024-11-07T20:19:46.275Z
- 近 30 天下载量：55123（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

Headlamp TypeScript 项目的林特规则

## 安装

```sh
npm install @headlamp-k8s/eslint-config
```

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

## README

# 林特配置

这是一个共享的 ESLint/ prettier/ TS 配置, 我们在 Headlamp 内部使用 我们的 Javascript/ Typescript 工程.

## 安装

使用下列命令安装国家预防机制的配置:

`npm install --save-dev @headlamp-k8s/eslint-config`

也安装建议建立的国家防范机制(如果没有安装的话) 页:1.

你可以把它包含在你的 `package.json` 类似下面的文件 :

```js
  "eslintConfig": {
    "extends": ["@headlamp-k8s", "prettier", "prettier/react"]
  },
  "prettier": "@headlamp-k8s/eslint-config/prettier-config",
```

## 发展

埃斯林特规则应在 `.eslintrc.yml` 此 repo 中的文件 .

### 生成索引.js

这个 `index.js` 文件来自 `.eslintrc.yml`,并可以使用:

`make`

## 许可证

lint-config在Apache 2.0下获得许可.

## 常见问题

### @headlamp-k8s/eslint-config 是什么？

Headlamp TypeScript 项目的林特规则

### 如何安装 @headlamp-k8s/eslint-config？

在项目目录运行 npm install @headlamp-k8s/eslint-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^8\.57\.1）、eslint-plugin-react（7\.37\.2）、eslint-plugin-import（^2\.31\.0）、eslint-config-prettier（^9\.1\.0）、eslint-plugin-jsx-a11y（^6\.10\.2）、eslint-plugin-react-hooks（^5\.0\.0）、eslint-plugin-unused-imports（^4\.1\.4）、@typescript-eslint/eslint-plugin（^8\.13\.0）、eslint-plugin-simple-import-sort（^12\.1\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @headlamp-k8s/eslint-config 支持 TypeScript 吗？

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

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

@headlamp-k8s/eslint-config 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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

