Refactor (packages/core/src/reference.ts): Function with high complexity - #93
Open
kthaker108 wants to merge 3 commits into
Open
Refactor (packages/core/src/reference.ts): Function with high complexity#93kthaker108 wants to merge 3 commits into
kthaker108 wants to merge 3 commits into
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
P1B: Starter Task: Refactoring PR
1. Issue
Link to the associated GitHub issue:
#87
Full path to the refactored file:
packages/core/src/reference.ts
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
This file manages a list of references that get downloaded/cached so the app can use them later.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
The scope of my refactoring within the file was within the finalize callback inside the State.create(...) call. Specifically, it is now two new helper functions, toInfo and materializeRemote, along with finalize, and I simplified the loop inside too.
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Function with high complexity (count = 33): finalize, reported at packages/core/src/reference.ts:58
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The finalize function did too much in one place since it was handling local sources, remote sources, and repeating the same code, making it long and hard to follow.
What changes did you make to resolve the issue?
I moved all that code into two helper functions, toInfo (builds the info object) and materializeRemote (remote-specific logic), so finalize now just loops through sources and calls these helpers.
How do your changes improve maintainability? Did you consider alternatives?
My changes improved maintainability because the code is now easier to read since each helper does one clear thing.
3. Validation
How did you validate that the change is correct?
I ran the existing tests in packages/core and added 1 new test to cover a case that wasn't tested before (invalid branch name). I also reran qlty smells to check if the issue was gone and ran bun lint to make sure I didn't add any new warnings.
Attach a screenshot of the test coverage showing the lines were executed by the tests.
Attach a screenshot showing the tests that cover the change passing during CI
Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.