refactor: remove redundant library wrapper patterns#155
Conversation
- Remove TERMINAL_CONTROL object that simply re-exported ansi-escapes functions - Use ansi-escapes directly for better performance and smaller bundle size - Add comprehensive JSDoc comments explaining usage patterns - Improve comments for functions that are not self-explanatory - Keep TerminalManager class for state management and TTY checking
- Replace manual object property recreation with spread operator - Reduces code redundancy and improves maintainability - Smaller bundle size due to less repetitive code - Preserves all existing functionality and type safety
|
Warning Rate limit exceeded@ryoppippi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 23 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ryoppippi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on improving code quality, maintainability, and efficiency by eliminating unnecessary abstractions and enhancing documentation. The changes streamline terminal control logic and modernize object creation patterns, leading to a cleaner and more understandable codebase.
Highlights
- Refactor: Redundant Wrapper Removal: I've removed the
TERMINAL_CONTROLobject insrc/_terminal-utils.tswhich was a redundant wrapper aroundansi-escapesfunctions. TheTerminalManagerclass now directly utilizesansi-escapesfor terminal operations, simplifying the codebase and reducing indirection. - Code Conciseness: Object Creation: In
src/calculate-cost.ts, thecreateTotalsObjectfunction has been refactored to use the object spread operator (...totals). This replaces manual property assignment, making the code more concise, readable, and resilient to future changes in theTokenTotalsinterface. - Documentation Improvement: JSDoc: I've added comprehensive JSDoc comments throughout
src/_terminal-utils.tsfor theTerminalManagerclass, its methods, and utility functions likecreateProgressBarandcenterText. This significantly improves code understanding and maintainability, especially for non-obvious usage patterns.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
commit: |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
ccusage-guide | 18603e2 | Jun 22 2025, 10:18 AM |
There was a problem hiding this comment.
Code Review
The pull request refactors the code by removing a redundant library wrapper, using the spread operator for object creation, and adding JSDoc comments. The changes improve code maintainability, performance, and documentation. The removal of the TERMINAL_CONTROL wrapper and the use of the spread operator in createTotalsObject are good optimizations. The added JSDoc comments enhance code understanding.
| hideCursor(): void { | ||
| if (!this.cursorHidden && this.stream.isTTY) { | ||
| this.stream.write(TERMINAL_CONTROL.HIDE_CURSOR); | ||
| this.stream.write(ansiEscapes.cursorHide); | ||
| this.cursorHidden = true; | ||
| } |
There was a problem hiding this comment.
Consider adding a comment explaining why the cursor is hidden only in TTY environments. This would improve code understanding for future developers.
if (!this.cursorHidden && this.stream.isTTY) {
// Only hide cursor in TTY environments to prevent issues with non-interactive streams
this.stream.write(ansiEscapes.cursorHide);
this.cursorHidden = true;
}| clearScreen(): void { | ||
| if (this.stream.isTTY) { | ||
| this.stream.write(TERMINAL_CONTROL.CLEAR_SCREEN); | ||
| this.stream.write(TERMINAL_CONTROL.MOVE_TO_TOP); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Clears the current line | ||
| */ | ||
| clearLine(): void { | ||
| if (this.stream.isTTY) { | ||
| this.stream.write(TERMINAL_CONTROL.CLEAR_LINE); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Moves cursor up by n lines | ||
| */ | ||
| moveUp(lines: number): void { | ||
| if (this.stream.isTTY && lines > 0) { | ||
| this.stream.write(TERMINAL_CONTROL.MOVE_UP(lines)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Moves cursor to beginning of line | ||
| */ | ||
| moveToLineStart(): void { | ||
| if (this.stream.isTTY) { | ||
| this.stream.write(TERMINAL_CONTROL.MOVE_TO_COLUMN(1)); | ||
| this.stream.write(ansiEscapes.clearScreen); | ||
| this.stream.write(ansiEscapes.cursorTo(0, 0)); | ||
| } |
There was a problem hiding this comment.
Consider adding a comment explaining why the screen is cleared and the cursor is moved to the top-left corner only in TTY environments.
if (this.stream.isTTY) {
// Only clear screen in TTY environments to prevent issues with non-interactive streams
this.stream.write(ansiEscapes.clearScreen);
this.stream.write(ansiEscapes.cursorTo(0, 0));
}| return { | ||
| inputTokens: totals.inputTokens, | ||
| outputTokens: totals.outputTokens, | ||
| cacheCreationTokens: totals.cacheCreationTokens, | ||
| cacheReadTokens: totals.cacheReadTokens, | ||
| ...totals, | ||
| totalTokens: getTotalTokens(totals), | ||
| totalCost: totals.totalCost, | ||
| }; |
There was a problem hiding this comment.
Consider including totalCost in the spread operator to avoid explicitly excluding it and keep the object complete.
return {
...totals,
totalTokens: getTotalTokens(totals),
totalCost: totals.totalCost, // Include totalCost in the object
};There was a problem hiding this comment.
Pull Request Overview
Refactors terminal utilities to remove redundant wrappers and streamlines object creation in cost calculation.
- Replace manual property mapping in
createTotalsObjectwith spread operator for brevity - Remove
TERMINAL_CONTROLwrapper and inlineansi-escapescalls inTerminalManager - Enrich code with comprehensive JSDoc for clearer developer guidance
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/calculate-cost.ts | Simplified createTotalsObject by spreading totals |
| src/_terminal-utils.ts | Removed TERMINAL_CONTROL, updated TerminalManager methods and JSDoc |
Comments suppressed due to low confidence (1)
src/_terminal-utils.ts:45
- The methods
clearLine,moveUp, andmoveToLineStartwere removed fromTerminalManager. If any callers still rely on those operations, they will break. Please verify no existing code depends on them or provide equivalent methods.
clearScreen(): void {
| outputTokens: totals.outputTokens, | ||
| cacheCreationTokens: totals.cacheCreationTokens, | ||
| cacheReadTokens: totals.cacheReadTokens, | ||
| ...totals, |
There was a problem hiding this comment.
Using a spread here will include all properties from totals. If TokenTotals gains new fields in the future that shouldn’t be part of the returned object, this could introduce unintended keys. Consider explicitly listing only the properties you need or adding a comment about which fields are expected.
| ...totals, | |
| inputTokens: totals.inputTokens, | |
| outputTokens: totals.outputTokens, | |
| cacheCreationTokens: totals.cacheCreationTokens, | |
| cacheReadTokens: totals.cacheReadTokens, | |
| totalCost: totals.totalCost, |
Added inline comments explaining why cursor hiding and screen clearing operations are restricted to TTY environments to prevent issues with non-interactive streams like files or pipes.
Summary
Benefits
Changes
Testing