dart-sdk/pkg/dartdev/doc/dart-fix.md
Jeffrey Swan fed6cadf77 fix(docs): corrects common typos in project documentation
Scope of changes is restricted to markdown docs only. Changes made in agreement with Standard American English.

Closes https://github.com/dart-lang/sdk/pull/45818
https://github.com/dart-lang/sdk/pull/45818

TEST=Manual review of the changed markdown files.

GitOrigin-RevId: 6df9128b46e4e51e634baf534c0169f62bc6a67e
Change-Id: I7b67dcb5a6e0a03db2b6eea24ace8dee207c4a11
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/196742
Reviewed-by: Bob Nystrom <rnystrom@google.com>
2021-05-18 15:48:18 +00:00

1.5 KiB

dart fix

What is it?

dart fix is a command line tool and part of the regular dart tool. It is used to batch apply fixes for analysis issues.

How does it work?

dart fix runs over your project looking for analysis issues. For each issue it checks whether there is an automated fix that can be applied. These fixes are generally either in response to a lint or hint in your code, or part of upgrading your source to newer package APIs.

For the first type of change, the fixes are generally in response to the set of lints and analysis configuration specified in your analysis_options.yaml file.

The second type of change - upgrading to newer package APIs - is performed based on API changes defined for specific packages. This declarative definition of the API changes lives in a fix_data.yaml file in the package's lib/ directory (documentation forthcoming).

Command line usage

Apply automated fixes to Dart source code.

This tool looks for and fixes analysis issues that have associated automated fixes.

To use the tool, run either 'dart fix --dry-run' for a preview of the proposed changes for a project, or 'dart fix --apply' to
apply the changes.

Usage: dart fix [arguments]
-h, --help       Print this usage information.
-n, --dry-run    Preview the proposed changes but make no changes.
    --apply      Apply the proposed changes.

Run "dart help" to see global options.