Skip to content
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

Added gum to preinstall script #990

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Added gum to preinstall script #990

merged 1 commit into from
Feb 11, 2025

Conversation

mirooon
Copy link
Contributor

@mirooon mirooon commented Feb 11, 2025

Which Jira task belongs to this PR?

Why did I implement it this way?

'gum' is widly used in our scripts

Checklist before requesting a review

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

  • I have checked that any arbitrary calls to external contracts are validated and or restricted
  • I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
  • I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

Walkthrough

The pull request updates the preinstall.sh script by modifying the REQUIRED_PACKAGES array. The update adds the package "gum" to the existing list of required packages ("jq" and "bc"), while the rest of the script's logic for operating system detection and package installation remains unchanged.

Changes

File(s) Change Summary
preinstall.sh Updated the REQUIRED_PACKAGES array from ("jq" "bc") to ("jq" "bc" "gum")

Possibly related PRs

Suggested labels

AuditNotRequired

Suggested reviewers

  • 0xDEnYO

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 038d342 and 23009cf.

📒 Files selected for processing (1)
  • preinstall.sh (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: run-unit-tests
  • GitHub Check: enforce-min-test-coverage
🔇 Additional comments (1)
preinstall.sh (1)

40-40: Verify the "gum" package and its availability.

Please verify the following about the "gum" package:

  1. Its purpose and necessity in the development environment
  2. Its availability in apt, dnf, and Homebrew package managers
  3. Its security and maintenance status
✅ Verification successful

🌐 Web query:

What is the "gum" package for Linux and macOS? Is it well-maintained?

💡 Result:

The Gum package is a Terminal UI (TUI) toolkit designed to help users build interactive command-line interfaces (CLIs) for shell scripts. Developed in Go by the Charm team (charmbracelet/gum), it simplifies creating components like forms, menus, prompts, and stylized text output directly in the terminal[10][4][9].

Key Features

  • Interactive elements: Supports input forms, confirmation dialogs, file selection menus[10].
  • Styling utilities: Adds colorized text, borders, and log messages with customizable themes[10].
  • Cross-platform compatibility: Works on Linux, macOS, and Windows[10].

Installation & Maintenance Status

  • Linux/macOS: Available via MacPorts (sudo port install gum), last updated to v0.14.5 in September 2024[4].
  • Active development: The GitHub repository shows regular updates (as of 2025), with contributions from an active community[10][9].
  • Package support: Integrated into third-party tools like x-cmd for easy global/temporary installation[10].

Comparison to Similar Tools

Feature Gum Traditional CLIs
Interactive elements Built-in components Requires manual setup
Styling Modern ANSI/emoji Limited customization
Ease of use Minimal Go code Complex scripting

For scriptwriters seeking polished terminal interfaces without heavy coding, Gum offers a well-maintained solution with ongoing updates and broad OS support[10][4].

Citations:


Verification of the "gum" package

  • Purpose & Necessity:
    "gum" is a Terminal UI toolkit developed by the Charm team. It helps in building interactive command-line interfaces (forms, menus, prompts, etc.) which can enhance user experience within the contracts repository's CLI tools.

  • Availability:

    • Homebrew: "gum" is available via Homebrew (e.g., brew install gum), making it easy to install on macOS and Linux (using Linuxbrew).
    • apt/dnf: There is no clear evidence that "gum" is packaged in the official apt or dnf repositories. Users on Debian/Ubuntu or Fedora might need to install it via alternative methods (like Homebrew/Linuxbrew or downloading binaries from the GitHub releases).
  • Security & Maintenance:
    "gum" is actively maintained, with recent updates (e.g., v0.14.5 as of September 2024) and an active community supporting its development. This suggests it is secure and reliable for use in your development environment.

Based on the above, the inclusion of "gum" in the REQUIRED_PACKAGES array is valid, although it's important to note that Linux users may need to rely on Homebrew or alternative installation methods rather than expecting it in standard apt/dnf repositories.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@lifi-action-bot lifi-action-bot marked this pull request as draft February 11, 2025 16:47
@mirooon mirooon marked this pull request as ready for review February 11, 2025 16:51
@lifi-action-bot
Copy link
Collaborator

Test Coverage Report

Line Coverage: 78.66% (2238 / 2845 lines)
Function Coverage: 84.71% ( 388 / 458 functions)
Branch Coverage: 39.60% ( 221 / 558 branches)
Test coverage (78.66%) is above min threshold (78%). Check passed.

@0xDEnYO 0xDEnYO enabled auto-merge (squash) February 11, 2025 23:56
@0xDEnYO 0xDEnYO merged commit 520e416 into main Feb 11, 2025
27 checks passed
@0xDEnYO 0xDEnYO deleted the preinstall-update branch February 11, 2025 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants