콘텐츠로 이동
AggregaAggrega
언어 선택: 한국어
이 페이지는 기계 번역되었습니다. 영어 원문 읽기.

Aggrega Wasm Describe Socket 스키마

자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.

스키마 id: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json

모든 Wasm 플러그인이 describe() export(PluginDescriptor)에서 반환하는 와이어 형태입니다. describe()는 플러그인의 자기 선언으로, 호스트가 플러그인을 로드할 때 한 번 읽습니다. 여기에는 게스트가 바인딩하는 ABI 버전, 플러그인 유형, 플러그인이 제공하는 export와 각 export의 capability 선언, 플러그인 수준의 capability 자기 보고, 선택적인 provider 렌더링 동작 계약, 선택적인 importer 인식 계약, 선택적인 CLI 명령, 선택적인 설정 스키마, 선택적인 작성자 메타데이터가 포함됩니다. 하나의 형태가 모든 플러그인 유형, 즉 provider, linter, feature-recipe-pipeline 단계, governance, CLI, parser, importer를 포괄합니다. 호스트는 다른 export를 디스패치하기 전에 describe()를 읽으며, 수용할 수 없는 descriptor는 디스패치 시점에 플러그인을 잘못 호출하는 대신 거부합니다.

다음 형태 중 하나

  • PluginDescriptor

정의

PluginDescriptor

플러그인의 완전한 자기 선언으로, describe()에서 반환되며 로드 시 한 번 읽힙니다. ABI 호환성 핸드셰이크, 플러그인 타입, 제공되는 익스포트, 그리고 선택적인 타입별 표면(provider의 렌더 동작 계약, importer의 인식 계약, CLI 플러그인의 명령, 설정 스키마, 작성자 메타데이터)을 담습니다.

