search

yamadashy / phpstan-friendly-formatter

🤝 A friendly error formatter extension for PHPStan that provides more readable and informative output, including code snippets and color highlighting.
https://packagist.org/packages/yamadashy/phpstan-friendly-formatter
MIT License
47 stars 1 forks source link

Use errorFormat parameter in README #6

Closed szepeviktor closed 1 month ago

szepeviktor commented 1 month ago

... and correct a typo: "Finaly"

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve updating the instructions in the README.md file related to configuring PHPStan's error formatting. The previous method of using the PHPStan console command with the --error-format option has been replaced with a new approach that allows users to set the errorFormat parameter directly in a configuration file using the Neon format. This modification aims to streamline the configuration process.

Changes

File Change Summary
README.md Updated instructions for configuring PHPStan's error formatting; removed command line example and added configuration block for setting errorFormat to "friendly".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PHPStan
    participant ConfigFile

    User->>ConfigFile: Modify errorFormat parameter
    ConfigFile->>PHPStan: Load configuration
    PHPStan->>User: Display errors in friendly format
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between da0cdb8eeb83433358a41a7f7b41f6e04a31d969 and 80d23f71a8d456b6538e9d8d6b30ff320406549b.
Files selected for processing (1) * README.md (1 hunks)
Additional comments not posted (1)
README.md (1)
`39-42`: **LGTM! The changes improve the documentation.** The new instructions for setting the `errorFormat` parameter are clear and accurate. They align well with the PR objectives by incorporating the use of the errorFormat parameter in the README. The typographical error has been corrected, and the changes provide a more standardized approach to configuring the error format.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `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 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 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 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
> [!TIP] >
> Early access features: enabled > > We are currently testing new code review model(s) that may lead to higher noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. > > Note: > > - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. > >
yamadashy commented 1 month ago

Thank you for this excellent contribution, @szepeviktor!

You're right, it's indeed better to set this in the config rather than specifying it every time on the command line. I appreciate your attention to detail in correcting the typo as well.

I'm happy to merge this pull request. Thanks again for your valuable input!

szepeviktor commented 1 month ago

Glad to contribute.