@gem-sdk/eslint-plugin (英语)
共享所有 GemPages 前端寄存器的 ESLint 规则 .
合并自定义规则 web-builder-shopify-app, (中文(简体) ), web-builder,以及 web-builder-elements 输入一个可公布 npm 包。 建筑规则支持两种反应(.tsx)和Vue (中文(简体) ).vue)档案.
软件包名称是
@gem-sdk/eslint-plugin,因此其 ESLint 插件前缀为@gem-sdk(扫描包放下)eslint-plugin-分节)。 参考规则作为@gem-sdk/<rule>可共享配置为plugin:@gem-sdk/<config>。 。 。 .
安装
yarn add -D @gem-sdk/eslint-plugin
使用量
选择匹配您的技术堆栈的配置 :
反应项目
{
"extends": ["plugin:@gem-sdk/react"]
}
Vue 项目
{
"extends": ["plugin:@gem-sdk/vue"]
}
全部重置( 仅重置 + i18n)
{
"extends": ["plugin:@gem-sdk/recommended"]
}
手动规则选择
{
"plugins": ["@gem-sdk"],
"rules": {
"@gem-sdk/module-structure": "error",
"@gem-sdk/no-module-barrel": "error",
"@gem-sdk/module-import-boundary": "error",
"@gem-sdk/pure-ui-layer": "error",
"@gem-sdk/module-index-required": "error",
"@gem-sdk/no-self-module-barrel-import": "error",
"@gem-sdk/no-t-for-variable": "error",
"@gem-sdk/no-clickable-div": "warn",
"@gem-sdk/require-monitoring-capture": "warn",
"@gem-sdk/not-use-store-to-refs": "error",
"@gem-sdk/not-use-custom-color-class": "warn",
"@gem-sdk/no-export-type-from-component": "error",
"@gem-sdk/no-export-type-from-tsx": "error",
"@gem-sdk/no-import-from-package-path": "error",
"@gem-sdk/no-multiple-component-exports": "error"
}
}
每个配置都允许
| 规则 | recommended | vue | react |
|---|---|---|---|
module-structure | 错误 | 错误 | 错误 |
no-module-barrel | 错误 | 错误 | 错误 |
module-import-boundary | 错误 | 错误 | 错误 |
pure-ui-layer | 错误 | 错误 | 错误 |
module-index-required | 错误 | 错误 | 错误 |
no-self-module-barrel-import | 错误 | 错误 | 错误 |
no-t-for-variable | 错误 | 错误 | 错误 |
no-clickable-div | 警告( e) | 警告( e) | 警告( e) |
not-use-store-to-refs | —— 说 | 错误 | —— 说 |
not-use-custom-color-class | —— 说 | 警告( e) | —— 说 |
no-export-type-from-component | —— 说 | 错误 | —— 说 |
no-export-type-from-tsx | —— 说 | —— 说 | 错误 |
no-import-from-package-path | —— 说 | —— 说 | 错误 |
no-multiple-component-exports | —— 说 | —— 说 | 错误 |
require-monitoring-capture | —— 说 | —— 说 | 警告( e) |
vue 财务报告和审定财务报表 react 两者均延 recommended. 需要配置 vue-eslint-parser。 。 。 .
no-export-type-from-component 财务报告和审定财务报表 no-export-type-from-tsx 执行同一事项( 无) export type编号 :export interface 从组件文件)——前者也匹配 .vue 文件,后者是只反应。 他们被分开 所以每个配置 每个文件只报告一次.
no-import-from-package-path 选项
深道进口可豁免 ignore 选项,它接受精确的导入路径或路径前缀:
{
"rules": {
"@gem-sdk/no-import-from-package-path": [
"error",
{ "ignore": ["@gem-sdk/components/internal/Button"] }
]
}
}
任何完全匹配条目的导入路径,或从条目开始,然后 /,允许.
no-self-module-barrel-import
内部文件 modules/<name>/ 不得通过 ~/编号 :@/ 别名——它混合了跨兄弟会文件的切入点,并通过管子产生循环依赖. 在一个模块内使用相对路径.
// app/modules/onboarding/components/Step.tsx
import { useOnboardingStore } from '~/modules/onboarding'; // ✗
import { useOnboardingStore } from '../stores/onboarding'; // ✓
no-clickable-div
点击非交互元素上的处理器( E)div, (中文(简体) ), span, (中文(简体) ), section, (中文(简体) ), li,或 a 无 href要求 tabIndex 加一个 keydown编号 :keyup 处理器,否则键盘用户无法到达它们. 适用于JSX,以及 vue-eslint-parser, Vue 模板。 有分布属性的元素被跳过 .
<div onClick={onViewDemo} /> // ✗
<button onClick={onViewDemo} /> // ✓
<div role="button" tabIndex={0} onClick={go} onKeyDown={go} /> // ✓
require-monitoring-capture 选项
内置反应- 平滑 onError 处理器必须调用一个抓取函数,这样故障会到达哨兵;处理器会随着识别符的假设而通过. 两种模式都是可配置的:
{
"rules": {
"@gem-sdk/require-monitoring-capture": [
"warn",
{ "hookPattern": "^use(Query|Mutation)$", "capturePattern": "capture|reportError" }
]
}
}
hookPattern 匹配钩头名称( 默认) ^use(Query|Queries|InfiniteQuery|Mutation)$(三); capturePattern 匹配名为函数或方法名称, 不区分大小写( 默认) capture) (中文(简体) ).