Skip to content

Comments

Update CLAUDE.md with accurate repo structure and setup instructions#286

Closed
phpstan-bot wants to merge 1 commit into2.3.xfrom
update-claude-md
Closed

Update CLAUDE.md with accurate repo structure and setup instructions#286
phpstan-bot wants to merge 1 commit into2.3.xfrom
update-claude-md

Conversation

@phpstan-bot
Copy link
Contributor

Summary

The existing CLAUDE.md had several inaccuracies compared to the actual repository structure. This PR corrects them:

  • Fixed PHPStan level: Was documented as "level max" but phpstan.neon specifies level 8
  • Fixed code style description: Was documented as "PSR-12" but actually uses custom rules from phpstan/build-cs
  • Added make cs-install prerequisite: This step is required before code style checks can run, but was not documented
  • Added missing AST source files: AbstractNodeVisitor.php, Attribute.php, Comment.php, NodeAttributes.php were not listed
  • Added Doctrine annotation AST namespace: src/Ast/PhpDoc/Doctrine/ was not documented
  • Added missing test files: TokenIteratorTest.php, DifferTest.php, IntegrationPrinterWithPhpParserTest.php
  • Added Initial Setup section: Documents composer install and make cs-install as prerequisites
  • Added format-preserving printer code example from README
  • Added API reference and documentation links from README
  • Added note about PHP 7.4+ support vs phpstan-src PHP 8.1+

Test plan

  • Verify CLAUDE.md content is accurate against repo structure
  • Verify all referenced files and commands exist

🤖 Generated with Claude Code

- Fix PHPStan level (8, not max) to match phpstan.neon
- Fix code style description to reference phpstan/build-cs instead of PSR-12
- Add make cs-install prerequisite for code style checks
- Add missing AST source files (AbstractNodeVisitor, Attribute, Comment, NodeAttributes)
- Add Doctrine annotation AST namespace documentation
- Add missing test files (TokenIteratorTest, DifferTest, IntegrationPrinterWithPhpParserTest)
- Add Initial Setup section with composer install and make cs-install
- Add format-preserving printer code example from README
- Add API reference and documentation links from README
- Add note about PHP 7.4+ support vs phpstan-src PHP 8.1+
- Remove emoji from section headers

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants