tools: Add code complexity linter, gocyclo #1593
Merged
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
Codecov Report
@@ Coverage Diff @@
## develop #1593 +/- ##
==========================================
- Coverage 64.31% 64.12% -0.2%
==========================================
Files 122 122
Lines 6704 6754 +50
==========================================
+ Hits 4312 4331 +19
- Misses 2147 2177 +30
- Partials 245 246 +1 |
|
Fixing |
Gocyclo is a code complexity linter. It uses cyclomatic complexity. Cyclomatic complexity essentially measures the number of different paths code could go through. (The conditional in a for loop counts as adding one path) It looks at this on a per-function level. The idea that this would be enforcing is that if there are too many different paths code can go through in a function, it needs to be better split up. (A function with too many code paths is hard to reason about) The complexity which we want the linter to start failing on is configurable. The default is 10. Change the "Cyclo" parameter in `tools/gometalinter.json` to try other values.
* Adds a Min function to Int, and uses that in the slash function * Adds a getHeight helper function to iavlstore * Adds a splitPath function to baseapp * Changes cyclo param from 10 to 11
ValarDragon
force-pushed
the
dev/add_gocyclo
branch
from
a9f8db6 to
17b5370
Compare
|
I added nolint in many places. For a couple of them the relevant code is going to be replaced in upcoming refactors / in handling of other issues. |
|
Awesome, thanks! |
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.
Gocyclo is a code complexity linter. It uses cyclomatic complexity.
Cyclomatic complexity essentially measures the number of different
paths code could go through. (The conditional in a for loop counts
as adding one path) It looks at this on a per-function level. The
idea that this would be enforcing is that if there are too many
different paths code can go through in a function, it needs to be
better split up. (A function with too many code paths is hard to
reason about)
The complexity which we want the linter to start failing on is
configurable. The default is 10. Change the "Cyclo" parameter in
tools/gometalinter.jsonto try other values.I've left the errors in this first commit, just so everyone can take a look. (Plus
its likely I don't understand most of the functions well enough to effectively
split them into smaller functions)
Wrote tests