Skip to content

[tool] Enforce README package table order - #12316

Open
faheemabbas766 wants to merge 1 commit into
flutter:mainfrom
faheemabbas766:tooling-validate-readme-table-order
Open

[tool] Enforce README package table order#12316
faheemabbas766 wants to merge 1 commit into
flutter:mainfrom
faheemabbas766:tooling-validate-readme-table-order

Conversation

@faheemabbas766

Copy link
Copy Markdown
Contributor

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

The tool already has a NEXT CHANGELOG 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.dart
  • dart analyze --fatal-infos
  • dart 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-assist bot 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

  1. 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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[packages] Repo tool should enforce main README table order

1 participant