Add lll linter #354
Merged
Add lll linter #354
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
geoff-vball
requested review from
michaelkaplan13,
cam-schultz,
minghinmatthewlam and
bernard-avalabs
as code owners
iansuvak
reviewed
Jul 3, 2024
Co-authored-by: Ian Suvak <ian.suvak@avalabs.org> Signed-off-by: Geoff Stuart <geoff.vball@gmail.com>
iansuvak
approved these changes
Jul 3, 2024
cam-schultz
approved these changes
Jul 3, 2024
| @@ -76,6 +77,7 @@ func (mc *MessageCoordinator) getAppRelayerMessageHandler( | |||
| } | |||
|
|
|||
| // Fetch the message delivery data | |||
| //nolint:lll | |||
| sourceBlockchainID, originSenderAddress, destinationBlockchainID, destinationAddress, err := messageHandler.GetMessageRoutingInfo() | |||
There was a problem hiding this comment.
Not for this PR, but these are the exact fields that compose a RelayerID. It might make sense to directly return that struct instead of the individual fields.
| @@ -16,15 +16,15 @@ import ( | |||
| // Specifies the height from which to start processing historical blocks. | |||
| type SourceBlockchain struct { | |||
| SubnetID string `mapstructure:"subnet-id" json:"subnet-id"` | |||
| BlockchainID string `mapstructure:"blockchain-id" json:"blockchain-id"` | |||
| BlockchainID string `mapstructure:"blockchain-id" json:"blockchain-id"` //nolint:lll | |||
There was a problem hiding this comment.
Not for this PR, but we should look into if we still need both mpastructure and json tags. IIRC, the json tag is only used in tests.
| @@ -104,18 +104,25 @@ func (s *SourceBlockchain) Validate(destinationBlockchainIDs *set.Set[string]) e | |||
| return fmt.Errorf("invalid blockchainID in configuration. error: %w", err) | |||
| } | |||
| if !destinationBlockchainIDs.Contains(dest.BlockchainID) { | |||
| return fmt.Errorf("configured source subnet %s has a supported destination blockchain ID %s that is not configured as a destination blockchain", | |||
| return fmt.Errorf( | |||
| "configured source subnet %s has a supported destination blockchain ID %s that is not configured as a destination blockchain", //nolint:lll | |||
There was a problem hiding this comment.
AFAIK, the only other way to preserve these long strings is through concatenation, where we'd put each section on its own line. Not the cleanest, so I think the nolint tag is appropriate in these instances.
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.
Why this should be merged
Closes #352
How this works
Enables the
llllinter and conforms (almost) all line lengths to 120 characters.There are some lines where I couldn't come up with a good was to get the line under 120 characters, so used
nolint:lll. If you have suggestions for any of these lines, please give them :)