prefer_asserts_with_message: assert에는 메시지를 함께 작성하세요
prefer_asserts_with_message: assert에는 메시지를 함께 작성하세요
assert를 쓸 때 메시지도 함께 넣도록 안내하는 린트 규칙이에요. 검증이 실패했을 때 개발자가 이유를 금방 파악할 수 있게 도와줘요.
본문
설명
assert에는 메시지를 함께 넣으세요 (DO). assert가 실패했을 때 왜 실패했는지 항상 금방 이해할 수 있는 건 아니에요. 그런데 assert에 메시지를 추가해 두면, 개발자가 AssertionError가 왜 발생했는지 훨씬 쉽게 파악할 수 있어요.
BAD:
f(a) {
assert(a != null);
}
class A {
A(a) : assert(a != null);
}
GOOD:
f(a) {
assert(a != null, 'a must not be null');
}
class A {
A(a) : assert(a != null, 'a must not be null');
}
활성화 방법
prefer_asserts_with_message 규칙을 쓰려면 analysis_options.yaml 파일의 linter > rules 아래에 규칙을 추가하면 돼요.
linter:
rules:
- prefer_asserts_with_message
대신 YAML 맵(map) 문법으로 린터 규칙을 설정한다면, linter > rules 아래에 prefer_asserts_with_message: true를 추가해요.
linter:
rules:
prefer_asserts_with_message: true