Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: lint: update linter settings, fix lint errors #11968

Merged
merged 3 commits into from May 13, 2024
Merged

Conversation

rvagg
Copy link
Member

@rvagg rvagg commented May 7, 2024

Ref: #11967

This isn't complete, I just banged through a few iterations of it to see the kinds of changes we're being asked to make. I think a better approach here is to add some exclusion error regexes. Most of the issues fall into two categories:

  1. Named but unused parameters
  2. Acronym capitalisation - Api -> API, Http -> HTTP, Url -> URL, Id -> ID

The latter suck in particular because a lot of them are on API methods. I've started adding explicit exclusions for those in here, but we could opt for a global exclusion (minimal might be something like var-naming: var [A-Z].+ should be to capture public variables).

Or we could just hammer it with exclusions to minimise the diff in this PR in particular, even turn off var-naming entirely.

storage/paths/db_index.go Outdated Show resolved Hide resolved
@magik6k
Copy link
Contributor

magik6k commented May 7, 2024

Acronym capitalisation - Api -> API, Http -> HTTP, Url -> URL, Id -> ID

When we were setting up the initial linters we very explicitly disabled all linters which were based on pure opinion and weren't providing any value other than aesthetics based on the linters author taste.

Linters which complain "oh no your variable should be ABC instead of Abc" are purely annoying, often wrong, and just slow down development, where often you'd just push a commit, now you have to push a commit, pray that the linter passes with no annoynig-positives, and possibly/likely go back to the PR to push some fixes which don't fix anything important

Tldr most opinion-based linters imo don't make sense unless most of your team is junior devs

@rvagg
Copy link
Member Author

rvagg commented May 7, 2024

I think I agree, I was getting slightly angry at it telling me that HttpServer must be HTTPServer. I'll work on some exclusions, maybe turn off var-naming entirely.

@ZenGround0
Copy link
Contributor

but we could opt for a global exclusion (minimal might be something like var-naming: var [A-Z].+ should be to capture public variables).

I like the sound of a global exclusion for this

@snadrus
Copy link
Contributor

snadrus commented May 7, 2024

I'm alright turning off both of these things. Because these are not actual problems, but style matters

@rvagg rvagg force-pushed the rvagg/linter-update branch 2 times, most recently from c90a099 to 72070ce Compare May 9, 2024 03:42
@rvagg
Copy link
Member Author

rvagg commented May 9, 2024

I re-did this PR from scratch, and revisited the whole config. Here's the choices I've made:

  • Removed the deprecated linters golint, varcheck, deadcode and scopelint, replacing with their equivalents exportloopref and revive
  • Removed golint specific path exclusions
  • Remove goconst - it had two separate exclusions that meant it wasn't being used anyway, I think we're experienced enough to not need this
  • All message exclusions are more explicit regexes now, they're harder to find ways around (harder to subvert) and it's much clearer in the config the exclusion decisions we're making
  • I decided to ditch all exclusions to unchecked errors except for 3 explicit ones in node/repo/fsrepo.go and 2 in paychmgr/simple.go. This mostly required adding _ = in place of the explicit exclusions and logger.SetLogLevel had a bunch of unchecked but we have far more _ = in the repo so I'm just making that consistent.
  • A bunch of minor changes that are obvious in the diff
  • I decided not to exclude most of the new empty-block errors, but instead I ended up rewriting some logic. I get why some people like empty blocks for comments, but I don't believe they ultimately aid in clarity. Reviewers please pay careful attention to my changes to make sure I didn't change any logic; some are non-trivial.

@rvagg rvagg marked this pull request as ready for review May 9, 2024 03:47
rvagg added 2 commits May 9, 2024 14:22
* remove and replace some linters
* remove some exclusions
* make all exclusions more explicit matches
Copy link
Contributor

@magik6k magik6k left a comment

Choose a reason for hiding this comment

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

Only looked at the SP side of things, but looks good to me

itests/kit/client.go Outdated Show resolved Hide resolved
Copy link
Contributor

@ribasushi ribasushi left a comment

Choose a reason for hiding this comment

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

Read through the diff - everything seems correct functionally.

Left 2 comments where things were most jarring.

node/impl/full/eth_utils.go Outdated Show resolved Hide resolved
node/impl/full/eth_utils.go Outdated Show resolved Hide resolved
@rvagg rvagg enabled auto-merge (rebase) May 13, 2024 04:51
@rvagg rvagg merged commit 1882525 into master May 13, 2024
186 checks passed
@rvagg rvagg deleted the rvagg/linter-update branch May 13, 2024 04:52
@@ -410,7 +411,6 @@ func lookupEthAddress(addr address.Address, st *state.StateTree) (ethtypes.EthAd
return ethAddr, nil
}

// Otherwise, use the masked address.
Copy link
Contributor

Choose a reason for hiding this comment

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

@rvagg in the final diff-set this comment got lost
Unsure how important for understanding the rest of the stuff, this is your-ish area

image

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch, I'd rather not lose it, #12007

@rjan90 rjan90 mentioned this pull request May 16, 2024
8 tasks
rvagg added a commit that referenced this pull request May 17, 2024
rvagg added a commit that referenced this pull request May 17, 2024
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.

Deprecated Linters Causing failed checks golinter using deprecated packages
5 participants