feat: Add usage instructions and configuration details for phpstan.neon in README.md.
#18
Conversation
…eon` in `README.md`.
WalkthroughA new "Usage" section was added to the README.md file, outlining step-by-step instructions for configuring the extension within the Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
51-51: Replace hard tabs with spaces in the code block
The snippet currently uses hard tabs for indentation (MD010). For consistency and markdownlint compliance, convert tabs to spaces—e.g. 4 spaces per indent level.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
73-73: Clarify or remove the misplaced composer.json instruction
The sentence “to the require-dev section of yourcomposer.jsonfile.” appears after the PHPStan config block and is confusing (it implies adding these lines to composer.json). Either remove it or reword to point back to installation, e.g.:Finally, ensure the extension is listed under
require-devin yourcomposer.json(see Installation above).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
49-72: Replace hard tabs with spaces and unify indentation. Lines within the code block (e.g., line 51) use hard tabs, triggering markdownlint MD010. Please replace tabs with 4 spaces for consistent formatting, and consider switching the fence language fromneontoyamlfor broader syntax highlighting support.
Example diff:```yaml -includes: - - vendor/yii2-extensions/phpstan/extension.neon +includes: + - vendor/yii2-extensions/phpstan/extension.neon<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 51-51: Hard tabs Column: 1 (MD010, no-hard-tabs) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 258dd87912c76d3e213f2f7b4f248c2c06c1f8a9 and 2907f15f2ee4f9a6377493dea45c21076603e359. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>README.md</summary> 51-51: Hard tabs Column: 1 (MD010, no-hard-tabs) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>README.md (1)</summary> `45-48`: **Usage section addition is clear and helpful.** The new “## Usage” section concisely explains where and how to add the `phpstan.neon` configuration snippet. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
…r.json` in `README.md`
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
51-51: Replace hard tabs with spacesLine 51 begins with a hard tab, which triggers markdownlint MD010 (“no-hard-tabs”). Please convert any tabs to spaces for consistent indentation in the fenced
neonblock.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🔇 Additional comments (1)
README.md (1)
45-72: Well-documented usage instructionsThe newly added Usage section clearly walks users through setting up the extension in
phpstan.neon, covering all required includes, bootstrap files, dynamic constants, analysis level, source paths, Yii2 scan files, and the config path.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
Summary by CodeRabbit