# @griffel/eslint-plugin 中文文档

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

版本：3\.0\.2
npm 元数据更新时间：2026-07-29T21:17:11.527Z
中文译文更新时间：2026-11-17T00:43:57.145Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：54.3 kB，39 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：eslint ^9\.0\.0 \|\| ^10\.0\.0
- 首次发布：2022-05-04T16:15:16.990Z
- 最新版本发布：2026-05-21T09:29:03.032Z
- 近 30 天下载量：15081（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 4 个）

## 中文简介

带有 Griffel 规则的 ESLint 插件

## 安装

```sh
npm install @griffel/eslint-plugin
```

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

## README

# Griffel 的 ESLint 插件

使用 Griffel 编写样式时遵循最佳做法和预测常见错误的 ESLint 插件

## 安装

```bash
yarn add --dev @griffel/eslint-plugin
# or
npm install --save-dev @griffel/eslint-plugin
```

## 使用量

> **说明:** 此插件需要 ESLint 9+ 和平面配置 ()`eslint.config.mjs`) (中文(简体) ).

使用您的推荐配置 `eslint.config.mjs`数字 :

```js
import griffelPlugin from '@griffel/eslint-plugin';

export default [
  {
    files: ['**/*.ts', '**/*.tsx'],
    ...griffelPlugin.configs.recommended,
  },
];
```

## 可共享配置

此插件导出执行良好做法的推荐配置, 但是您可以选择只使用您使用时所需的配置 :

```js
import griffelPlugin from '@griffel/eslint-plugin';

export default [
  {
    files: ['**/*.ts', '**/*.tsx'],
    plugins: {
      '@griffel': griffelPlugin,
    },
    rules: {
      '@griffel/hook-naming': 'error',
      '@griffel/no-shorthands': 'error',
      '@griffel/pseudo-element-naming': 'error',
    },
  },
];
```

您可以在 [支持的规则部分](https://npmcn.com/package/%40griffel/eslint-plugin/#readme-supported-rules) 见下文.

## 支持的规则

**密钥**: 🔧=可修复

| 名称 | 说明 | 🔧 |
| --- | --- | --- |
| [`@griffel/hook-naming`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/hook-naming.md) | 确保钩子由 `makeStyles()` 函数从“ 使用” 开头 | ❌ |
| [`@griffel/no-invalid-shorthand-arguments`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/no-invalid-shorthand-arguments.md) | 所有快手都不得使用空格分隔符,而是通过多个参数 | ✅ |
| [`@griffel/no-shorthands`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/no-shorthands.md) | 强制使用CSS长手 | ✅ |
| [`@griffel/styles-file`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/styles-file.md) | 确保所有 `makeStyles()` 财务报告和审定财务报表 `makeResetStyles()` 电话放在一个 `.styles.js` 或者说 `.styles.ts` 文件 | ❌ |
| [`@griffel/pseudo-element-naming`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/pseudo-element-naming.md) | 确保所有 Pseudo 元素从两个分号开始 | ✅ |
| [`@griffel/top-level-styles`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/top-level-styles.md) | 确保所有 `makeStyles()`, (中文(简体) ), `makeResetStyles()` 财务报告和审定财务报表 `makeStaticStyles()` 调用被写入文件的顶层,以阻止开发者滥用. | ❌ |
| [`@griffel/no-deprecated-shorthands`](https://npmcn.com/package/%40griffel/eslint-plugin/src/rules/no-deprecated-shorthands.md) | 确保不使用已贬值的短手函数 | ❌ |

## 常见问题

### @griffel/eslint-plugin 是什么？

带有 Griffel 规则的 ESLint 插件

### 如何安装 @griffel/eslint-plugin？

在项目目录运行 npm install @griffel/eslint-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^9\.0\.0 \|\| ^10\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @griffel/eslint-plugin 支持 TypeScript 吗？

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

### @griffel/eslint-plugin 支持 ESM 还是 CommonJS？

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

### @griffel/eslint-plugin 可以商用吗？

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

### @griffel/eslint-plugin 的下载量有多少？

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

### @griffel/eslint-plugin 还在维护吗？

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

