Skip to content

Conversation

@ryota-murakami
Copy link
Contributor

@ryota-murakami ryota-murakami commented May 7, 2025

  • Introduced a closure-based prefixState for managing the state of commit message prefixes safely.
  • Added functionality to enable or disable commit message prefixes through a new prefix command.
  • Updated the

Summary by CodeRabbit

  • New Features

    • Added a CLI command to enable or disable commit message prefixes (e.g., feat:, fix:, refactor:).
    • Commit message generation now adapts based on the prefix setting.
    • The configuration display now shows the current prefix setting.
  • Chores

    • Updated version number to 0.8.10.

- Introduced a closure-based prefixState for managing the state of commit message prefixes safely.
- Added functionality to enable or disable commit message prefixes through a new prefix command.
- Updated the
@coderabbitai
Copy link

coderabbitai bot commented May 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new feature was added to allow toggling of commit message prefixes via a CLI command. The prefix state is now managed with a closure-based object, persisted in the configuration, and reflected in commit message generation. The configuration display and CLI were updated to support and show the prefix state. The package version was incremented.

Changes

File(s) Change Summary
index.js Added prefix toggle feature, closure-based state management, config persistence, CLI updates, and conditional commit message prefix logic.
package.json Incremented version from 0.8.9 to 0.8.10.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant PrefixState
    participant Config

    User->>CLI: Run "prefix" command
    CLI->>PrefixState: setEnabled(value)
    PrefixState->>Config: Save prefixEnabled state
    Config-->>CLI: Confirm save
    CLI-->>User: Show updated prefix state
Loading
sequenceDiagram
    participant User
    participant CLI
    participant PrefixState
    participant Config
    participant CommitMsgGen

    User->>CLI: Run commit command
    CLI->>Config: Load config (including prefixEnabled)
    Config->>PrefixState: Set state
    CLI->>PrefixState: isEnabled()
    PrefixState-->>CLI: Return enabled/disabled
    CLI->>CommitMsgGen: Generate message (with/without prefix)
    CommitMsgGen-->>User: Show commit message
Loading

Possibly related issues

Poem

In the warren of code, a toggle appears,
Prefixes now dance, as the user steers.
With a hop and a skip, the config saves state,
Commit messages tidy, prefixes first-rate!
Version hops up, the changelog complete—
A rabbit’s delight, this feature’s a treat!
🐇✨


📜 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 9afed24 and 9b5f08f.

📒 Files selected for processing (2)
  • index.js (4 hunks)
  • package.json (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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

Support

Need 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)

  • @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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@ryota-murakami ryota-murakami merged commit e9d2b0c into main May 7, 2025
2 of 3 checks passed
@ryota-murakami ryota-murakami deleted the prefix branch May 13, 2025 14:56
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.

2 participants