Refactor (packages/tui/src/util/format.ts): Function with many returns - #118
Open
Wunwan wants to merge 1 commit into
Open
Refactor (packages/tui/src/util/format.ts): Function with many returns#118Wunwan wants to merge 1 commit into
Wunwan wants to merge 1 commit into
Conversation
1 task
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
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: #111
Full path to the refactored file: packages/tui/src/util/format.ts
What do you think this file does?
Format.ts contains a function called formatDuration(), which helps reformat a number of seconds into more appropriate units like days, weeks, etc.
What is the scope of your refactoring within that file?
formatDuration()
Which Qlty‑reported issue did you address?
1 Function with many returns (count = 6): formatDuration
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
Having multiple return statements and multiple if clauses creates inconsistency in the code and may require the programmer to make edits in several scattered places when making changes to this function.
What changes did you make to resolve the issue?
I declared a variable called
formattedthat stores the most appropriate format for the data. When the number falls into one of the conditions, the variable saves the appropriate formatted value, and the function returns it once at the end.How do your changes improve maintainability? Did you consider alternatives?
My changes reduced formatDuration from 6 separate return points to one final return. Using a single
formattedvariable with an appropriate if / else if chain improves readability and makes future changes easier to manage. This is a fairly simple refactoring task, and the current method improves maintainability without adding unnecessary complexity.3. Validation
How did you validate that the change is correct?
I ran the test coverage once before refactoring and once after. The test coverage remained at 100% for both attempts. The Qlty results initially flagged the issue of having 6 return statements, but the issue disappeared when I ran Qlty again after refactoring.
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.Before refactoring
After refactoring