tree: bf365248962956e4e60c54e1c26df93a5f20d46e [path history] [tgz]
  1. fix_material/
  2. fix_widgets/
  3. fix_cupertino.yaml
  4. fix_gestures.yaml
  5. fix_rendering.yaml
  6. fix_services.yaml
  7. fix_template.yaml
  8. README.md
packages/flutter/lib/fix_data/README.md

Directory contents

The .yaml files in these directories are used to define the dart fix framework refactorings used by the Flutter framework.

The number of fix rules defined in a file should not exceed 50 for better maintainability. Searching for title: is a given .yaml file will account for the number of fixes. Splitting out fix rules should be done by class.

When adding a new .yaml file, make a copy of fix_template.yaml. If the new file is not for generic library fixes (fix_material.yaml), ensure it is enclosed in an appropriate library directory (fix_data/fix_material), and named after the class. Fix files outside of generic libraries should represent individual classes (fix_data/fix_material/fix_app_bar.yaml).

See the flutter/packages/flutter/test_fixes directory for the tests that validate these fix rules.

To run these tests locally, execute this command in the flutter/packages/flutter/test_fixes directory.

dart fix --compare-to-golden

For more documentation about Data Driven Fixes, see https://dart.dev/go/data-driven-fixes#test-folder.

To learn more about how fixes are authored in package:flutter, see https://github.com/flutter/flutter/wiki/Data-driven-Fixes

When making structural changes to this directory

Note that the tests in this directory are also invoked from external repositories. Specifically, the CI system for the dart-lang/sdk repo runs these tests in order to ensure that changes to the dart fix file format do not break Flutter.

See tools/bots/flutter/analyze_flutter_flutter.sh for where the tests are invoked.

When possible, please coordinate changes to this directory that might affect the analyze_flutter_flutter.sh script.