[tool] Enforce README package table order - #12316
Open
faheemabbas766 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds validation to ensure that the package table in the root README.md is sorted alphabetically. It updates RepoInfoValidator to track the alphabetical order of entries, introduces a new exit code for unsorted tables, and adds a corresponding unit test to verify this behavior. The root README.md table is also updated to be sorted alphabetically. There are no review comments, so no additional feedback is provided.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds repository-info validation that rejects package rows in the root README when they are not sorted alphabetically. The error identifies the first out-of-order pair.
This also adds regression coverage and sorts the three existing out-of-order rows so the repository passes the new validation.
Fixes flutter/flutter#188727.
Pre-Review Checklist
[shared_preferences]///).The tool already has a
NEXTCHANGELOG section, so this change adds its release note there without changing the package version.Validation:
dart format --output=none --set-exit-if-changed lib/src/validators/repo_info_validator.dart test/validate_command_repo_info_test.dartdart analyze --fatal-infosdart test test/validate_command_repo_info_test.dart(29 tests)dart test(1,221 tests)If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2