dart fix linter-rules

[stephane-archer]

Is there a way to do:

dart fix prefer_final_locals

because I wouldn't code with this linter on, but I would definitely run this before committing my code

[FMorschel]

dart fix has a help arg (dart fix -h or dart fix --help:

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.
    --code=<code1,code2,...>    Apply fixes for one (or more) diagnostic codes.

Run "dart help" to see global options.

And if you run dart fix --dry-run (or dart fix -n) on your code, it should show you all codes it has fixes to, at the end (some dummy project with some errors so you can see):

Computing fixes in bug (dry run)...

4 proposed fixes in 2 files.

lib\inline\inline.dart
  omit_local_variable_types • 1 fix
  prefer_final_locals • 1 fix

lib\new.dart
  prefer_final_locals • 1 fix
  prefer_relative_imports • 1 fix

To fix an individual diagnostic, run one of:
  dart fix --apply --code=omit_local_variable_types 
  dart fix --apply --code=prefer_final_locals 
  dart fix --apply --code=prefer_relative_imports 

To fix all diagnostics, run:
  dart fix --apply 

So basically, yes, run dart fix --apply --code=prefer_final_locals and it should do what you want.

[FMorschel]

But I think you must have it as a rule in analysis_options.yaml. Am I right @srawlins /@bwilkerson?

[srawlins]

But I think you must have it as a rule in analysis_options.yaml. Am I right @srawlins /@bwilkerson?

Hmm, I think that's true.

[bwilkerson]

I don't remember. I thought we had added that affordance so that (at least in part) users could see whether or not they wanted to enable a rule. I'd be surprised if you have to enable the rule first, as any enabled lint rules would automatically be fixes without needing a command-line argument. But it's been a long time, so my memory might be faulty or outdated.

[stephane-archer]

$ dart fix --apply --code=prefer_final_locals 
Computing fixes in Lutme...    4.2s
Nothing to fix!
$ echo add prefer_final_locals to analysis_options.yaml
$ dart fix --apply --code=prefer_final_locals
Computing fixes in Lutme...    8.1s
Applying fixes...                      0.0s

lib/exposure_analysis_widget.dart
  prefer_final_locals • 8 fixes

lib/get_lut_folders.dart
  prefer_final_locals • 7 fixes

lib/lut_preview_images_change_notifier.dart
  prefer_final_locals • 1 fix

lib/my_navigation_rail_button_section.dart
  prefer_final_locals • 1 fix

lib/my_tree_indentation_row.dart
  prefer_final_locals • 2 fixes

lib/persistent_imported_lut_folders.dart
  prefer_final_locals • 2 fixes

test/get_lut_folders_test.dart
  prefer_final_locals • 3 fixes

test/persistent_imported_lut_folders_test.dart
  prefer_final_locals • 1 fix

25 fixes made in 8 files.

it would be great if it could be done without having to edit analysis_options.yaml

[FMorschel]

A request somewhat similar to this one, but with a different approach, has just been opened:

• Allow specifying a custom analysis_options.yaml file via command line arguments #61581