속성타입필수설명
abi_versionconst “v1beta1”예게스트가 바인딩하는 플러그인 ABI입니다. 호스트는 정확히 이 버전만 허용하며, 다른 ABI로 빌드된 게스트는 디스패치 시 잘못 호출되는 대신 로드 시 거부됩니다. 상수: "v1beta1"
plugin_typestring (enum)예플러그인의 종류입니다. 호스트가 검증하는 최소 익스포트 규칙을 선택하고, 익스포트 이름과 함께 기본 입력 전달 패턴을 결정합니다. governance 플러그인은 빌드 파이프라인의 변환 및 판정 역할을 수행하며, 무엇을 내보낼 수 있는지는 종류가 아니라 연결된 역할이 정합니다. 허용 값: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
capabilitiesstring[]아니요플러그인이 제공하는 대상입니다. 목록은 전송 형식상 평면적이며, 인접한 필수 항목 plugin_type이 각 항목이 네 가지 의미 중 어느 것을 갖는지 정합니다. provider의 경우 출력 형태를 렌더링하는 capability 이름(helm 또는 compose 등), feature-recipe-pipeline 단계의 경우 해당 단계와 호환되는 provider capability, parser의 경우 정규 구조화 트리로 변환하는 소스 형식(각각 parse:으로 작성), importer의 경우 초안 작성 파일로 변환하는 외부 소스 형식(각각 import:으로 작성)입니다. linter, governance, CLI 플러그인은 capability로 해석되지 않으므로 비워 둡니다. 항목은 선언된 순서를 따르며, 명시적이고 테스트된 호환성 주장입니다. 없거나 빈 목록은 capability 주장을 선언하지 않습니다. 게시된 카탈로그 엔터티는 플러그인 타입이 의미를 부여하는 타입별 블록 아래에 같은 값을 담으므로, 엔터티를 읽는 쪽이 어떤 의미가 적용되는지 판단할 필요가 없습니다.
exportsPluginExport[]예플러그인이 제공하는 익스포트로, 선언된 순서를 따릅니다. 호스트는 타입별 최소 익스포트가 있는지 검증하고, 각 익스포트를 호출하기 전에 익스포트별 호스트 표면을 바인딩합니다.
contractProviderContract아니요provider의 렌더 동작 자기 보고로, 렌더링하는 입력 종류, 디스패치 그룹의 노드별 출력을 조립하는 방식, 적용하는 아티팩트 템플릿 구분자 쌍을 담습니다. 특정 익스포트가 아니라 provider 전체를 기술합니다. 렌더 동작 계약을 선언하지 않는 플러그인에서는 없습니다.
importerImporterContract아니요import가 형식을 지정하지 않을 때, importer가 알리는 형식의 소스를 어떻게 인식하는지에 대한 importer의 자기 보고입니다. plugin_type이 importer인 플러그인만 선언할 수 있으며, 다른 플러그인이 선언하면 로드 시 거부됩니다. 형식을 인식하는 방법을 선언하지 않는 importer에서는 없으며, 이 경우 그 형식은 이름을 지정해야만 사용할 수 있습니다.
descriptionstring아니요플러그인이 하는 일에 대한 플러그인 자체의 한 줄짜리 사람이 읽을 수 있는 설명으로, 익스포트별 설명이나 엔터티의 metadata 설명과는 별개입니다. 정보 제공용이며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다.
commandsPluginCLICommand[]아니요CLI 플러그인이 추가하는 최상위 aggrega 명령 동사로, 각각 고유한 짧은 도움말 줄을 가집니다. 하나의 CLI 플러그인이 여러 명령을 추가할 수 있으며, 호스트는 항목마다 명령 하나를 등록하고 호출 시 해석된 명령 이름을 게스트로 전달합니다. CLI가 아닌 플러그인은 비워 둡니다.
settings_schemaobject아니요플러그인이 연결 시 담기는 운영자 제공 설정의 타입을 지정하기 위해 선언하는 선택적 JSON Schema 문서입니다. 있으면 호스트가 로드 시 이를 컴파일하고, 플러그인을 호출하기 전 디스패치 시 연결의 설정을 이에 대해 검증하며, 부합하지 않는 설정은 빌드를 중단시킵니다. 없으면 플러그인은 형태를 선언하지 않으며 설정은 그대로 전달됩니다. 스키마는 플러그인 자체의 자유 형식 선언이며, 호스트는 이에 대해 일반적인 JSON Schema 검증을 수행할 뿐 설정의 의미는 해석하지 않습니다.
metadataPluginDescriptorMeta아니요선택적인 작성자 및 빌드 출처 정보입니다. 동작 계약을 담지 않으며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다.

추가 속성은 허용되지 않습니다.

PluginExport

describe()에서 선언된, 플러그인이 제공하는 하나의 익스포트입니다. 호스트는 이름으로 익스포트에 디스패치하며, 익스포트가 선언한 호스트 함수에 필요한 최소 권한의 호스트 표면을 바인딩합니다.

