docs: updating readme

[lotyp]

Summary by CodeRabbit

• Documentation

  • Updated README with new commands for code style checks and fixes.
  • Added instructions for setting up GitHub Actions.

• Chores

  • Added keywords to composer.json for better discoverability.
  • Updated .gitignore to exclude build files.

[coderabbitai]

Walkthrough

The changes introduce PHP-CS-Fixer configurations and commands to the project. This includes updating composer.json with new scripts for code style checks, modifying the .php-cs-fixer.dist.php configuration file, and updating the README.md with instructions on how to use these new tools. Additionally, keywords related to code quality and static analysis were added to composer.json, and a .gitignore update was made to exclude build artifacts.

Changes

Files	Change Summary
README.md	Added commands and instructions for using PHP-CS-Fixer and linting.
composer.json	Added new scripts for code style checks and relevant keywords.
.php-cs-fixer.dist.php	Updated configuration with strict types, cache file, and necessary imports.
.gitignore	Added .build/ folder to ignore list.

🐇✨

In lines of code, we find our grace,
With tools that keep a tidy space.
PHP-CS-Fixer leads the way,
Ensuring style in work and play.
Clean code, our goal, we do embrace,
With every change, a better place.

🌟💻

---

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

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

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.41%. Comparing base (de8364c) to head (c0add68).

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #268   +/-   ##
=========================================
  Coverage     55.41%   55.41%           
  Complexity       18       18           
=========================================
  Files             3        3           
  Lines           240      240           
=========================================
  Hits            133      133           
  Misses          107      107           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

README.md (1)

Line range hint 162-162: Consider using a more formal tone in the invitation for contributions.

- If you want to:
+ Should you wish to:

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between de8364c and c0add68.

Files selected for processing (3)

• .pre-commit-config.yaml (1 hunks)
• README.md (3 hunks)
• composer.json (1 hunks)

Files skipped from review due to trivial changes (2)

• .pre-commit-config.yaml
• composer.json

Additional Context Used

LanguageTool (1)

README.md (1)

Near line 162: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...are open to all kinds of contributions. If you want to: - 🤔 [Suggest a feature](https://gith...

Additional comments not posted (6)

README.md (6)

30-33: The introduction clearly explains the purpose and benefits of using the PHP-CS-Fixer in projects. This aligns well with the PR objectives.

---

47-47: The installation command is correctly formatted and uses the appropriate package name.

---

56-80: The configuration example is comprehensive and well-documented. It correctly demonstrates how to set up the .php-cs-fixer.dist.php file with necessary configurations and cache settings.

---

87-93: The addition of the cs:diff and cs:fix scripts to the composer.json is a practical enhancement for users to easily run PHP-CS-Fixer. Ensure these script names are consistently referenced throughout the documentation.

Verification successful

---

The rg command output indicates that the script names cs:diff and cs:fix are mentioned in the README.md file. To ensure these references are consistent and correctly guide the user, let's review the specific lines in the README.md where these script names are mentioned.

Review of README.md

• Line 87-93:

  {
      "scripts": {
          "cs:diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff",
          "cs:fix": "php vendor/bin/php-cs-fixer fix -v"
      }
  }

• Other mentions:

  composer cs:diff
  composer cs:fix
  

These references appear to be consistent and correctly guide the user on how to use the cs:diff and cs:fix scripts.

Conclusion

The script names cs:diff and cs:fix are consistently referenced in the README.md file.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify consistent usage of script names in documentation.

# Test: Search for script names in the README.md. Expect: Consistent references.
rg --type markdown $'cs:diff|cs:fix' README.md

Length of output: 217

---

100-102: The update to .gitignore to exclude the .build directory is a necessary change given the new cache file settings in the .php-cs-fixer.dist.php.

---

117-117: The usage instructions for running PHP-CS-Fixer directly and via Composer scripts or Makefile are clear and provide users with multiple options to integrate the tool into their workflow.

Also applies to: 127-127, 133-133, 143-143, 149-149