龙卷风 Canvas ESLint 配置
用于验证 Drupal Canvas 代码组件的 ESLint 配置 .
配置变体
| 配置 | 说明 |
|---|---|
required | 解析JavaScript和TypeScript文件的基础设置,组件元数据文件的YAML解析,以及Drupal Canvas代码组件验证的自定义规则. 自动使用 @drupal-canvas/cli 当验证、构建或推动组件时. |
recommended | required + 建议的规则来自 @eslint/js, (中文(简体) ), eslint-plugin-react, (中文(简体) ), eslint-plugin-react-hooks, (中文(简体) ), eslint-plugin-jsx-a11y, (中文(简体) ), eslint-plugin-yml 财务报告和审定财务报表 typescript-eslint。 。 。 . |
strict | recommended + 严格规则从 eslint-plugin-jsx-a11y 财务报告和审定财务报表 typescript-eslint。 。 。 . |
使用量
npm install -D @drupal-canvas/eslint-config
// eslint.config.js
import { defineConfig } from 'eslint/config';
import { recommended as drupalCanvasRecommended } from '@drupal-canvas/eslint-config';
export default defineConfig([
...drupalCanvasRecommended,
// ...
]);
规则
这个 required 配置检查便携式作者规则和项目惯例.
元数据结构和目标接受通过
Canvas Code 组件元数据计划与目标Drupal站点.
| 规则 | 说明 |
|---|---|
component-dir-name | 验证 machineName 匹配目录名称(索引样式)或文件名前缀(名样式). |
component-exports | 验证该组件有默认导出 . |
component-imports | 验证该组件仅从辅助进口来源和模式进口. |
component-no-hierarchy | 验证组件目录为配置的直列子 componentDir。 。 。 . |
component-prop-example-value-no-empty-string | 验证字符串道具示例中不包含空值 . |
component-prop-names | 验证组件道具ID与骆驼Case版本的标题相匹配. |
component-required-props | 验证所需的道具被定义,并提供一个默认示例. |
发展
用于开发此软件包的脚本如下:
| 命令 | 说明 |
|---|---|
dev | 编译到 dist 用于开发的文件夹,同时监视更改. |
build | 编译到 dist 用于制作的文件夹. |
type-check | 运行类型脚本类型检查而不释放文件 . |
test | 运行测试. |