속성타입필수설명
namestring예익스포트의 ABI 이름입니다(예: render_node, assemble_boundary, lint_rules, step). 호스트는 이 이름으로 익스포트에 디스패치합니다.
input_patternstring (enum)아니요호스트가 익스포트의 입력을 전달하는 방식입니다. b는 전체 페이로드를 인라인으로 전달하여 게스트가 페이로드만으로 렌더링하게 하고, a는 작은 페이로드를 전달하여 게스트가 호스트 함수로 보강하게 합니다. 이 필드를 생략한 익스포트는 플러그인 타입과 이름에 따른 기본값을 따릅니다. 허용 값: "a", "b"
host_functionsstring[]아니요이 익스포트가 임포트하는 호스트 함수 이름입니다. 모든 이름은 호스트 함수 허용 목록에 있어야 합니다. 이 선언은 권위를 가지며 로드 시 게스트가 모듈에서 실제로 임포트하는 함수와 교차 검증되므로, 게스트가 실제로 호출하는 함수와 어긋날 수 없습니다.
descriptionstring아니요익스포트를 설명하는 선택적인 사람이 읽을 수 있는 텍스트입니다. 카탈로그 독자를 위한 문서이며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다.
stabilitystring (enum)아니요익스포트의 안정성 수준입니다. 값을 생략하면 안정성 주장이 없습니다. 허용 값: "stable", "experimental", "deprecated"
operatesstring (enum)아니요이 익스포트가 수행하는 파이프라인 작업입니다. patch는 기존에 렌더링된 문서를 수정하고, emit은 새 문서를 추가합니다. 값은 로드 시 형태가 검사되며, 런타임은 단계를 디스패치할 때 이를 읽습니다. 허용 값: "patch", "emit"
scopestring (enum)아니요이 익스포트가 작업하는 문서 루트입니다. own은 노드 자체의 렌더링된 문서이고, host는 component 범위 feature recipe가 연결된 component의 문서입니다. 값은 로드 시 형태가 검사되며, 런타임은 디스패치할 때 해당 범위의 문서를 해석합니다. 허용 값: "own", "host"
selectorstring아니요익스포트가 작업하는 대상에 대한 자유 형식의 사람이 읽을 수 있는 설명입니다. 카탈로그 독자를 위한 문서이며, 호스트는 그 내용을 검증하지도 이에 따라 동작하지도 않습니다.
inputobject아니요step 익스포트가 파이프라인 항목이 with 블록을 통해 제공하는 단계 로컬 입력의 타입을 지정하기 위해 선언하는 선택적 JSON Schema 문서입니다. 있으면 단계의 with 입력이 충족하는 형태를 기술하고, 없으면 익스포트는 입력 계약을 선언하지 않습니다. 스키마는 파이프라인 작성자가 이 익스포트에 대해 대상으로 삼는 입력 표면에 대한 익스포트 자체의 자유 형식 선언입니다.
outputobject아니요step 익스포트가 한 단계에서 반환하는 출력의 타입을 지정하기 위해 선언하는 선택적 JSON Schema 문서로, 이후 단계나 템플릿이 읽도록 단계가 제공하는 주소 지정 가능한 출력의 형태입니다. 있으면 반환되는 출력의 형태를 기술하고, 없으면 익스포트는 출력 계약을 선언하지 않습니다. 스키마는 이 익스포트가 생성하는 출력 표면에 대한 익스포트 자체의 자유 형식 선언입니다.

추가 속성은 허용되지 않습니다.

PluginCLICommand

describe()에서 선언된, CLI 플러그인이 추가하는 하나의 최상위 aggrega 명령 동사입니다. 호스트는 항목마다 명령 하나를 등록하고 호출 시 해석된 명령 이름을 게스트로 되돌려 전달하므로, 하나의 게스트가 여러 명령을 지원하고 이름에 따라 동작을 선택할 수 있습니다.

속성타입필수설명
namestring예호스트가 등록하는 명령 동사로, 운영자가 호출하는 aggrega 토큰이자 어떤 명령이 호출되었는지에 따라 분기할 수 있도록 호스트가 게스트에 전달하는 판별자입니다. 선언된 모든 명령은 이를 지정해야 합니다.
descriptionstring아니요명령 목록과 도움말 출력에 표시되는 명령의 한 줄 짧은 도움말 텍스트입니다. 선택적인 문서이며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다.
flagsPluginCommandFlag[]아니요명령의 플래그로, 선언된 순서를 따릅니다. 각 항목은 호스트가 명령에 등록하는 플래그 하나를 추가하므로, aggrega help 가 이를 핵심 명령의 플래그처럼 표시합니다. 플래그가 없는 명령은 비워 둡니다.

추가 속성은 허용되지 않습니다.

PluginCommandFlag

