feat(cli): add optional field for scope

[KeisukeYamashita]

Signed-off-by: KeisukeYamashita [email protected]# Why

Resolves: #355

In some cases, scope can be optional, but users may want to apply an allow list if a value is provided.
Currently, the scope-empty and scope are exclusive, and this policy can be configured.

Summary by CodeRabbit

• New Features

  • Introduced an optional attribute for scopes, allowing flexibility in commit messages.
  • Updated default configuration for scopes to include the optional field.

• Documentation

  • Enhanced clarity and structure of the scope.md document.
  • Added examples for optional scopes, improving user understanding of configuration options.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new boolean field, optional, to the Scope struct, allowing for the absence of a scope when this field is set to true. The validate method has been adjusted to accommodate this new functionality. Additionally, the documentation for scopes has been updated to clarify the configuration options, including the new optional attribute and its implications for commit messages.

Changes

File	Change Summary
src/rule/scope.rs	Added optional: bool field to Scope, updated default implementation, modified validate method, and added test cases for the new field.
web/src/content/docs/rules/scope.md	Enhanced clarity of the document regarding configuration options, added a section for optional scopes, and corrected YAML formatting.

Assessment against linked issues

Objective	Addressed	Explanation
Allow empty scope, but if scope exists must be listed in config (Issue #355)	✅

🐰 In the fields of code, I hop with glee,
A new optional field, as bright as can be!
With scopes now flexible, oh what a delight,
Commit messages dance, both day and night!
So let’s code together, with joy and with cheer,
For every new feature, our vision is clear! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

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.