refactor: implement common check methods by check base #135
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
* chore: rm old nolint comment
* refactor: base struct to hold common fields * feat: genericize base struct to accept a config * refactor: checks to use base struct
lvlcn-t
added
refactoring
lvlcn-t
requested review from
y-eight,
niklastreml,
puffitos and
eumel8
as code owners
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.
⚠ Review after #134 has been merged, since this PR is based on that one.Motivation
Currently, we have a lot of duplicated code for each check. This PR aims to refactor the code to have a common base struct which implements the methods that are common for all checks.
Partly addresses #99 but could be extended to generate the wrapping methods and method shells/types for each check.
Changes
I've removed the duplicated code and adjusted our common base struct to implement the methods that are common for all checks. This way we can reduce the amount of code and make it easier to maintain.
To do so I've made it a generic struct that takes in the config type of an individual check. This way we can embed the common check base struct in each check and pass the config to the common check base struct.
For additional information look at the commits.
Tests done
I've moved the tests for the common methods to test the common check base struct. All tests succeeded.
TODO