CLI 플러그인이 명령에 선언하는 하나의 플래그로, describe()에서 보고됩니다. 호스트는 이를 명령에 등록하므로 aggrega help 가 핵심 명령의 플래그와 함께 이를 나열합니다.

속성타입필수설명
namestring예플래그의 긴 이름으로, 운영자가 명령줄에서 전달하는 —name 토큰입니다. 선언된 모든 플래그는 이 이름을 지정해야 합니다. 최소 1자 이상이어야 합니다.
shorthandstring아니요플래그의 선택적인 한 글자 짧은 별칭으로, 운영자가 긴 이름 대신 전달할 수 있는 -x 형식입니다. 없으면 플래그에 짧은 별칭이 없다는 뜻입니다.
descriptionstring아니요명령의 도움말 출력에 표시되는 플래그의 한 줄 도움말 텍스트입니다. 선택적인 문서이며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다.
typestring아니요플래그의 값 타입입니다(예: string, bool, int). 없으면 타입에 대한 주장이 없습니다.
defaultstring아니요운영자가 플래그를 전달하지 않을 때의 기본값으로, 문자열로 표현됩니다. 없으면 플래그가 기본값을 선언하지 않는다는 뜻입니다.

추가 속성은 허용되지 않습니다.

PluginDescriptorMeta

플러그인이 describe()에서 선언하는 선택적인 작성자 및 빌드 출처 메타데이터입니다. 정보 제공용이며, 호스트는 이를 검증하지도 이에 따라 동작하지도 않습니다. version 및 commit 필드는 빌드 시점에 게스트에 기록되는 빌드 출처이며, 기록되지 않은 빌드에서는 생략됩니다.

속성타입필수설명
authorstring아니요플러그인의 작성자입니다.
repositorystring아니요플러그인의 소스 저장소입니다.
licensestring아니요플러그인의 라이선스 식별자입니다.
versionstring아니요빌드 시점에 게스트에 기록되는 빌드 출처 버전입니다. 기록되지 않은 빌드에서는 생략됩니다.
commitstring아니요게스트가 빌드된 빌드 출처의 짧은 커밋입니다. 기록되지 않은 빌드에서는 생략됩니다.

추가 속성은 허용되지 않습니다.

ProviderContract

provider가 렌더링하는 노드 전반에 걸쳐 수행하는 컴파일 시점 렌더링 동작에 대한 자기 선언입니다. 여기에는 수용하는 입력 종류, 디스패치 그룹의 노드별 출력을 단일 아티팩트로 조립하는지와 그 방식, 가져온 아티팩트 파일에 적용하는 Go 템플릿 구분자 쌍, Recipe가 해당 경계의 공유 출력에 기여하는 파일을 수용하는지 여부, 그리고 해당 생태계가 소스 옆에 절대 포함하지 않는 파일이 포함됩니다. 이는 특정 export가 아니라 provider 전체를 설명합니다. 로드 게이트는 이를 엔터티에 작성된 주장과 교차 검사합니다.

