본문으로 건너뛰기

blocks.json 스키마

전체 스키마

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "public": "https://example.com/registry.json",
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

필드

필드 유형 필수 설명
$schema string 아니요 편집기 검증을 위한 JSON 스키마 URL.
directory string 예 블록을 설치하는 blocks.json의 상대 경로입니다. 비어 있으면 안 됩니다.
registries Record<string, string | RegistryRef> 예 네임스페이스 이름과 레지스트리 참조의 매핑입니다. 비어 있어도 됩니다.

레지스트리 참조 형식

registries의 각 값은 문자열 URL이거나 객체입니다:

문자열: registry.json 파일을 가리키는 유효한 URL입니다.

객체:

필드 유형 필수 설명
url string 예 registry.json 파일을 가리키는 유효한 URL입니다.
headers Record<string, string> 아니요 이 레지스트리에 보내는 모든 요청에 포함되는 HTTP 헤더입니다. 값은 ${ENV_VAR} 보간을 지원합니다.

검증 규칙

  • directory는 비어 있지 않은 문자열이어야 합니다.
  • registries의 각 키는 비어 있지 않은 문자열이어야 합니다.
  • 문자열 레지스트리 값은 유효한 URL이어야 합니다.
  • 객체 레지스트리 값에는 유효한 url 필드가 있어야 합니다.
  • 헤더의 ${ENV_VAR} 참조는 런타임에 확인됩니다. 변수가 누락되면 해당 변수와 헤더의 이름이 포함된 오류가 발생합니다.
  • registries 객체는 비어 있어도 됩니다. add는 그러면 No registries configured in blocks.json. Add a registry first.로 종료되고, list는 No registries configured.을 출력하며, search는 No blocks matching "<query>".을 출력합니다.

구성 파일 검색

CLI는 현재 작업 디렉터리부터 상위 디렉터리를 따라 최대 20단계까지 blocks.json를 검색합니다. 처음 찾은 blocks.json가 사용됩니다.