Main -> Dev

[R5dan]

Summary by CodeRabbit

• New Features

  • Added comprehensive command-line UI components:
    • Colour management with ANSIColors
    • Interactive input with autocomplete
    • Multi-option and single-option selectors
    • Customisable terminal spinner animations

• Documentation

  • Expanded reference documentation for new CLI components
  • Added example scripts demonstrating usage of new features

• Workflow

  • Updated GitHub Actions workflow for Sphinx documentation deployment
  • Improved build and deployment processes

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive enhancement to the bettercli library by adding new command-line interface (CLI) components. The changes include the development of colour, input, selector, and spinner modules within the bettercli.cl namespace. These additions provide developers with robust tools for creating interactive terminal applications, including colour management, user input handling, option selection, and progress indication.

Changes

File	Change Summary
.github/workflows/sphinx.yml	Updated workflow for Sphinx documentation build and deployment
bettercli/__init__.py	Added import for cl module
bettercli/cl/__init__.py	Imported new CLI-related classes
bettercli/cl/colours.py	Introduced ANSIColors class for terminal colour management
bettercli/cl/input.py	Added Input class for interactive text input with suggestions
bettercli/cl/selector.py	Created Selector and SingleSelector classes for option selection
bettercli/cl/spinner.py	Implemented Spinner class for terminal animation
doc/source/examples/cl/*	Added example scripts demonstrating new CLI components
doc/source/reference/cl/*	Created documentation for new CLI modules

Possibly related PRs

• Command Line functionality #5: Connection between bettercli/__init__.py import changes and documentation workflow updates

Poem

🐰 A Rabbit's CLI Delight

With colours bright and spinners light,
Selectors dancing left and right,
Our CLI now sings with glee,
A terminal symphony!

Hop, hop, hooray! 🎉

---

📜 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 985a879 and fec6d1a.

📒 Files selected for processing (16)

• .github/workflows/sphinx.yml (1 hunks)
• bettercli/__init__.py (1 hunks)
• bettercli/cl/__init__.py (1 hunks)
• bettercli/cl/colours.py (1 hunks)
• bettercli/cl/input.py (1 hunks)
• bettercli/cl/selector.py (1 hunks)
• bettercli/cl/spinner.py (1 hunks)
• doc/source/examples/cl/selector/multi.py (1 hunks)
• doc/source/examples/cl/selector/single.py (1 hunks)
• doc/source/examples/cl/selector/style.py (1 hunks)
• doc/source/examples/cl/spinner/main.py (1 hunks)
• doc/source/examples/cl/spinner/style.py (1 hunks)
• doc/source/reference/cl/index.rst (1 hunks)
• doc/source/reference/cl/input.rst (1 hunks)
• doc/source/reference/cl/selector.rst (1 hunks)
• doc/source/reference/cl/spinner.rst (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.