flutter/packages/flutter_driver/lib/fix_data/README.md
Pierre-Louis 072b8874a0
Update link branches to main (#146558)
- Update CS and googlesource.com link branches
- Update GitHub /blob/ and /tree/ links

Tested links manually and fixes a few broken or deprecated links

Added a test that validates that `master` isn't used, except for
specified repos.

Part of https://github.com/flutter/flutter/issues/121564

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#overview
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[test-exempt]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat
[Data Driven Fixes]:
https://github.com/flutter/flutter/wiki/Data-driven-Fixes
2024-04-17 09:44:23 +02:00

1.9 KiB

Directory contents

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

The number of fix rules defined in a file should not exceed 50 for better maintainability. Searching for title: in 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 template.yaml. Each file should be for a single class and named fix_<class>.yaml. To make sure each file is grouped with related classes, a fix_<filename> folder will contain all of the fix files for the individual classes.

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

To run these tests locally, execute this command in the flutter/packages/flutter_driver/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_driver, see https://github.com/flutter/flutter/wiki/Data-driven-Fixes

When making structural changes to this directory

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 flutter fix tests are invoked for the dart repo.

See dev/bots/test.dart for where the flutter fix tests are invoked for the flutter/flutter repo.

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