속성타입필수설명
input_kindsInputKinds예플러그인이 렌더링하는 세 가지 Recipe 입력 종류 중 어떤 것인지를 나타냅니다. 소스로 제공되는 파일 집합, 합성된 워크로드, 아티팩트만 있는 독립 노드입니다.
boundary_assemblystring (enum)예플러그인이 디스패치 그룹의 노드별 렌더링 출력을 결합하는 방식입니다. none은 각 노드의 출력을 디스패치 경로에 직접 쓰고, merge는 노드별 조각을 하나의 문서로 병합하며, nest는 각 노드의 출력을 상위 구조 안의 자체 위치 아래에 배치합니다. 빈 값은 조립에 대한 주장이 없습니다. 허용되는 값: "none", "merge", "nest", ""
artifact_delimitersArtifactDelimiters아니요플러그인이 가져온 아티팩트 파일에 적용하는 Go 템플릿 구분자 쌍입니다. 없으면 기본 여는/닫는 쌍을 의미하며, 대상 구문이 해당 쌍과 충돌하는 플러그인은 여기에 대체 쌍을 보고합니다.
assembly_name_annotationAssemblyNameAnnotation아니요확인된 값이 플러그인이 디스패치 그룹에서 조립하는 아티팩트의 이름을 지정하는 경계 어노테이션입니다. 없으면 플러그인은 디스패치 경로만으로 조립 결과의 이름을 정합니다.
reusable_instance불리언아니요크로싱마다 새 인스턴스를 사용하는 대신, 로드된 하나의 플러그인 인스턴스가 빌드의 모든 render, assemble, validate 크로싱을 처리할 수 있는지 여부입니다. 플러그인은 크로싱 간에 상태를 유지하지 않을 때에만 이를 true로 선언합니다. 없음(false)이 안전한 기본값이며, 이때 호스트는 크로싱마다 새 인스턴스를 로드합니다.
cross_boundary_linking불리언아니요플러그인이 link_publish 및 link_resolve export를 통해 provider 고유의 상호 참조 연결을 생성하여 경계를 넘는 uses 엣지, 즉 소비하는 쪽과 소비되는 쪽이 서로 다른 디스패치 그룹으로 조립되는 엣지를 연결하는지 여부입니다. 플러그인은 두 export를 모두 제공할 때에만 이를 true로 선언합니다. 없음(false)이 안전한 기본값이며, 이때 플러그인은 경계를 넘는 엣지를 연결하지 않습니다.
omits불리언아니요플러그인이 render_node 입력에 포함된 omit 항목을 따르는지 여부입니다. 즉, 항목과 일치하는 모든 렌더링 단위를 반환하는 모든 것에서 제외하고, 전달받은 항목마다 하나의 개수를 출력의 omitted에 보고합니다. 플러그인은 두 가지를 모두 수행할 때에만 이를 true로 선언합니다. 없음(false)이 안전한 기본값이며, 이때 플러그인은 무언가를 제외한다고 주장하지 않습니다.
boundary_artifacts불리언아니요플러그인의 대상이 렌더링되는 경계의 공유 출력에 Recipe가 기여하는 파일을 수용하는지 여부입니다. 호스트는 해당 파일을 평가하여 각 파일을 디스패치 그룹의 조립된 출력이 있는 디렉터리에, 플러그인의 조립 결과 옆에 한 번씩 씁니다. 플러그인은 이 파일을 전달받지도 읽지도 않으므로, 이 주장은 대상이 그곳에 놓인 파일을 경계 출력의 일부로 취급한다는 진술입니다. 없음(false)이 안전한 기본값이며, 이때 이 플러그인에 대해 그러한 파일을 선언하는 Recipe는 렌더링 전에 거부됩니다.
nest_segmentstring아니요디스패치 그룹의 노드별 출력을 중첩하는 플러그인에서, 플러그인의 대상이 각 기여자의 하위 디렉터리를 두는 디렉터리입니다. 호스트는 이 세그먼트, 기여자의 작성 수준 이름, 각 파일 자체의 경로를 결합합니다. boundary_assembly가 nest일 때에만 읽습니다. 없으면 호스트는 둘러싸는 디렉터리 없이 각 기여자의 하위 디렉터리를 디스패치 위치에 직접 둡니다. 값은 경로가 아닌 하나의 디렉터리 이름입니다. 경로 구분자를 포함하거나 현재 또는 상위 디렉터리를 지정하는 값은 거부됩니다. 호스트가 기여자의 이름을 이 값에 결합하므로, 경로 조각이 있으면 기여자의 파일이 디스패치 위치 아래가 아닌 다른 곳에 놓이게 되기 때문입니다.
source_ignoreSourceIgnore아니요이 플러그인의 생태계가 렌더링하는 소스 옆에 절대 포함하지 않는 파일로, 무시 규칙으로 선언됩니다. 호스트는 작성자가 이 플러그인이 해당 capability를 제공하는 Recipe 또는 FeatureRecipe를 고정할 때 이 선언을 읽습니다. 호스트는 이 규칙을 작성자 자신의 무시 파일과 조합하고, 조합된 규칙을 엔터티 옆의 엔터티 잠금에 기록하며, 이후 엔터티의 모든 게시, 로컬 소스의 모든 비교, 모든 렌더링에서 플러그인에 다시 묻지 않고 기록된 규칙을 적용합니다. 따라서 capability에 대해 게시된 Recipe는 게시자의 규칙이 유지한 파일을 포함하며, 플러그인은 같은 ABI 버전을 사용하고, 계약이 엔터티의 주장과 일치하며, 그 집합 밖의 파일이 필요하지 않을 때 이를 렌더링합니다. 집합에서 제외된 파일이 필요한 플러그인은 빌드를 명시적으로 실패시키고 해당 파일의 이름을 밝혀야 합니다. 호스트의 역할은 집합에 없는 파일의 패킹이나 읽기를 그 이름을 밝히며 거부하는 것입니다. 없으면 무시 규칙을 선언하지 않으며, 이때 플러그인이 렌더링하는 소스는 작성자 자신의 규칙이 유지하는 모든 파일을 유지합니다.

