Skip to main content

library_annotations

Learn about the library_annotations linter rule.

Stable
Core
Fix available

Attach library annotations to library directives.

Details

#

Attach library annotations to library directives, rather than some other library-level element.

BAD:

dart
@TestOn('browser')  import 'package:test/test.dart';  void main() {} 

GOOD:

dart
@TestOn('browser') library;  import 'package:test/test.dart';  void main() {} 

NOTE: An unnamed library, like library; above, is only supported in Dart 2.19 and later. Code which might run in earlier versions of Dart will need to provide a name in the library directive.

Enable

#

To enable the library_annotations rule, add library_annotations under linter > rules in your analysis_options.yaml file:

analysis_options.yaml
yaml
linter:  rules:  - library_annotations 

If you're instead using the YAML map syntax to configure linter rules, add library_annotations: true under linter > rules:

analysis_options.yaml
yaml
linter:  rules:  library_annotations: true