본문으로 건너뛰기

registry.json 스키마

전체 스키마

JSON
{
  "$schema": "https://blockstudio.dev/schema/registry.json",
  "name": "my-registry",
  "description": "A collection of WordPress blocks.",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "description": "Full-width hero section with heading and CTA.",
      "category": "layout",
      "type": "blockstudio",
      "dependencies": ["button"],
      "files": [
        "block.json",
        "index.php",
        "style.scss"
      ]
    }
  ]
}

최상위 필드

필드 유형 필수 설명
$schema string 아니요 편집기 검증을 위한 JSON 스키마 URL.
name string 예 레지스트리 식별자입니다. 비어 있으면 안 됩니다.
description string 아니요 레지스트리에 대한 간단한 설명입니다.
baseUrl string 예 블록 파일 다운로드를 위한 기본 URL입니다. 유효한 URL이어야 합니다.
blocks BlockEntry[] 예 사용 가능한 블록 배열입니다. 항목이 하나 이상 있어야 합니다.

블록 항목 필드

필드 유형 필수 설명
name string 예 블록 폴더 이름이자 CLI 식별자입니다. 비어 있으면 안 됩니다.
title string 아니요 사람이 읽을 수 있는 표시 이름입니다.
description string 아니요 검색 결과에 표시되는 한 줄 설명입니다.
category string 아니요 목록 출력에 사용할 그룹 레이블입니다.
type "blockstudio" | "create-block" | "wordpress" 아니요 블록 유형입니다. 정보 제공용이며 CLI 동작에는 영향을 주지 않습니다.
dependencies string[] 아니요 이 블록과 함께 설치해야 하는 동일 레지스트리 내 블록 이름입니다.
files string[] 예 블록 폴더 기준 상대 파일 경로입니다. 파일이 하나 이상 필요합니다.

파일 경로 확인

각 파일은 다음 위치에서 다운로드됩니다:

코드
{baseUrl}/{block.name}/{file}

그리고 다음 위치에 기록됩니다:

코드
{directory}/{block.name}/{file}

파일 경로의 하위 디렉터리는 자동으로 생성됩니다.

검증 규칙

  • name는 레지스트리와 블록 수준 모두에서 비어 있으면 안 됩니다.
  • baseUrl는 유효한 URL여야 합니다.
  • blocks에는 항목이 하나 이상 있어야 합니다.
  • 각 블록의 files에는 항목이 하나 이상 있어야 합니다.
  • type가 지정된 경우 허용된 세 값 중 하나여야 합니다.
  • dependencies가 지정된 경우 문자열 배열이어야 합니다. 각 종속 항목은 동일한 레지스트리에 있어야 하며, 그렇지 않으면 확인 단계에서 CLI가 오류를 발생시킵니다.