추가 속성은 허용되지 않습니다.

SourceIgnore

플러그인의 생태계가 소스 디렉터리에 적용하는 gitignore 구문의 무시 규칙입니다. 슬래시가 없거나 끝에만 슬래시가 있는 패턴은 모든 깊이의 이름과 일치하고, 그 밖의 슬래시가 있는 패턴은 적용 범위인 디렉터리의 루트부터 읽으며, 끝의 슬래시는 디렉터리에만 일치하고, 앞의 !는 이전 규칙이 제외한 것을 다시 포함합니다. 규칙은 순서대로 적용되며 나중의 일치가 이전 일치보다 우선합니다. 규칙이 제외한 디렉터리에는 들어가지 않으므로, 디렉터리 자체를 먼저 다시 포함하지 않는 한 그 아래의 어떤 것도 다시 포함되지 않습니다.

속성타입필수설명
patternsstring[]아니요생태계 자체의 무시 패턴으로, 각각 탐색 중인 로컬 소스 디렉터리의 루트를 범위로 하며 적용 순서대로 나열됩니다. 없거나 비어 있으면 아무것도 선언하지 않습니다.
filesstring[]아니요생태계가 소스 안에서 따르는 무시 파일의 이름입니다(예: 차트의 경우 .helmignore). 소스를 탐색하다가 이 이름 중 하나의 파일을 발견하면, 그 줄들을 같은 구문의 추가 패턴으로 읽으며 각각 해당 파일이 있는 디렉터리를 범위로 하고 위의 패턴 다음에 적용됩니다. 빈 줄과 #으로 시작하는 줄은 건너뜁니다. 그러한 이름의 파일 자체는 규칙이 제외하지 않는 한 포함됩니다. 없거나 비어 있으면 아무 이름도 지정하지 않습니다.

추가 속성은 허용되지 않습니다.

InputKinds

플러그인이 렌더링하는 Recipe 입력 종류입니다. 각 필드는 독립적인 선언이며, 플러그인은 어떤 조합이든 보고할 수 있습니다.

속성타입필수설명
sourced불리언예플러그인이 소스 파일 세트(차트, 모듈, compose 파일)를 렌더링하는지 여부입니다.
synthesized불리언예플러그인이 합성된 워크로드를 렌더링하는지 여부입니다.
artifacts_standalone불리언예플러그인이 독립형 아티팩트 전용 노드, 즉 가져온 아티팩트 문서를 담고 소스나 워크로드는 없는 노드를 렌더링하는지 여부입니다.

추가 속성은 허용되지 않습니다.

