mcpField
D
datex-studio-conventions

datex-studio-conventions

github.com/datex开发92 次安装
代码仓库

关于 datex-studio-conventions

这是供 Datex Studio 组件编写技能引用的规范资料库,面向需要查阅平台约定的作者。索引涵盖组件格式、命名、默认值和通用检查项。

主要功能

  1. 01组件 JSON 格式说明
  2. 02组件命名规则
  3. 03默认包和访问设置
  4. 04跨组件通用检查清单

适用场景

  1. 01查找配置类型和文件格式
  2. 02创建组件时核对名称与默认值
  3. 03对不同组件应用通用检查

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/datex/skills --skill datex-studio-conventions

安装后在 Claude Code 中输入/datex-studio-conventions确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

defaults.md
file-format.md
naming-conventions.md
universal-checklist.md

详细介绍

Datex Studio — 组件创作约定

此技能是一个资料库,而非工作流。Datex Studio 组件创建技能会通过相对路径引用此处的文件(例如 ../datex-studio-conventions/file-format.md)。它作为独立技能存在,以便 npx skills / skills.sh 在安装依赖它的技能时也能一并安装它——这些工具不会复制同级的非技能目录。

何时需要此技能

你正在使用 Datex Studio 组件创建技能,并且该技能指向此处。只阅读父级技能指定的特定参考文件——不要预先加载整个目录树。

如果有人询问一个尚未归属到更具体技能的平台问题(例如“hub 的 configurationTypeId 是什么?”、“tailored grid 的 datasource 应该如何命名?”、“新组件的默认 package 是什么?”),请使用下方索引查找正确的文件。

参考索引

  • file-format.md — 组件文件的 JSON 格式:各类型的文件位置和后缀、configurationTypeId 数值表、声明式字符串插槽的 TS 表达式编码规则、通过 vars 实现动态 tooltip 的模式、return; 输出参数陷阱、flow 代码中的 TypeScript 严格性、声明为可选项的 datasource 结果类型。
  • naming-conventions.md — 各类型的组件命名模式(各类型的后缀标识、_dd 保留规则)、tailored_/custom_ 来源前缀、显示文本使用句首字母大写格式的规则、面向用户的 title 与 referenceName 的区别、可见类型的限定列表。
  • defaults.md — 默认 package(Utilities)、默认访问修饰符(public)、description 为必填项且不得超过 100 个字符。
  • universal-checklist.md — 适用于所有组件的通用检查项唯一清单(description 不超过 100 个字符、accessModifier、referenceName↔stem、压缩后的 JSON、正确的 configurationTypeId、新参数使用 snake_case、id: 0)。component-validator、grid-validator、post-edit-verification 以及每个创建技能的“File basics”预检项都会引用此清单,而不是在各处重复列出。

给技能作者的说明

当 Datex Studio 创建技能需要引用此处的内容时:

  1. 使用相对路径链接:../datex-studio-conventions/<file>.md。
  2. 在使用方 SKILL.md 的 frontmatter 中声明依赖:
    depends:
      - datex-studio-conventions
    
    depends 字段是面向 vercel-labs/skills#860 的预留标记;在该功能发布之前,请在使用方的安装说明中注明此依赖,并指导用户同时安装这两个技能。

此技能与 datex-studio-runtime(涵盖 runtime-globals、calling-conventions 和 control-types)以及 datex-studio-shared(涵盖 Datex Studio CLI 操作上下文——分支选择、Studio 生命周期、designer 上下文导航、报告创作)是同级技能。这三个共享参考技能按关注点划分了跨领域的平台知识。

评论

支持 Markdown