Skip to content

build(project): add fallback for color handling when tput is unavailable #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Dec 3, 2024

Gracefully handle environments where tput is unavailable.

Summary by CodeRabbit

  • Chores
    • Enhanced color output commands in the Makefile to improve error handling for unsupported tput commands.

@ccamel ccamel self-assigned this Dec 3, 2024
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request focus on the Makefile, specifically enhancing the color output commands to improve error handling. Modifications were made to the definitions of color variables, ensuring that if the tput command is unsupported, it will not cause errors. Instead, these variables will default to an empty string. The overall structure and functionality of the Makefile remain unchanged, with no significant alterations to logic or control flow.

Changes

File Change Summary
Makefile Enhanced color output commands to include error handling for unsupported tput command, defaulting to an empty string.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Makefile
    participant tput

    User->>Makefile: Request color output
    Makefile->>tput: Execute tput command for color
    alt tput supported
        tput-->>Makefile: Return color code
    else tput unsupported
        tput-->>Makefile: Return error
        Makefile-->>User: Output empty string
    end
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
Makefile (1)

29-35: LGTM! Consider refactoring for improved maintainability.

The implementation correctly handles environments where tput is unavailable by adding fallback to empty string. However, the code could be more maintainable.

Consider consolidating the common parts into a helper function:

-# Some colors (if supported)
-COLOR_GREEN  = $(shell tput -Txterm setaf 2 2>/dev/null || echo "")
-COLOR_YELLOW = $(shell tput -Txterm setaf 3 2>/dev/null || echo "")
-COLOR_WHITE  = $(shell tput -Txterm setaf 7 2>/dev/null || echo "")
-COLOR_CYAN   = $(shell tput -Txterm setaf 6 2>/dev/null || echo "")
-COLOR_RED    = $(shell tput -Txterm setaf 1 2>/dev/null || echo "")
-COLOR_RESET  = $(shell tput -Txterm sgr0 2>/dev/null || echo "")
+# Helper function to get color codes with fallback
+define get_color
+$(shell tput -Txterm $(1) $(2) 2>/dev/null || echo "")
+endef
+
+# Some colors (if supported)
+COLOR_GREEN  = $(call get_color,setaf,2)
+COLOR_YELLOW = $(call get_color,setaf,3)
+COLOR_WHITE  = $(call get_color,setaf,7)
+COLOR_CYAN   = $(call get_color,setaf,6)
+COLOR_RED    = $(call get_color,setaf,1)
+COLOR_RESET  = $(call get_color,sgr0,)

This refactoring:

  1. Reduces code duplication
  2. Centralizes the fallback logic
  3. Makes it easier to maintain and modify the color handling
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 599e946 and 5fefaba.

📒 Files selected for processing (1)
  • Makefile (1 hunks)

@ccamel ccamel force-pushed the build/makefile-colors branch from 5fefaba to 08542bf Compare December 3, 2024 09:28
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #831   +/-   ##
=======================================
  Coverage   45.03%   45.03%           
=======================================
  Files         113      113           
  Lines        6395     6395           
=======================================
  Hits         2880     2880           
  Misses       3380     3380           
  Partials      135      135           

@ccamel ccamel merged commit 3458afe into main Dec 3, 2024
21 checks passed
@ccamel ccamel deleted the build/makefile-colors branch December 3, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant