用途
nebula-component-validation 是一个用于组件验证的技能。它适用于以下场景:创建或修改组件之后,以及对页面进行会改变渲染输出的工作之后,在认为工作完成之前执行验证。
主要能力
该技能的核心能力是确保组件和页面工作在完成前经过验证。具体包括:
- 在运行验证之前,确认 Workbench 预览覆盖与变更匹配。
- 确保每个新增或修改的组件都能通过 component.yml 示例进行审查,并在需要额外命名状态时通过 mocks.json 提供。
- 确保任何页面工作都在仓库配置的 pages/ 目录中表示为有效的 Workbench 页面 JSON 文件。
- 通过运行 code:fix 脚本对代码进行验证,该脚本会运行带自动修复的 Prettier 和 ESLint。
使用方式
创建或修改组件后,始终通过运行 code:fix 脚本验证代码。需使用正确的包管理器。例如,如果使用 npm,运行以下命令:
npm run code:fix
该命令会运行 Prettier 和 ESLint 并启用自动修复,从而确保:
- 一致的格式
- 常见问题检测
- 满足 Drupal Canvas Code Component 要求
如果自动修复后仍有错误,需手动处理这些错误,并重新运行命令,直到通过为止。
当任务改变渲染输出时,该技能止于静态验证。
适用场景
该技能适用于以下情况:
- 创建新组件之后
- 修改现有组件之后
- 对页面进行会改变渲染输出的工作之后
- 在认为工作完成之前
限制
资料中未提供关于该技能的其他限制、收费、价格、平台或效果信息。当任务改变渲染输出时,该技能止于静态验证,不涉及运行时或动态验证。