Add PHPStan

[MekDrop]

Resolves #29

Summary by CodeRabbit

• New Features
  • Introduced PHPStan static analysis to the project, including configuration for strict code checks.
• Chores
  • Updated development dependencies and scripts to support PHPStan and simplify code quality tools.
• Refactor
  • Changed an interface method to accept an array parameter instead of variadic arguments, with improved type documentation.

[coderabbitai]

Walkthrough

The changes introduce PHPStan static analysis support to the project. This includes updating the GitHub Actions workflow to run PHPStan, adding PHPStan as a development dependency in composer.json, introducing a PHPStan configuration file, and refining the SetupStepInterface method signature for improved type specificity.

Changes

Files/Paths	Change Summary
.github/workflows/on_pull_request.yml	Added a step to run PHPStan static analysis in the pull request workflow.
composer.json	Added phpstan/phpstan as a dev dependency; updated scripts section to include phpstan command.
phpstan.neon.dist	Introduced new PHPStan configuration file with strict analysis settings.
src/SetupStepInterface.php	Changed execute method signature to accept array $params and refined its PHPDoc type.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Composer
    participant PHPStan

    Developer->>GitHub Actions: Open/Update Pull Request
    GitHub Actions->>Composer: Run "composer install"
    GitHub Actions->>Composer: Run "composer phpcs"
    GitHub Actions->>Composer: Run "composer phpstan"
    Composer->>PHPStan: Execute static analysis
    PHPStan-->>GitHub Actions: Report results

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add PHPStan support (#29)	✅

Poem

A bunny hopped with PHPStan in tow,
Now code is checked before it can go.
With static analysis, errors take flight,
Composer scripts keep things tight.
🐇✨
The code is more tidy, the workflow more bright!
— Signed, your CodeRabbit tonight

---

📜 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 b7ef5a0 and d187371.

📒 Files selected for processing (4)

• .github/workflows/on_pull_request.yml (1 hunks)
• composer.json (1 hunks)
• phpstan.neon.dist (1 hunks)
• src/SetupStepInterface.php (1 hunks)

🔇 Additional comments (7)

phpstan.neon.dist (1)

1-9: Excellent PHPStan configuration setup!

The configuration uses the strictest analysis level and properly targets the source directory while excluding vendor files. This follows PHPStan best practices for new integrations.

src/SetupStepInterface.php (2)

25-25: Improved type specificity for static analysis.

The more specific array<string, mixed> type annotation enhances PHPStan's ability to perform static analysis and catch type-related issues.

---

29-29: No implementations of SetupStepInterface detected—no action required

A search of the codebase found no classes implementing SetupStepInterface and no existing execute() definitions. Updating the method signature from variadic to array $params does not affect any current code. Ensure future implementations use the new signature.

Likely an incorrect or invalid review comment.

.github/workflows/on_pull_request.yml (1)

38-39: Well-positioned PHPStan integration in CI pipeline.

The PHPStan step is correctly placed after PHP CodeSniffer and before the production dependency installation, following CI best practices.

composer.json (3)

32-32: Good choice of PHPStan version.

PHPStan ^2.0 is a solid choice that provides the latest features and improvements for static analysis.

---

37-37: Clean and consistent script addition.

The phpstan script follows the same pattern as other tools and will work well with the PHPStan configuration file.

---

35-37: PHPCS configuration file detected

The phpcs.xml.dist file is present in the project root, so PHP CodeSniffer will automatically pick up the coding standard without needing explicit --standard flags. No further changes are required.

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