This package serves three purposes:
Note that everything here fits within the guidelines set out in Effective Dart. You could think of that document as the design and this package as one possible partial implementation.
Here is how static analysis is used internally at Google:
TODOhint is a permanent exception.
The currently enabled lints can be found in analysis_options.1.7.0.yaml.
To use the lints add a dependency in your
# If you use `package:pedantic/pedantic.dart`, add a normal dependency. dependencies: pedantic: '1.7.0' # Or, if you just want `analysis_options.yaml`, it can be a dev dependency. dev_dependencies: pedantic: '1.7.0'
then, add an include in your
analysis_options.yaml. If you want to always use the latest version of the lints, add a dependency on the main
If your continuous build and/or presubmit check lints then they will likely fail whenever a new version of
package:pedantic is released. To avoid this, specify a specific version of
The following lints have been considered and will not be enforced:
always_put_control_body_on_new_line violates Effective Dart “DO format your code using dartfmt”. See note about Flutter SDK style below.
always_specify_types violates Effective Dart “AVOID type annotating initialized local variables” and others. See note about Flutter SDK style below.
avoid_as does not reflect standard usage. See note about Flutter SDK style below.
control_flow_in_finally does not offer enough value: people are unlikely to do this by accident, and there are occasional valid uses.
empty_statements is superfluous, enforcing use of
dartfmt is sufficient to make empty statements obvious.
prefer_bool_in_asserts is obsolete in Dart 2; bool is required in asserts.
prefer_final_locals does not reflect standard usage.
throw_in_finally does not offer enough value: people are unlikely to do this by accident, and there are occasional valid uses.
Note on Flutter SDK Style: some lints were created specifically to support Flutter SDK development. Flutter app developers should instead use standard Dart style as described in Effective Dart, and should not use these lints.
Please file feature requests and bugs at the issue tracker.