Lint Config
This is a shareable ESLint/Prettier/TS config we use inside Headlamp for
our Javascript/Typescript projects.
Installation
Install the config from NPM by using the following command:
npm install --save-dev @headlamp-k8s/eslint-config
Install also the peer dependencies NPM suggested (if they're not installed
automatically).
You can include it in your package.json file like the following:
"eslintConfig": {
"extends": ["@headlamp-k8s", "prettier", "prettier/react"]
},
"prettier": "@headlamp-k8s/eslint-config/prettier-config",
Development
Eslint rules should be modified in the .eslintrc.yml file in this repo.
Generate index.js
The index.js file is generated from .eslintrc.yml, and can be generated using:
make
License
lint-config is licensed under Apache 2.0.
关于 @headlamp-k8s/eslint-config 的常见问题
@headlamp-k8s/eslint-config 是什么?
Lint rules for Headlamp TypeScript projects
如何安装 @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 和提交记录判断。