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

chore: move google/protobuf requirement to dev #14

Open
wants to merge 1 commit into
base: 1.x
Choose a base branch
from

Conversation

AtCliffUnderline
Copy link

@AtCliffUnderline AtCliffUnderline commented Sep 4, 2024

Hello.
Trying to do the same as in the repository https://github.com/roadrunner-php/goridge - google/protobuf is removed from require_dev and added to suggest ext-protobuf as well. The purpose is not to install google/protobuf when ext-protobuf already installed.

However, I can not add an exception throw same as here: https://github.com/roadrunner-php/goridge/blob/8fe68b0c871862f9ec852659de1cc7c1a68b783f/src/RPC/Codec/ProtobufCodec.php#L26

All class are autogenerated, trying to find out where to make an user-friendly exception if nothing is installed. Need assistance c:

cc @Kaspiman

Summary by CodeRabbit

  • New Features
    • Added support for Protobuf codec in the development environment.
  • Documentation
    • Improved clarity and organization of dependency requirements in the project configuration.

Copy link

coderabbitai bot commented Sep 4, 2024

Walkthrough

The changes involve updates to the composer.json file, specifically in the require, require-dev, and suggest sections. The require section has improved formatting, while a new entry for ext-protobuf has been added to require-dev. Additionally, the suggest section now includes a version constraint and description for google/protobuf, enhancing the clarity of dependency documentation.

Changes

Files Change Summary
composer.json Restructured require and suggest sections; added ext-protobuf to require-dev; updated google/protobuf entry in suggest.

Sequence Diagram(s)

(No sequence diagrams generated as the changes do not involve new features or modifications to control flow.)

Poem

🐰 In the garden of code, changes bloom bright,
New entries added, a delightful sight.
Protobuf support hops in with glee,
Dependencies clearer, as clear as can be!
With every update, our project takes flight,
A joyful rabbit dances in the moonlight! 🌙✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

Copy link

@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, codebase verification and nitpick comments (1)
composer.json (1)

Line range hint 1-58: More information is needed to address the exception handling requirement.

The PR summary mentions that you are seeking assistance in identifying the appropriate location within the autogenerated classes to implement exception handling for missing Protobuf components. However, the provided code changes do not include any exception handling logic.

To help with this requirement, please provide more information on the specific autogenerated classes and the desired behavior for the exception handling. Once you provide more details, I can assist in identifying the appropriate location for implementing the exception handling logic.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 84ccecb and e581e6e.

Files selected for processing (1)
  • composer.json (1 hunks)
Additional comments not posted (3)
composer.json (3)

36-36: LGTM!

The addition of ext-protobuf to require-dev enhances clarity regarding development dependencies.


40-41: LGTM!

The changes to the suggest section improve the documentation and organization of the dependency requirements.


42-42: LGTM!

The addition of a version constraint and description for google/protobuf in the suggest section enhances clarity regarding its role in Protobuf codec support.

@rustatian rustatian requested a review from msmakouz September 4, 2024 19:45
@rustatian rustatian changed the title Move google/protobuf requirement to dev chore: move google/protobuf requirement to dev Sep 4, 2024
@rustatian rustatian added the enhancement New feature or request label Sep 4, 2024
@rustatian
Copy link
Contributor

@msmakouz could you please take a look?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants