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 | 确保不使用已贬值的短手函数 | ❌ |