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

Add Laravel Pint and GitHub workflow #10

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Add Laravel Pint and GitHub workflow #10

merged 2 commits into from
Jul 19, 2024

Conversation

murdercode
Copy link
Contributor

@murdercode murdercode commented Jul 19, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a GitHub Actions workflow for automated code style checking using Laravel Pint.
    • Added a configuration file for Pint to enforce Laravel-specific formatting rules.
    • Updated the development dependencies to include Laravel Pint for enhanced code formatting support.
  • Bug Fixes

    • Minor formatting adjustments were made to improve code readability.
  • Chores

    • Removed unused import statements to simplify the codebase.

Copy link

coderabbitai bot commented Jul 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a GitHub Actions workflow for Laravel Pint, enhancing the code style management process in the project. Key changes include the addition of a composer.json development dependency for Laravel Pint, a new pint.json configuration file, and minor code formatting adjustments in existing PHP files. These modifications streamline development and ensure consistent code styling across the repository.

Changes

File Change Summary
.github/workflows/pint.yml New GitHub Actions workflow for Laravel Pint to automate code style checking on pull requests and main branch pushes.
composer.json Added "require-dev": { "laravel/pint": "^1.16" } to specify Laravel Pint as a development dependency.
pint.json New configuration file for Laravel Pint, setting the preset to "laravel" for standardizing code style.
src/App/Http/Controllers/BusyController.php Minor formatting changes to the isBusy method for improved readability without altering functionality.
src/NovaBusyResourceField.php Removed unused import statement, simplifying the code without affecting the class functionality.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Laravel Pint
    participant Repository

    Developer->>GitHub Actions: Push code or create pull request
    GitHub Actions->>Repository: Checkout code
    GitHub Actions->>Laravel Pint: Install dependencies
    GitHub Actions->>Laravel Pint: Run code style checks
    Laravel Pint-->>GitHub Actions: Return style issues
    GitHub Actions->>Repository: Commit style fixes if necessary
Loading

🐇 In the meadow, code so bright,
A style fixer brings delight.
With Pint in tow, we hop and play,
Ensuring our code’s neat every day!
🐰✨


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 50fec13 and 73c77b1.

Files selected for processing (5)
  • .github/workflows/pint.yml (1 hunks)
  • composer.json (1 hunks)
  • pint.json (1 hunks)
  • src/App/Http/Controllers/BusyController.php (2 hunks)
  • src/NovaBusyResourceField.php (2 hunks)
Files skipped from review due to trivial changes (3)
  • pint.json
  • src/App/Http/Controllers/BusyController.php
  • src/NovaBusyResourceField.php
Additional comments not posted (2)
composer.json (1)

28-31: Addition of laravel/pint as a development dependency.

The addition of laravel/pint under require-dev is correctly formatted and enhances the development environment by providing a tool for code formatting and linting.

.github/workflows/pint.yml (1)

1-30: Addition of GitHub Actions workflow for Laravel Pint.

The workflow is correctly configured to run on pull requests and pushes to the main branch. It sets up PHP, installs dependencies, runs Laravel Pint, and commits any changes automatically. This ensures consistent code styling across the repository.

@murdercode murdercode merged commit 05e3b7b into main Jul 19, 2024
1 check passed
@murdercode murdercode deleted the add-laravel-pint branch July 25, 2024 20:21
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.

1 participant