feat: Add custom ESLint plugin for YAML sorting #630
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: a2a23c9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
nambrot
reviewed
Mar 5, 2025
| - http: https://alephzero.drpc.org | ||
| - http: https://rpc.alephzero.raas.gelato.cloud |
There was a problem hiding this comment.
We should exclude RPC urls from sorting (because there might be a reason to sort these according to reliability
There was a problem hiding this comment.
Good catch, I was not aware of it.
fixed also did same for block explorers
mshojaei-txfusion
force-pushed
the
fix/yaml-sorting
branch
from
b76c3b1 to
9a41015
Compare
|
what worries me is this PR removes yaml files comments. |
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.
Description
Added a custom ESLint plugin that enforces consistent sorting in YAML files. The plugin specifically targets arrays in chain and deployment configuration files, sorting:
tokensarrays bychainNametokens[].connectionsarrays bytokenThis improves readability, reduces merge conflicts, and makes changes to these arrays more predictable and consistent.
Also added a convenience npm script
sort-yamlto easily format all YAML files.Related issues
hyperlane-xyz/hyperlane-monorepo#5547
Backward compatibility
Yes. This change only affects linting rules and doesn't modify any runtime behavior.
Testing
The plugin has been tested against existing YAML files in the
chainsanddeploymentsdirectories. The sorting logic properly preserves all data while reorganizing it consistently.