prefer_asserts_with_message
Prefer asserts with message.
This rule is available as of Dart 2.3.
Details
#When assertions fail it's not always simple to understand why. Adding a message to the assert
helps the developer to understand why the AssertionError occurs.
BAD:
dart
f(a) {
assert(a != null);
}
class A {
A(a) : assert(a != null);
}
GOOD:
dart
f(a) {
assert(a != null, 'a must not be null');
}
class A {
A(a) : assert(a != null, 'a must not be null');
}
Usage
#To enable the prefer_asserts_with_message
rule, add prefer_asserts_with_message
under linter > rules in your analysis_options.yaml
file:
analysis_options.yaml
yaml
linter:
rules:
- prefer_asserts_with_message
Unless stated otherwise, the documentation on this site reflects Dart 3.5.3. Page last updated on 2024-07-03. View source or report an issue.