Add phpcs command

[MekDrop]

Summary by CodeRabbit

• Chores
  • Added development tools for code style checking and automatic fixing.
  • Introduced configuration for enforcing PSR-12 coding standards.
• Style
  • Improved code formatting and indentation for consistency.

[coderabbitai]

Walkthrough

This update introduces PHP_CodeSniffer as a development dependency and configures it for the codebase. The composer.json file is updated to add scripts for running code style checks and fixes. A phpcs.xml configuration file is added, and code formatting is applied to the interface file for consistency.

Changes

File(s)	Change Summary
composer.json	Added squizlabs/php_codesniffer as a dev dependency; introduced scripts for phpcs and phpcbf.
phpcs.xml	Added PHP_CodeSniffer configuration enforcing PSR-12 on the src directory with progress output.
src/ToArrayInterface.php	Reformatted code to use consistent 4-space indentation and improved whitespace.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Composer
    participant PHP_CodeSniffer

    Developer->>Composer: Run "composer phpcs"
    Composer->>PHP_CodeSniffer: Execute code style check (PSR-12)
    PHP_CodeSniffer-->>Developer: Display code style results

    Developer->>Composer: Run "composer phpcbf"
    Composer->>PHP_CodeSniffer: Execute code style fixer
    PHP_CodeSniffer-->>Developer: Apply and report code fixes

Loading

Possibly related issues

• Add phpcs smarty-xo#33: Adds PHP_CodeSniffer configuration and scripts, matching the objective of this PR.
• Add phpcs smarty-includeq#34: Adds PHP_CodeSniffer configuration and scripts, aligning with this PR's changes.
• Add phpcs properties#35: Adds PHP_CodeSniffer configuration and scripts, which this PR implements.
• Add phpcs smarty-image#36: Adds PHP_CodeSniffer configuration and scripts, addressed by this PR.
• Add phpcs support extensions-setup-contracts#28: Adds PHP_CodeSniffer dependency and configuration, as in this PR.
• Add phpcs support #32: Adds PHP_CodeSniffer configuration and scripts, directly addressed by this PR.
• Add phpcs smarty-db-resource#40: Adds PHP_CodeSniffer configuration and scripts, matching this PR.
• Add phpcs support smarty-sunrise-http-router#31: Adds PHP_CodeSniffer configuration and scripts, as in this PR.
• Add phpcs support object-errors#55: Adds PHP_CodeSniffer as a dev dependency and configures scripts/ruleset, as in this PR.
• Add phpcs support extension-info-contracts#49: Adds PHP_CodeSniffer configuration and scripts, which this PR implements.

Poem

A rabbit with code so neat and bright,
Hopped through the fields, enforcing what's right.
With CodeSniffer in tow, and scripts to run,
Formatting fixed, the work is done!
Now every interface, crisp and clear—
The codebase shines, let’s give a cheer!
🐇✨

---

📜 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 ae601a5 and d2cd219.

📒 Files selected for processing (3)

• composer.json (1 hunks)
• phpcs.xml (1 hunks)
• src/ToArrayInterface.php (2 hunks)

🔇 Additional comments (8)

composer.json (2)

39-42: Add PHP_CodeSniffer as a development dependency
The require-dev section correctly introduces squizlabs/php_codesniffer scoped to development. Ensure the version constraint ^3.7 aligns with your project's PHP requirements and compatibility.

---

43-45: Add phpcs and phpcbf scripts
The new scripts provide convenient aliases for running the sniffer and beautifier. This will streamline code style checks and automatic fixes.

phpcs.xml (4)

1-3: Configure PHP_CodeSniffer ruleset
The XML header and ruleset declaration set the foundation for code style enforcement. Name and description are clear.

---

5-7: Enable progress output
Including the sp argument will display progress during sniffing. This improves developer feedback on long runs.

---

9-9: Specify target directory
Pointing the <file> element to src ensures all source files are checked. Consider including other directories (e.g., tests) if they should also comply.

---

12-14: Include PSR-12 standard
Referencing the PSR-12 ruleset enforces the project’s coding style. Optionally, extend with custom sniffs as the project grows.

src/ToArrayInterface.php (2)

2-2: Add blank line after PHP opening tag
PSR-12 requires one blank line after the <?php declaration.

---

12-17: Align indentation and docblock formatting
The docblock and method signature now follow 4-space indentation per PSR-12. No functional changes introduced.

✨ 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

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