Refactor (packages/tui/src/ui/spinner.ts): Function with many returns - #57
Open
wjeon0329 wants to merge 1 commit into
Open
Refactor (packages/tui/src/ui/spinner.ts): Function with many returns#57wjeon0329 wants to merge 1 commit into
wjeon0329 wants to merge 1 commit into
Conversation
wjeon0329
changed the title
wjeon0329
changed the title
wjeon0329
changed the title
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
2 participants
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: #54
Full path to the refactored file:'
packages/tui/src/ui/spinner.tsWhat do you think this file does?
This file creates the spinner animation, including how the scanner moves forward, backward, other directions, etc.
What is the scope of your refactoring within that file?
I changed the 'getScannerState()' function and added helper function called 'getBidirectionalScannerState()' for the bidirectional logic.
Which Qlty-reported issue did you address?
Qlty reported 'Function with many returns (count=6): getScannerState' at 'packages/tui/src/ui/spinner.ts:25'.
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
'getScannerState()' handled multiple scanner directions and had six different return statements. This has made the function to be harder to maintain.
What changes did you make to resolve the issue?
I moved the bidirectional scanner logic into a separate helper function called 'getBidirectionalScannerState()'. I made sure that the bidirectional scanner still creates the same frames even after the refactor.
How do your changes improve maintainability? Did you consider alternatives?
The original 'getScannerState()' is now more simple, since the bidirectional logic is handled separately. I considered keeping everything inside the same function; however, separating that logic made the main function to be easier to read, without changing the usability or how the original scanner worked.
3. Validation
How did you validate that the change is correct?
First, I ran Qlty again, and it reported the original 'getScannerState()' issue before the refactor and no longer reports it after the change. Also, TUI package test suite passed too. I also added a regression test for the bidirectional scanner and checked coverage to confirm that the code I added is executed by the test.
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.Screenshot of bun lint and bun test
