@griffel/eslint-plugin

中文文档
3.0.2发布于 2026/05/21MITTypeScriptES Module近 30 天下载 1.5万

带有 Griffel 规则的 ESLint 插件

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 可共享配置
  4. 支持的规则

Griffel 的 ESLint 插件

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

安装

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

使用量

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

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

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

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

可共享配置

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

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',
    },
  },
];

您可以在 支持的规则部分 见下文.

支持的规则

密钥: 🔧=可修复

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

版本与发布记录

@griffel/eslint-plugin 共发布 20 个版本,首次发布于 2022/05/05;过去 12 个月发布了 4 个版本。

版本发布日期距今
3.0.2latest2026/05/215 个月前
3.0.12026/05/215 个月前
3.0.02026/04/296 个月前
2.0.22026/03/068 个月前
2.0.12025/07/281.3 年前
2.0.02024/11/132 年前

关于 @griffel/eslint-plugin 的常见问题

@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 和提交记录判断。