datex-studio-conventions について
Datex Studioのコンポーネント作成スキル向けの参照ライブラリです。形式、命名、既定値、共通チェック項目を索引から確認できます。
主な機能
- 01コンポーネントJSON形式の説明
- 02コンポーネントの命名規則
- 03既定パッケージとアクセス設定
- 04コンポーネント共通チェックリスト
活用シーン
- 01設定タイプとファイル形式の確認
- 02作成時の名前と既定値の確認
- 03複数のコンポーネントに共通する項目の適用
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ datex/ skills --skill datex-studio-conventionsインストール後、Claude Code で/datex-studio-conventionsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
defaults.mdfile-format.mdnaming-conventions.mduniversal-checklist.md詳細
Datex Studio — コンポーネント作成規約
このスキルはワークフローではなく、ライブラリです。Datex Studio のコンポーネント作成スキルは、相対パス(例:../datex-studio-conventions/file-format.md)を使って、ここにあるファイルを参照します。このスキルを独立したスキルとして用意しているのは、npx skills / skills.sh で利用側のスキルと一緒にインストールできるようにするためです。これらのツールでは、スキルと同階層にあるスキル以外のディレクトリはコピーされません。
このスキルが役立つ場合
Datex Studio のコンポーネント作成スキルに従っていて、そのスキルからここを参照するよう指示された場合に使用します。親スキルが指定した特定の参照ファイルだけを読み、ツリー全体を事前に読み込まないでください。
より具体的なスキルの対象になっていないプラットフォームに関する質問(例:「ハブの configurationTypeId は何ですか?」「テーラードグリッドのデータソースの名前はどう付ければよいですか?」「新しいコンポーネントのデフォルトパッケージは何ですか?」)を受けた場合は、以下のインデックスから適切なファイルを探してください。
参照インデックス
- file-format.md — コンポーネントファイルの JSON 形式:タイプごとのファイルの場所と拡張子、
configurationTypeIdの数値一覧、宣言型の文字列スロットにおける TS 式のエンコード規則、vars を使った動的ツールチップのパターン、return;による outparam の落とし穴、フローコード内での TypeScript の厳格さ、オプションとして宣言するデータソースの結果型。 - naming-conventions.md — タイプごとのコンポーネント名のパターン(タイプ別の接尾辞、
_ddの予約)、tailored_/custom_の由来を示す接頭辞、表示テキストの文頭大文字規則、ユーザー向けのtitleとreferenceNameの違い、表示可能なタイプの限定リスト。 - defaults.md — デフォルトのパッケージ(
Utilities)、デフォルトのアクセス修飾子(public)、説明の指定必須および100文字以内の制限。 - universal-checklist.md — すべてのコンポーネントに適用される共通チェック項目をまとめた唯一の一覧(説明は100文字以内、accessModifier、referenceName とファイル名の一致、JSON の最小化、正しい
configurationTypeId、新しいパラメーターの snake_case、id: 0)。各項目を繰り返し記載する代わりに、component-validator、grid-validator、post-edit-verificationと、各作成スキルの「File basics」事前確認項目から参照されます。
スキル作成者向けの注意事項
Datex Studio の作成スキルからここにある内容を参照する必要がある場合:
- 相対パスでリンクします:
../datex-studio-conventions/<file>.md。 - 利用側の SKILL.md の frontmatter で依存関係を宣言します:
depends: - datex-studio-conventionsdependsフィールドは vercel-labs/skills#860 に向けた将来のためのマーカーです。これが実装されるまでは、利用側スキルのインストール手順に依存関係を記載し、両方のスキルを一緒にインストールするようユーザーに案内してください。
このスキルは、runtime-globals、calling-conventions、control-types を扱う datex-studio-runtime と、Datex Studio CLI の運用コンテキスト(ブランチの選択、Studio のライフサイクル、デザイナーコンテキストのナビゲーション、レポート作成)を扱う datex-studio-shared と同階層にあります。この3つの共通参照スキルは、プラットフォームに関する横断的な知識を、それぞれの関心領域ごとに分担しています。