Skip to content

Added phpcs#61

Merged
MekDrop merged 2 commits intoimponeer:mainfrom
MekDrop:add-phpcs
Jul 8, 2025
Merged

Added phpcs#61
MekDrop merged 2 commits intoimponeer:mainfrom
MekDrop:add-phpcs

Conversation

@MekDrop
Copy link
Copy Markdown
Member

@MekDrop MekDrop commented Jul 8, 2025

Resolves #55

Summary by CodeRabbit

  • New Features

    • Added automated code style checks using PHP CodeSniffer with PSR-12 standard for improved code consistency.
  • Chores

    • Updated development dependencies to include PHP CodeSniffer and related scripts for code style checking and automatic fixing.
    • Enhanced GitHub Actions workflow to run code style checks on pull requests.
  • Style

    • Reformatted code and test files for consistent indentation, spacing, and documentation comment placement. No changes to functionality.

Resolves #55
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce PHP CodeSniffer (phpcs) support to the project. This includes updating development dependencies and scripts in composer.json, adding a phpcs.xml configuration for PSR-12 standards, integrating a phpcs step in the GitHub Actions workflow, and reformatting source and test files to comply with the coding standard. No functional or public API changes were made.

Changes

File(s) Change Summary
.github/workflows/on-pull-request.yml Added a "phpcs" step to the GitHub Actions workflow for pull requests.
composer.json Added squizlabs/php_codesniffer as a dev dependency; added phpcs and phpcbf scripts.
phpcs.xml Added new PHP_CodeSniffer configuration for PSR-12 on src and tests directories.
src/ErrorsCollection.php
src/ErrorsTrait.php
src/ParamsMode.php
src/UnsetErrorException.php
Reformatted code to comply with PSR-12; adjusted indentation, spacing, and docblock placement.
tests/ErrorsCollectionTest.php
tests/ErrorsTraitTest.php
Reformatted test files for consistent 4-space indentation and PSR-12 compliance.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Composer
    participant PHP_CodeSniffer

    Developer->>GitHub Actions: Open Pull Request
    GitHub Actions->>Composer: Install dependencies (including phpcs)
    GitHub Actions->>PHP_CodeSniffer: Run phpcs via composer script
    PHP_CodeSniffer-->>GitHub Actions: Report code style results
    GitHub Actions-->>Developer: Show phpcs results in workflow
Loading

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Add phpcs support (#55)

Poem

In lines of code both neat and tight,
The rabbits hopped to make things right.
With PSR-12 now in command,
The code is clean across the land.
PHPCS checks with every run—
Formatting battles have been won!
🐇✨


📜 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 a4a1f95 and e73e413.

📒 Files selected for processing (9)
  • .github/workflows/on-pull-request.yml (1 hunks)
  • composer.json (2 hunks)
  • phpcs.xml (1 hunks)
  • src/ErrorsCollection.php (3 hunks)
  • src/ErrorsTrait.php (1 hunks)
  • src/ParamsMode.php (1 hunks)
  • src/UnsetErrorException.php (1 hunks)
  • tests/ErrorsCollectionTest.php (1 hunks)
  • tests/ErrorsTraitTest.php (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@MekDrop MekDrop merged commit ddad41a into imponeer:main Jul 8, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Add phpcs support

1 participant