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

Aggrega Wasm 린터 소켓 스키마

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

스키마 ID: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json

린터 소켓이 받아들이는(LinterInput) 와이어 형태와 내보내는(LinterOutput) 와이어 형태입니다. 린터는 게시 시점에 이전 버전과 제안된 버전으로 이루어진 엔터티 쌍을 대상으로 실행되고(스키마 진화 규칙), 워크스페이스 린트 시점에는 개별 엔터티를 대상으로 실행됩니다(규칙별 구조 규칙). 배포되는 하나의 Wasm 플러그인이 여러 규칙을 호스팅하며, 플러그인은 LinterInput.rule_id로 실행할 규칙을 선택합니다. 이 스키마는 두 와이어 형태의 유일한 원천입니다. Go, Rust, TypeScript 페이로드 타입은 이 스키마로부터 공유 플러그인 ABI 패키지에 생성되며, 각 플러그인 키트는 자체 사본을 선언하지 않고 생성된 타입을 다시 내보냅니다.

다음 형태 중 하나

  • LinterInput
  • LinterOutput

정의

LinterInput

호스트가 호출될 때마다 publishing-linter 플러그인에 전달하는 페이로드입니다. rule_id는 플러그인이 디스패치할 규칙을 선택합니다. entity_kind는 린트 대상 엔터티 종류(Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate)를 식별합니다. proposed는 분류 대상 엔터티의 파싱된 구조를 담습니다(호스트는 전송 전에 YAML을 JSON으로 파싱하므로 플러그인은 원시 바이트를 보지 않습니다). previous는 schema-evolution 규칙을 위한 이전 버전 엔터티의 파싱된 구조를 담으며, 해당하지 않으면 생략됩니다. implemented_component는 다른 종류의 관련 엔터티, 즉 린트 대상 Recipe가 실현하는 Component를 담으며, 한 엔터티를 다른 엔터티가 선언한 계약과 비교하는 규칙에 사용됩니다. 해당하지 않으면 생략됩니다. release와 components는 Release 전체를 읽는 규칙을 위해 Release의 나머지 부분을 담습니다. 이때 proposed는 해당 Release가 배포하는 Aggregate이고, release는 그 Release이며, components는 Aggregate의 각 component 인스턴스가 인스턴스로 삼는 Component입니다. 그 밖의 모든 입력에서는 둘 다 생략됩니다. policies는 규칙이 참조하는 워크스페이스별 게시 규율 구성을 담습니다.

