이 페이지에서는 Starlark의 기본 스타일 가이드라인을 설명하고 매크로와 규칙에 관한 정보도 제공합니다.
Starlark는 소프트웨어 빌드 방법을 정의하는 언어이므로 프로그래밍 언어이자 구성 언어입니다.
Starlark를 사용하여 BUILD 파일, 매크로, 빌드 규칙을 작성합니다. 매크로와 규칙은 기본적으로 메타 언어이며 BUILD 파일의 작성 방법을 정의합니다.
BUILD 파일은 단순하고 반복적이어야 합니다.
모든 소프트웨어는 작성된 것보다 더 자주 읽힙니다. 엔지니어가 BUILD 파일을 읽고 타겟의 종속 항목과 빌드 세부정보를 파악하므로 Starlark의 경우에 특히 그렇습니다. 이러한 읽기는 보통 지나가는 데, 서두르거나 다른 작업을 하는 것과 동시에 발생합니다. 따라서 사용자가 BUILD 파일을 빠르게 파싱하고 이해할 수 있으려면 단순성과 가독성이 매우 중요합니다.
사용자가 BUILD 파일을 열 때 파일의 타겟 목록을 확인하거나 C++ 라이브러리의 소스 목록을 검토하거나 자바 바이너리에서 종속 항목을 삭제하고자 할 수 있습니다. 추상화 레이어를 추가할 때마다 사용자가 이러한 작업을 수행하기가 더 어려워집니다.
BUILD 파일도 다양한 도구를 통해 분석 및 업데이트됩니다. 추상화를 사용하는 경우 도구에서 BUILD 파일을 수정하지 못할 수 있습니다. BUILD 파일을 단순하게 유지하면 도구를 개선할 수 있습니다. 코드베이스가 커질수록 라이브러리를 업데이트하거나 정리하기 위해 많은 BUILD 파일을 변경하는 빈도가 점점 더 늘어나게 됩니다.
일반 도움말
- Buildifier를 형식 지정 도구 및 린터로 사용합니다.
- 테스트 가이드라인을 따릅니다.
스타일
Python 스타일
의심스러운 경우 가능하면 PEP 8 스타일 가이드를 따르세요. 특히 들여쓰기에 공백 2개가 아닌 4개를 사용하여 Python 규칙을 따르세요.
Starlark는 Python이 아니므로 Python 스타일의 일부 요소가 적용되지 않습니다. 예를 들어 PEP 8은 싱글톤과 비교하려면 Starlark의 연산자가 아닌 is를 사용하도록 권장합니다.
문서 문자열
docstring을 사용하여 파일과 함수를 문서화합니다.
각 .bzl 파일의 맨 위에 docstring을 사용하고 각 공개 함수에 docstring을 사용합니다.
규칙 및 관점 문서화
규칙 및 관점, 속성, 제공자 및 필드는 doc 인수를 사용하여 문서화해야 합니다.
이름 지정 규칙
- 변수 및 함수 이름은 소문자를 사용하고 밑줄(
[a-z][a-z0-9_]*)로 구분된 단어(예:cc_library)를 사용합니다. - 최상위 비공개 값은 밑줄 1개로 시작합니다. Bazel은 비공개 값을 다른 파일에서 사용할 수 없도록 적용합니다. 로컬 변수에는 밑줄 프리픽스를 사용해서는 안 됩니다.
행 길이
BUILD 파일과 마찬가지로 라벨이 길 수 있으므로 엄격한 줄 길이 제한이 없습니다.
Python 스타일 가이드 PEP 8에 따라 가능하면 한 줄당 최대 79자 (영문 기준)를 사용하세요. 이 가이드라인을 엄격하게 적용해서는 안 됩니다. 편집자는 열을 80개 넘게 표시해야 하고, 자동 변경으로 인해 행이 더 길어지는 경우가 자주 발생하며, 사람이 이미 읽을 수 있는 줄을 분할하는 데 시간을 허비해서는 안 됩니다.
키워드 인수
키워드 인수에서는 등호 주변의 공백을 사용하는 것이 좋습니다.
def fct(name, srcs):
filtered_srcs = my_filter(source = srcs)
native.cc_library(
name = name,
srcs = filtered_srcs,
testonly = True,
)
불리언 값
불리언 값(예: 규칙에서 불리언 속성 사용)에 1 및 0 대신 True 및 False 값을 선호합니다.
디버깅에만 인쇄 사용
프로덕션 코드에서 print() 함수를 사용하지 마세요. 디버깅 용도로만 사용되며 .bzl 파일의 모든 직접 및 간접 사용자에게 스팸을 보낼 수 있습니다. 단, print()가 기본적으로 사용 중지되어 있고 소스를 수정해야만 사용 설정할 수 있는 경우(예: DEBUG가 False로 하드코딩된 if DEBUG:에 의해 모든 print() 사용이 보호되는 경우)를 사용하는 코드를 제출할 수 있다는 점만 예외입니다. 이러한 설명이 가독성에 미치는 영향을 정당화할 만큼 유용한지 고려해야 합니다.
매크로
매크로는 로드 단계에서 하나 이상의 규칙을 인스턴스화하는 함수입니다. 가능한 경우 매크로 대신 규칙을 사용합니다. 사용자가 보는 빌드 그래프는 빌드 중에 Bazel이 사용하는 그래프와 동일하지 않습니다. Bazel이 빌드 그래프 분석을 실행하기 전에 매크로가 확장됩니다.
그렇기 때문에 문제가 발생하면 사용자는 빌드 문제를 해결하기 위해 매크로의 구현을 이해해야 합니다. 또한 결과에 표시되는 타겟이 매크로 확장에서 비롯되기 때문에 bazel
query 결과를 해석하기 어려울 수 있습니다. 마지막으로, 측면은 매크로를 인식하지 않으므로 여러 측면 (IDE 및 기타)에 종속된 도구가 실패할 수 있습니다.
매크로를 안전하게 사용하는 것은 Bazel CLI 또는 BUILD 파일에서 직접 참조할 추가 대상을 정의하는 것입니다. 이 경우 해당 대상의 최종 사용자만 이에 대해 알아야 하며 매크로에 의해 발생하는 모든 빌드 문제는 사용과 크게 다르지 않습니다.
생성된 타겟을 정의하는 매크로 (CLI에서 참조되거나 해당 매크로에 의해 인스턴스화되지 않은 타겟에 종속되지 않아야 하는 매크로의 구현 세부정보)의 경우 다음 권장사항을 따르세요.
- 매크로는
name인수를 가져와서 이 이름으로 타겟을 정의해야 합니다. 이 타겟이 매크로의 기본 타겟이 됩니다. - 생성된 타겟, 즉 매크로에 의해 정의된 다른 모든 타겟은 다음을 충족해야 합니다.
- 이름의 접두어가
<name>또는_<name>여야 합니다. 예를 들어name = '%s_bar' % (name)를 사용합니다. - 공개 상태가 제한됨 (
//visibility:private) - 와일드 카드 타겟 (
:all,...,:*등)에서 확장을 방지하는manual태그가 있습니다.
- 이름의 접두어가
name은 매크로에서 정의한 타겟 이름을 파생하는 데만 사용해야 하며 다른 용도로는 사용하지 않아야 합니다. 예를 들어 이름을 사용하여 매크로 자체에 의해 생성되지 않은 종속 항목 또는 입력 파일을 파생해서는 안 됩니다.- 매크로에서 생성된 모든 타겟은 어떤 식으로든 기본 타겟에 결합되어야 합니다.
- 매크로의 매개변수 이름을 일관되게 유지합니다. 매개변수가 기본 타겟에 속성 값으로 전달되면 이름은 동일하게 유지해야 합니다. 매크로 매개변수가 일반 규칙 속성(예:
deps)과 동일한 용도로 사용되는 경우 속성의 이름과 동일한 역할을 합니다(아래 참고). - 매크로를 호출할 때는 키워드 인수만 사용합니다. 이렇게 하면 규칙과 일관되며 가독성이 크게 향상됩니다.
엔지니어는 규칙이 네이티브 코드에서 Bazel 내에서 정의되었는지 또는 Starlark에서 정의되었는지와 관계없이 관련 규칙의 Starlark API가 특정 사용 사례에 충분하지 않을 때 매크로를 작성하는 경우가 많습니다. 이 문제가 발생하면 규칙 작성자에게 API를 확장하여 목표를 달성할 수 있는지 문의하세요.
일반적으로 규칙과 유사한 매크로가 많을수록 좋습니다.
매크로를 참고하세요.
규칙
- 규칙, 관점, 속성에서는 case_case 이름 ('snake case')을 사용해야 합니다.
- 규칙 이름은 종속 항목 (리프 규칙의 경우 사용자)의 관점에서 규칙에 의해 생성되는 주요 아티팩트의 종류를 설명하는 명사입니다. 반드시 파일 서픽스를 사용해야 하는 것은 아닙니다. 예를 들어 Python 확장 프로그램으로 사용할 C++ 아티팩트를 생성하는 규칙을
py_extension라고 할 수 있습니다. 대부분의 언어의 일반적인 규칙은 다음과 같습니다.*_library- 컴파일 단위 또는 '모듈'.*_binary- 실행 파일 또는 배포 단위를 생성하는 대상입니다.*_test- 테스트 대상입니다. 여기에는 여러 테스트가 포함될 수 있습니다.*_test타겟의 모든 테스트는 동일한 테마의 변형일 것으로 예상됩니다(예: 단일 라이브러리 테스트).*_import:.jar또는 컴파일 중에 사용되는.dll와 같은 사전 컴파일된 아티팩트를 캡슐화하는 타겟입니다.
- 속성에 일관된 이름과 유형을 사용합니다. 일반적으로 적용 가능한 몇 가지 속성은 다음과 같습니다.
srcs:label_list. 파일: 일반적으로 사람이 작성한 소스 파일을 허용합니다.deps:label_list. 일반적으로 파일: 컴파일 종속 항목을 허용하지 않음.data:label_list, 테스트 데이터 등의 데이터 파일 허용runtime_deps:label_list: 컴파일에 필요하지 않은 런타임 종속 항목입니다.
- 명확하지 않은 동작이 있는 속성 (예: 특수 대체가 포함된 문자열 템플릿 또는 특정 요구사항으로 호출되는 도구)의 경우 속성 선언에
doc키워드 인수를 사용하는 문서 (attr.label_list()또는 이와 유사)를 제공하세요. - 규칙 구현 함수는 거의 항상 비공개 함수(선행 밑줄로 이름 지정)여야 합니다. 일반적인 스타일은
myrule의 구현 함수에_myrule_impl라는 이름을 지정하는 것입니다. - 잘 정의된 제공업체 인터페이스를 사용하여 규칙 간에 정보를 전달합니다. 제공자 필드를 선언하고 문서화합니다.
- 확장성을 염두에 두고 규칙을 설계합니다. 다른 규칙에서 규칙과 상호작용하고 제공자에 액세스하며 내가 만든 작업을 재사용하려고 할 수도 있다는 점을 고려하세요.
- 규칙의 실적 가이드라인을 따릅니다.