ArtifactDelimiters

플러그인이 가져온 아티팩트 파일에 적용하는 Go 템플릿 구분자 쌍으로, 기본 쌍과 다를 때 보고됩니다.

속성타입필수설명
leftstring예여는 구분자입니다.
rightstring예닫는 구분자입니다.

추가 속성은 허용되지 않습니다.

AssemblyNameAnnotation

확인된 값이 플러그인의 조립된 아티팩트 이름을 지정하는 경계 어노테이션으로, 플러그인이 디스패치 그룹에 기여하는 경계들을 하나의 이름 있는 조립물로 합칠 때 보고됩니다.

속성타입필수설명
annotationstring예플러그인이 조립된 아티팩트의 이름을 읽어 오는 경계 어노테이션 키입니다.
require_unique불리언아니요하나의 디스패치 그룹에 기여하는 모든 경계가 어노테이션의 확인된 값에 일치해야 하는지 여부입니다. true이면 기여 경계들이 어노테이션을 서로 다른 값으로 확인하는 그룹은 빌드를 중단시키고, false이면 플러그인은 처음 확인된 값을 받아들입니다.

추가 속성은 허용되지 않습니다.

ImporterContract

임포터가 자신의 형식을 알리는 것 외에 선언하는 내용, 즉 해당 형식의 소스를 인식하는 시그니처입니다. 가져오기가 형식을 지정하지 않으면, 호스트는 가져오기가 선택할 수 있는 모든 임포터(워크스페이스 카탈로그의 임포터와, 바이너리가 Plugin 엔티티를 담고 있는 컴파일러의 핵심 임포터)가 기록한 시그니처를 읽고, 어떤 형식이 무엇인지 알지 못한 채 각 시그니처를 소스와 대조한 뒤, 시그니처가 일치하는 단 하나의 임포터의 형식으로 소스를 읽습니다. 어떤 시그니처와도 일치하지 않는 소스는 형식을 요청하며 거부되고, 둘 이상의 형식의 시그니처와 일치하는 소스는 해당 형식들을 명시하며 거부됩니다. Plugin 엔티티는 같은 목록을 기록하며, 호스트는 describe() 보고가 기록과 다른 임포터를 거부합니다.

속성타입필수설명
detectDetectSignature[]아니요이 임포터의 형식의 소스를 인식하는 시그니처로, 선언된 순서를 따릅니다. 이 중 하나라도 소스와 일치하면 소스가 인식됩니다. 임포터가 인식한 소스는 그 임포터가 알리는 모든 형식으로 인식되므로, 둘 이상의 형식을 알리는 임포터는 모든 일치가 모호한 것으로 거부되며, 소스가 인식되어야 하는 임포터는 하나의 형식만 알립니다. 없거나 비어 있으면 시그니처를 선언하지 않으며, 임포터의 형식은 이름을 지정해야만 사용됩니다.

추가 속성은 허용되지 않습니다.

DetectSignature

소스를 인식하는 한 가지 방법으로, 소스를 읽는 구문, 시그니처가 적용되는 파일 이름, 파싱된 트리가 충족해야 하는 술어로 이루어집니다. 이름이 파일 패턴 중 하나와 일치하는 파일(패턴을 선언하지 않은 경우에는 이름과 관계없이 단일 파일인 소스)로서, 바이트가 해당 구문으로 파싱되고 파싱된 트리가 모든 술어를 충족하는 파일과 일치합니다. 디렉터리의 경우, 패턴이 선택하는 디렉터리 파일 중 하나와 일치하면 그 디렉터리와 일치하므로, 패턴을 선언하지 않은 시그니처는 어떤 디렉터리와도 일치하지 않습니다.