속성타입필수설명
rule_idstring예플러그인이 디스패치해야 하는 규칙으로, 규칙 id로 지정합니다. 이는 결과 finding이 rule_id에 담는 것과 같은 kebab-case 식별자이므로, 억제되거나 보고된 규칙은 모든 곳에서 같은 이름으로 지정됩니다. 인식되는 집합은 배포된 플러그인이 디스패치하는 규칙입니다. 플러그인이 인식하지 못하는 규칙 id는 조용히 통과하지 않고 ‘unknown_rule’ finding을 생성합니다.
entity_kindstring (enum)예proposed/previous 값이 인코딩하는 엔터티 종류입니다. schema-evolution 규칙의 분류는 종류마다 다르며, 구조적 규칙은 특정 종류에만 적용됩니다. 허용 값: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobject예분류 대상 엔터티의 파싱된 구조입니다. 호스트가 전송 전에 YAML을 JSON으로 변환하므로, 플러그인은 이미 구조화된 값을 받으며 원시 바이트를 보지 않습니다. Release 전체를 읽는 규칙의 입력에서는 해당 Release가 배포하는 Aggregate입니다. 모든 입력에서 엔터티를 전달하기 전에 모든 parameter 값이 제거됩니다. parameter의 값이 자격 증명 자체일 수 있으므로, 어떤 parameter 값도 이 필드를 통해 linter 플러그인에 도달하지 않습니다. Aggregate는 spec.parameters 선언을 유지하되, 각 선언은 Aggregate 스키마가 parameter 선언에 허용하는 키 중 default를 제외한 키만 가지며, properties, items, valuesType 아래에 중첩된 모든 선언에도 같은 기준이 적용됩니다. default는 대체되지 않고 제거되므로 플러그인은 선언이 default를 지정하는지 알 수 없으며, 스키마가 그 위치에 허용하지 않는 키는 담고 있는 내용과 함께 제거됩니다. spec.aggregates 아래 각 모듈의 parameters 블록은 해당 모듈에 전달되는 값을 담으므로 통째로 제거되며, 다른 종류의 엔터티에 있는 spec.parameters도 마찬가지입니다. parameter를 읽는 템플릿 텍스트는 작성된 그대로 유지됩니다.
previousobject아니요쌍별 비교를 수행하는 규칙(schema-evolution)을 위한 이전 버전 엔터티의 파싱된 구조이며, parameter 값은 proposed에서와 똑같이 제거됩니다. 규칙에 이전 버전 참조가 필요하지 않으면(예: 최초 게시, 구조 전용 규칙) 생략됩니다.
implemented_componentobject아니요린트 대상 Recipe가 spec.implements에 지정한 Component의 파싱된 구조로, 호스트가 해석합니다. 이는 린트 대상과 다른 종류의 관련 엔터티이며, 이 점이 previous와 구별됩니다. previous는 같은 엔터티의 다른 버전을 담고, 이 필드는 Recipe가 실현하는 출력 계약을 선언한 Component를 담습니다. 호스트는 빌드가 사용하는 것과 같은 카탈로그 조회를 Component의 이름을 키로 사용하여 해석하므로, spec.implements가 허용하는 세 가지 고정 형식(버전 없음, 정확한 버전, 메이저 호환 범위)이 모두 같은 항목에 도달합니다. 린트 대상 엔터티가 Recipe가 아니거나, Component를 지정하지 않거나, 워크스페이스의 카탈로그 디렉터리에서 해당 이름의 Component에 도달할 수 없으면 생략됩니다. 값이 없다는 것은 계약이 비어 있다는 뜻이 아니라 비교를 할 수 없다는 뜻입니다. 이 필드를 읽는 규칙은 값이 없으면 finding을 내보내지 않습니다.
releaseobject아니요release 범위 린트가 지정하는 Release의 파싱된 구조로, extends 체인이 병합되어 있으므로 자식 Release는 기반에서 상속한 내용을 담습니다. 호스트는 proposed와 마찬가지로 이를 YAML에서 JSON으로 변환합니다. spec.parameters 블록은 Aggregate의 parameters를 충족하는 값을 담으므로, Release를 전달하기 전에 통째로 제거됩니다. parameter의 값이 자격 증명 자체일 수 있고, 어떤 규칙도 이 블록을 읽지 않으므로, 어떤 parameter 값도 이 필드를 통해 linter 플러그인에 도달하지 않습니다. Release 전체를 읽는 규칙의 입력에만 존재하며, 이때 proposed는 이 Release가 배포하는 Aggregate이고 parameter 값은 proposed에서 설명한 대로 제거됩니다. 그 밖의 모든 입력에서는 생략됩니다.
componentsobject 맵아니요Aggregate의 각 component 인스턴스가 인스턴스로 삼는 Component로, Aggregate가 부여한 인스턴스 이름을 키로 사용합니다. 이는 Aggregate와 Release 자체의 components 맵이 사용하는 것과 같은 키입니다. 각 값은 인스턴스의 type이 해석되는 Component이며, extends 체인이 있으면 병합되고, implemented_component와 마찬가지로 JSON으로 변환됩니다. 워크스페이스의 카탈로그 디렉터리에서 Component에 도달할 수 없는 인스턴스는 없으며, 규칙은 그 부재를 아무것도 선언하지 않은 Component가 아니라 사용할 수 없음으로 해석합니다. Release 전체를 읽는 규칙의 입력에서 release와 함께만 존재하며, 그 밖의 모든 입력에서는 생략됩니다.
source_pathstring아니요엔터티를 로드한 파일 시스템 경로입니다. 카탈로그 파일 시스템을 탐색하는 호스트 호출자가 채우며, 경로를 인식하는 규칙(예: category-matches-directory)이 사용합니다. 호출자에게 경로 컨텍스트가 없으면 생략됩니다.
policiesPolicies아니요규칙이 참조하는 워크스페이스별 게시 규율 구성으로, 호스트가 워크스페이스 구성과 명령줄 재정의로부터 조립한 Policies 객체로 전달됩니다.

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

LinterOutput

