用途
canvas-component-naming 是一套针对 Canvas 组件的命名约定,用来统一组件的机器名(machineName)、组件目录(src/components/<name>/)以及 story 文件的命名。目标是通过简单、通用、可移植的命名,让组件名称直接说明其功能,而不是暴露它所属的项目或站点。
主要能力
- 使用简洁、通用的名称,例如 footer、hero、navigation、contact-form。
- 组件名禁止添加项目或站点名前缀。组件应可复用,名称应描述用途而非来源。
- 正确示例:footer、hero、navigation、contact-form
- 错误示例(带项目/站点前缀):nebula-footer、acme-hero、mysite-navigation、projectx-contact-form
- 统一使用 kebab-case(短横线小写)命名,包括 machineName、src/components/<name>/ 目录以及 story 文件名。
使用方式
- 创建新组件时:若无示例可参考,选择一个简单、具有描述性的名称。
- 重命名组件时:遵循上述 kebab-case 与去前缀规则。
- 复制并修改示例组件时:除非该组件服务于根本不同的用途,否则保留原始名称。
适用场景
适用于 Canvas 组件的创建、重命名,以及从示例组件复制并修改的工作流程,帮助团队保持一致的命名风格,并提升组件的可移植性与复用性。
限制
资料未提供该技能的具体安装方式、运行命令、支持平台、收费信息或生效范围,暂未提供相关内容。