속성타입필수설명
syntaxstring예소스를 파싱하는 구문 형식(예: json 또는 yaml)으로, 파서 플러그인이 parse:로 알리는 형식입니다. 호스트는 워크스페이스 카탈로그가 해당 구문에 제공하는 파서로, 또는 카탈로그가 제공하지 않는 구문이면 컴파일러에 내장된 파서로 소스를 파싱하며, 그 구문을 지정하는 시그니처가 몇 개이든 최대 한 번만 파싱합니다. 해당 구문으로 파싱되지 않는 소스는 그 구문을 지정하는 어떤 시그니처와도 일치하지 않습니다. 둘 다 파서를 제공하지 않는 구문은 건너뛰지 않고, 해당 파서가 없음을 명시하며 인식을 중단합니다. 최소 1자 이상입니다.
filesstring[]아니요시그니처가 적용되는 파일 이름 패턴으로, 구분자를 슬래시로 읽은 소스 이름의 끝부분과 대조됩니다. 세그먼트가 하나인 패턴은 파일 자체의 이름과 대조되고, 슬래시로 구분된 여러 세그먼트의 패턴은 경로의 같은 수의 끝 세그먼트와 대조되므로, .vscode/mcp.json은 .vscode라는 디렉터리에 있는 mcp.json이라는 파일과 일치합니다. 세그먼트 안에서 *는 임의의 문자열과, ?는 한 문자와, […]는 클래스의 한 문자와 일치합니다. 패턴 중 하나라도 일치하면 시그니처가 적용됩니다. 올바른 형식이 아닌 패턴은 로드 시 거부됩니다. 없거나 비어 있으면 이름과 관계없이 단일 파일인 소스에 시그니처를 적용하고, 디렉터리의 파일에는 적용하지 않습니다. 임포터 시그니처의 패턴은 가져오기가 디렉터리의 어떤 파일을 임포터에 전달할지도 결정합니다.
matchPathMatch[]아니요파싱된 트리가 선언된 순서대로 모두 충족해야 하는 술어입니다. 없거나 비어 있으면 해당 구문으로 파싱되는 것 외에 트리에 아무것도 요구하지 않습니다.

추가 속성은 허용되지 않습니다.

PathMatch

파싱된 트리에 대한 하나의 술어로, 경로가 도달하는 값, 그 값이 가져야 하는 종류, 그리고 선택적으로 값이 같아야 하거나 시작해야 하는 문자열로 이루어집니다.

속성타입필수설명
pathstring예술어가 트리에서 살펴보는 위치로, 트리 최상위부터 점으로 연결한 키로 씁니다. data.nodes는 최상위 data 객체의 nodes 멤버를 가리킵니다. 0 이상의 정수로 쓴 세그먼트는 0부터 세는 배열의 해당 위치를 선택하므로 nodes.0.type은 첫 번째 노드의 type을 가리키며, 그 밖의 세그먼트는 객체의 멤버를 선택합니다. 점을 포함하는 키는 지정할 수 없습니다. 최소 1자 이상입니다.
isstring (enum)예경로가 도달해야 하는 대상입니다. present는 null을 포함해 어떤 종류의 값에든 도달하면 성립하고, absent는 아무것에도 도달하지 않으면 성립하며, object, array, string, number, boolean은 각각 해당 종류의 값에 도달하면 성립합니다. 허용되는 값: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstring아니요경로가 도달하는 값이 정확히 같아야 하는 문자열입니다. 문자열이 아닌 값은 이와 절대 같지 않습니다. 하나의 술어에는 equals와 prefix 중 최대 하나만 선언되며, 둘 다 선언한 술어는 로드 시 거부됩니다. 최소 1자 이상입니다.
prefixstring아니요경로가 도달하는 값이 시작해야 하는 문자열입니다. 문자열이 아닌 값은 이 문자열로 절대 시작하지 않습니다. 하나의 술어에는 equals와 prefix 중 최대 하나만 선언되며, 둘 다 선언한 술어는 로드 시 거부됩니다. 최소 1자 이상입니다.

추가 속성은 허용되지 않습니다.