@grafana/eslint-config

中文文档
10.0.0发布于 2026/06/11Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 29.2万

Grafana's ESLint config

原始使用文档
文档目录3 节
  1. Installation
  2. Configuration (new: eslint.config.js)
  3. Configuration (legacy: .eslintrc*)

grafana-eslint-config

Grafana's ESLint config.

Installation

yarn add @grafana/eslint-config --dev

or:

npm install @grafana/eslint-config --save-dev

Don't forget to install peerDependencies.

  1. Install the correct versions of each package, which are listed by the command:
npm info "@grafana/eslint-config@latest" peerDependencies

If using npm 5+, use this command:

npx install-peerdeps --dev @grafana/eslint-config

If using a different package manager, run npm info "@grafana/eslint-config@latest" peerDependencies to list the peer dependencies and versions. Then run yarn add --dev <dependency1>@<version> <dependency2>@<version> <dependency3>@<version> for the listed peer dependencies.

Configuration (new: eslint.config.js)

From v8.21.0, Eslint introduced a new flat config system where eslint.config.js replaces .eslintrc* as the default config file name. [email protected] supports both systems, while [email protected] only supports the new flat config.

A guide on how to migrate to a flat config can be found here.

The following official blog posts are available for interested parties:

This package contains a single flat config object which can be imported like so:

const grafanaConfig = require("@grafana/eslint-config/flat");

/**
 * @type {Array<import('eslint').Linter.Config>}
 */
module.exports = [
  ...grafanaConfig,
  … /* rest of your config */
];

You are then free to add/override properties.

Note: Our shareable configs does not preconfigure files, ignore, or languageOptions.globals. For most of the cases, you probably want to configure some properties for your project.

const grafanaConfig = require("@grafana/eslint-config/flat");

/**
 * @type {Array<import('eslint').Linter.Config>}
 */
module.exports = [
  {
    ignores: [".github", ".yarn", "**/build/", "**/compiled/", "**/dist/"],
  },
  ...grafanaConfig,
  {
    name: "myproject/defaults",
    files: ["**/*.{ts,tsx,js,jsx}"],
    rules: {
      // add custom rules here.
    },
  },
];

Configuration (legacy: .eslintrc*)

Extend our configuration to get reasonable defaults:

{
  "extends": ["@grafana/eslint-config"]
}

It will automatically handle *.(js|ts|tsx) files.

版本与发布记录

@grafana/eslint-config 共发布 30 个版本,首次发布于 2020/02/01;过去 12 个月发布了 1 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
10.0.0latest2026/06/115 个月前
9.0.02025/10/271.1 年前
8.2.02025/08/211.2 年前
8.1.02025/06/141.4 年前
8.0.02024/10/172 年前
7.0.02024/01/102 年前

其他发布通道:canary → 3.0.0-alpha。

关于 @grafana/eslint-config 的常见问题

@grafana/eslint-config 是什么?

Grafana's ESLint config

如何安装 @grafana/eslint-config?

在项目目录运行 npm install @grafana/eslint-config,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:eslint(>=8.57.0)、typescript(>=5.5.0)、eslint-plugin-jsdoc(>=50.4.0)、eslint-plugin-react(>=7.37.0)、eslint-config-prettier(>=9.1.0)、@stylistic/eslint-plugin(>=5.0.0)、@typescript-eslint/parser(>=8.9.0)、eslint-plugin-react-hooks(>=7.1.0)、@typescript-eslint/eslint-plugin(>=8.9.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grafana/eslint-config 支持 TypeScript 吗?

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

@grafana/eslint-config 支持 ESM 还是 CommonJS?

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

@grafana/eslint-config 可以商用吗?

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

@grafana/eslint-config 的下载量有多少?

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

@grafana/eslint-config 还在维护吗?

最新版本 10.0.0 发布于 2026/06/11(5 个月前);至今共发布 30 个版本,其中过去 12 个月发布了 1 个;首次发布于 2020/02/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。