Refactor (packages/opencode/src/cli/cmd/run/splash.ts): Function with many parameters - #91
Open
anjali-d15 wants to merge 2 commits into
Open
Refactor (packages/opencode/src/cli/cmd/run/splash.ts): Function with many parameters#91anjali-d15 wants to merge 2 commits into
anjali-d15 wants to merge 2 commits into
Conversation
…y many-parameters smell
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
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue: #73
Full path to the refactored file: packages/opencode/src/cli/cmd/run/splash.ts
What do you think this file does?
It renders the entry and exit splash banners shown in opencode's direct interactive terminal mode, which include the logo, session title, and resume command that appear in scrollback history.
What is the scope of your refactoring within that file?
The push helper function and its call sites throughout the file.
Which Qlty‑reported issue did you address?
"Function with many parameters". push had 7 parameters before the change.
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
The push function has 7 parameters and several shared the same type. This made call sites prone to errors, since it was easy to accidentally swap two arguments of the same type without any compiler warning, and call sites were hard to read without checking the function signature.
What changes did you make to resolve the issue?
I combined the six data-related parameters (left, top, text, fg, bg, attrs) into a single cell options object. So, instead of 7 parameters, there are only 2: lines and the one I created. I updated all 9 call sites throughout the file to match.
How do your changes improve maintainability? Did you consider alternatives?
Call sites are now easier to read since each value is labeled, and it's harder to accidentally mix up two arguments since order no longer matters. I didn't consider other approaches, since combining the parameters into an object seemed like the standard fix for this smell.
3. Validation
How did you validate that the change is correct?
I wrote 3 new unit tests in test/cli/run/splash.test.ts that call push directly with different argument combinations. I also ran bun test for the package and confirmed bun lint shows no new warnings for this file.
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.