publishing-linter 플러그인이 내보내는 응답 형태입니다. findings는 결과를 생성한 규칙 호출마다 하나의 항목을 담습니다. schema-evolution 규칙은 정확히 하나의 finding(분류 판정)을 내보내며, 구조적 규칙은 0개(위반 없음) 또는 여러 개(위반마다 하나)를 내보낼 수 있습니다.

속성타입필수설명
findingsDiagnostic[]예플러그인 호출이 생성한 규칙별 finding으로, 플러그인이 내보낸 순서를 따릅니다.
errorstring아니요게스트가 실행되었지만 작업을 완료하지 못했을 때 설정되는 실패 메시지이며, 성공 시에는 없습니다. 출력이 담는 진단과는 구별됩니다. 진단은 결과를 생성한 실행 중에 발견된 문제를 보고하는 반면, error는 작업 자체가 완료되지 않았음을 보고합니다. 호스트는 error가 있으면 플러그인 호출 실패로 표시합니다.

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

Policies

규칙 집합이 참조하는 워크스페이스별 게시 규율 구성으로, 호스트가 워크스페이스 구성의 게시 규율 설정과 명령줄 재정의를 바탕으로 조립합니다. 이 스키마가 그 형태에 대한 계약입니다. 필드를 생략하면 각 플래그는 false가 기본값이 되며, 호스트는 값이 기본값이 아닌 필드만 기록합니다.

속성타입필수설명
allow_dynamic_refs불리언아니요true이면 SchemaLibrary 항목에서 $dynamicAnchor / $dynamicRef 사용이 허용됩니다(dynamic-refs 규칙을 억제합니다). 기본값은 false입니다.
allow_id_overrides불리언아니요true이면 SchemaLibrary 항목에서 $id 재정의가 허용됩니다(id-overrides 규칙을 억제합니다). 기본값은 false입니다.
allow_direct_x_aggrega_extensions불리언아니요true이면 x-aggrega-selector / x-aggrega-inject를 직접 작성하는 것이 허용됩니다(x-aggrega-discouragement 규칙을 억제합니다). 기본값은 false입니다.
allow_aggrega_ai_prefix불리언아니요true이면 annotation-prefix 규칙 전체가 억제됩니다(단독 aggrega.ai/ 검사와 종류에 따른 feature.aggrega.ai/ 검사 모두). 기본값은 false입니다.
allow_nonstandard_names불리언아니요true이면 name-shape 위반이 허용됩니다(name-shape 규칙을 억제합니다). 기본값은 false입니다.
allow_category_mismatches불리언아니요true이면 category-matches-directory 규칙의 결과를 억제합니다. 표준 카탈로그 관례는 core// 아래의 Components가 디렉터리 세그먼트와 일치하는 component.aggrega.ai/category={category}를 선언하도록 요구하며, 여기서 {category}는 닫힌 집합의 15개 값 중 하나입니다. 정당하고 지속적인 예외가 있는 워크스페이스는 여기서 옵트아웃합니다. 기본값은 false입니다.
allow_undeclared_recipe_provides불리언아니요true이면 provides-declared-by-component 규칙의 결과를 억제합니다. 이 규칙은 Recipe가 spec.provides에서 게시하는 키 중 해당 spec.implements가 지정하는 Component가 spec.schema의 provides 축에 선언하지 않은 각 키를 보고합니다. 선언된 계약을 넘어서는 게시는 빌드 시점에 허용되므로 이 결과는 권고 사항입니다. Recipes가 의도적으로 Component가 선언하지 않은 키를 게시하는 워크스페이스는 여기서 옵트아웃합니다. 기본값은 false입니다.
allow_connection_credential_mismatches불리언아니요true이면 connection-credential-matches-target-key 규칙의 결과를 억제합니다. 이 규칙은 Release 전체를 읽고, 대상이 호출자에게 요구하는 키를 선언한 각 연결에 대해 연결이 제시하는 자격 증명을 대상이 보유한 키와 비교합니다. 두 끝이 서로 다른 시크릿을 지정하는 경우와 한쪽 끝에서만 키가 선언된 경우를 보고합니다. 두 끝의 일치는 빌드가 검사하는 것이 아니라 카탈로그 관례이므로 이 결과는 권고 사항입니다. 두 끝이 의도적으로 다른 워크스페이스는 여기서 옵트아웃합니다. 기본값은 false입니다.

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