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

Aggrega Wasm 플러그인 공유 진단 스키마

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

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

모든 Wasm 소켓이 공유하는 단일 진단 형태입니다. 플러그인은 제기하는 문제마다 항목 하나를 보고하고, 호스트가 이를 표시합니다. 이 형태는 상위 집합입니다. 각 소켓은 사용하는 부분 집합만 채우고 나머지는 생략하므로, 어느 소켓에서 나온 진단이든 하나의 균일한 구조를 갖습니다. severity는 모든 소켓이 공유하는 세 값(halt, warn, info) 중 하나이므로, 진단은 어느 소켓이 제기했든 같은 의미를 갖습니다.

최상위 타입: object

정의

Diagnostic

진단 발행자가 제기한 하나의 문제입니다. 심각도, 사람이 읽을 수 있는 메시지, 선택적 위치, 그리고 발행자별 선택적 필드로 구성됩니다. 발행자는 Wasm 플러그인 소켓이거나 컴파일러 자체이며, 둘 다 이 하나의 형태로 보고하므로 읽는 쪽은 누가 제기했든 항목을 같은 방식으로 해석합니다. 각 발행자는 사용하는 부분 집합만 채우고 나머지는 생략합니다. 파서는 location span을 설정하고, import는 code와 source_ref를 설정하며, 게시 린터는 rule_id와 classification을 설정합니다. 거버넌스 판정은 빌드 결과를 나타내는 severity와 message를 설정하고 code, rule_id, classification, source_ref, location, suggest 중 어느 것이든 추가할 수 있으며, 렌더 권고는 code, source_ref, 구조화된 location을 설정합니다.

속성타입필수설명
severitystring (enum)예진단의 심각도로, 모든 소켓이 공유하는 하나의 닫힌 집합에서 가져옵니다. halt는 빌드를 중단하고 수정할 대상을 명시합니다. warn은 여전히 완료되는 빌드와 함께 표시됩니다. info는 관찰 내용을 기록하며 빌드 결과는 바꾸지 않습니다. 모든 발행자가 이 하나의 집합으로 보고하므로, 읽는 쪽은 누가 제기했든 심각도를 같은 방식으로 해석합니다. 허용 값: "halt", "warn", "info"
messagestring예사람이 읽을 수 있는 진단 텍스트입니다.
codestring아니요사람이 읽을 수 있는 메시지와 독립적인, 진단에 대한 선택적이고 안정적이며 기계가 대조할 수 있는 코드입니다. 발행자가 코드를 할당하지 않으면 없습니다. 코드는 플러그인 소켓에서 오거나, 제기하는 모든 항목에 코드를 설정하는 컴파일러 자체의 권고에서 올 수 있습니다.
rule_idstring아니요발행자가 규칙 기반(게시 린터)일 때 진단을 생성한 규칙의 식별자입니다. 그 외에는 없습니다.
classificationstring (enum)아니요발행하는 규칙이 분류를 할당할 때(스키마 진화 규칙) 진단이 갖는 시맨틱 버전 영향 분류입니다. 분류가 없는 진단에는 없습니다. 허용 값: "PATCH", "MINOR", "MAJOR"
source_refstring아니요진단이 관련된 소스 요소에 대한 불투명 참조입니다(예: import가 해석하지 못한 소스 노드의 식별자). 진단이 특정 소스 요소를 참조하지 않으면 없습니다.
locationLocation아니요발행자가 문제의 위치를 찾을 수 있을 때 진단이 가리키는 위치입니다. 파서는 바이트 범위를 채우고, 렌더러는 소스 문서 내의 구조화된 위치를 채웁니다. 진단에 위치가 없으면 없습니다.
suggeststring아니요발행자가 진단과 함께 제공하는 선택적 해결 힌트입니다. 힌트가 제공되지 않으면 없습니다.

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

Location

진단이 가리키는 위치입니다. 원시 소스 텍스트 내의 바이트 단위로 정확한 위치(파서가 span을 채움)와 소스 문서 내의 구조화된 위치(렌더러가 key_path, uri, line, kind를 채움)를 모두 담는 하나의 통합 로케이터를 가지며, 해당하는 것이 있으면 진단이 관련된 빌드의 인스턴스를 명시합니다(instance). 모든 필드는 선택 사항이며, 소켓은 생성할 수 있는 표현을 채우고 나머지는 생략합니다.

속성타입필수설명
spanSpan아니요발행자가 소스를 파싱하고 문제를 바이트 범위로 특정할 수 있을 때(파서) 진단이 가리키는 원시 소스 바이트의 범위입니다. 그 외에는 없습니다.
key_pathstring아니요발행자가 문제를 구조적으로 찾을 때(렌더러) 구조화된 소스 문서 내에서 문제가 되는 요소에 대한 점으로 구분된 경로입니다. 그 외에는 없습니다.
uristring아니요발행자가 알고 있을 때(렌더러) 진단이 관련된 소스 아티팩트의 식별자입니다. 그 외에는 없습니다. 빌드의 인스턴스를 가리키는 일은 없으며, 그것은 instance가 담습니다.
lineinteger아니요구조화된 소스 문서 내의 줄 번호로, span이 갖는 원시 바이트 기준의 줄 및 열과는 다릅니다. 발행자가 문서 줄을 알고 있을 때(렌더러) 존재합니다. 그 외에는 없습니다.
kindstring아니요발행자가 표면을 구분할 때(렌더러) 위치가 가리키는 소스 표면을 지칭하는 개방형 문자열입니다. 그 외에는 없습니다.
instancestring아니요진단이 관련된 빌드의 인스턴스로, 빌드가 부여하는 식별자로 나타냅니다. 컴포넌트는 Aggregate가 선언한 이름으로, 모듈이 기여하는 컴포넌트는 모듈을 거쳐 점으로 구분된 경로로, 빌드가 도출하는 컴포넌트는 빌드가 그것을 위해 조합한 식별자로, 모듈은 자체 경로로 나타냅니다. 진단이 하나의 인스턴스에 관한 것일 때 존재하며, 그 외에는 없습니다.

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

Span

원본 소스 바이트의 범위입니다. 바이트 오프셋이 기본이자 정확한 위치이며, 줄 번호와 열 번호는 사람이 읽을 수 있는 진단을 위해 함께 제공됩니다.

속성타입필수설명
start_offsetinteger예원본 소스에서 범위의 첫 바이트의 바이트 오프셋으로, 0부터 시작합니다.
end_offsetinteger예원본 소스에서 범위의 마지막 바이트 바로 다음의 바이트 오프셋으로, end_offset에서 start_offset을 뺀 값이 범위의 바이트 길이입니다.
start_lineinteger예사람이 읽을 수 있는 진단을 위한, 범위 시작의 줄 번호로, 1부터 시작합니다.
start_columninteger예사람이 읽을 수 있는 진단을 위한, 범위 시작의 열 번호로, 1부터 시작합니다.
end_lineinteger예사람이 읽을 수 있는 진단을 위한, 범위 끝의 줄 번호로, 1부터 시작합니다.
end_columninteger예사람이 읽을 수 있는 진단을 위한, 범위 끝의 열 번호로, 1부터 시작합니다.

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