Skip to content

feat(phpstan): add separate ID capitalization rules for variables, parameters, methods, and classes #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
spawnia merged 18 commits into from
Dec 8, 2025
Merged

feat(phpstan): add separate ID capitalization rules for variables, parameters, methods, and classes #64

spawnia merged 18 commits into from
Dec 8, 2025

Conversation

@simbig
Copy link
Contributor

@simbig simbig commented Dec 4, 2025 •
edited
Loading

Summary

  • Add separate PHPStan rules for checking "ID" vs "Id" capitalization:
    • VariableNameIdToIDRule - checks variable names
    • ParameterNameIdToIDRule - checks parameter names
    • MethodNameIdToIDRule - checks method names
    • ClassNameIdToIDRule - checks class names
  • Refactor to abstract CapitalizationOfIDRule base class with shared logic
  • Each rule has its own error identifier for granular baseline control

Usage

Add rules individually to your phpstan.neon:

rules:
    - MLL\Utils\PHPStan\Rules\VariableNameIdToIDRule
    # Enable others as needed:
    # - MLL\Utils\PHPStan\Rules\ParameterNameIdToIDRule
    # - MLL\Utils\PHPStan\Rules\MethodNameIdToIDRule
    # - MLL\Utils\PHPStan\Rules\ClassNameIdToIDRule

Error Identifiers

  • mll.variableNameIdToID
  • mll.parameterNameIdToID
  • mll.methodNameIdToID
  • mll.classNameIdToID

Test plan

  • All existing tests pass
  • Integration tests using PHPStanTestCase
  • PHPStan analysis passes
  • make runs successfully

🤖 Generated with Claude Code

@claude
feat(phpstan): add configurable CapitalizationOfIDRule for extended I…
0600a50 
…D capitalization checking

- Add CapitalizationOfIDRule that can check variables, parameters, methods, and classes
- Refactor VariableNameIdToIDRule to extend CapitalizationOfIDRule with variables-only config
- Add NodeNameExtractor interface with focused implementations for each node type
- Cache extractors in constructor for better performance
- Add 'Identity' to false positives list
- Add PHPStan neon configuration support via mllCapitalizationOfID parameters

BREAKING CHANGE: None - VariableNameIdToIDRule maintains backwards compatibility

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@simbig simbig force-pushed the extend-variable-name-id-rule branch from 0303166 to 0600a50 Compare December 4, 2025 17:13
@claude
test: add integration tests for CapitalizationOfIDRule
bef2ac9 
Add integration tests that run PHPStan CLI against fixture files to verify
the rule correctly detects ID capitalization violations in methods,
parameters, and variables.

- Add WrongCapitalization.php fixture with intentional violations
- Add CorrectCapitalization.php fixture to verify no false positives
- Add CapitalizationOfIDRuleIntegrationTest that uses PHPStan CLI
- Ignore fixture files in phpstan.neon to prevent false positives during
  normal analysis

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@simbig simbig force-pushed the extend-variable-name-id-rule branch from dfd03ac to bef2ac9 Compare December 4, 2025 18:49
Simon Bigelmayr and others added 2 commits December 5, 2025 08:32
@claude
refactor(tests): restructure PHPStan tests to match laravel-utils pat…
755469e 
…tern

- Move PHPStan tests from tests/PHPStan/Rules/ to tests/PHPStan/
- Replace CLI-based integration test with PHPStanTestCase-based test
- Rename Fixtures/ to data/ to match laravel-utils convention
- Keep unit tests for static methods (containsWrongIDCapitalization,
  fixIDCapitalization) separate from integration tests
- Update phpstan.neon ignore path for test data files

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
refactor(phpstan): split CapitalizationOfIDRule into separate rules p…
becaca2 
…er node type

Split the configurable CapitalizationOfIDRule into focused, single-purpose rules:
- VariableNameIdToIDRule (checks variables)
- ParameterNameIdToIDRule (checks parameters)
- MethodNameIdToIDRule (checks methods)
- ClassNameIdToIDRule (checks classes)

This follows PHPStan community patterns (phpstan-strict-rules) and enables
gradual rollout via PHPStan baseline - each rule can be enabled independently.

Changes:
- Convert CapitalizationOfIDRule to abstract base class
- Create separate concrete rules for each node type
- Remove NodeNameExtractor classes (no longer needed)
- Simplify extension.neon (remove parametersSchema, conditionalTags)
- Update tests for new structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@simbig simbig changed the title feat(phpstan): add configurable CapitalizationOfIDRule feat(phpstan): add separate ID capitalization rules for variables, parameters, methods, and classes Dec 5, 2025
Simon Bigelmayr and others added 9 commits December 5, 2025 09:18
@claude
fix: address PR review feedback
2731919 
- Add formatNameForMessage() hook for custom name formatting in error messages
- Restore $ prefix for variable names in error messages
- Remove unused imports from integration test
- Add class name test fixture (LabIdProcessor) to test ClassNameIdToIDRule

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
fix: move PHPStan API ignores to config file per MLL guidelines
1e55765 
MLL guidelines prohibit @phpstan-ignore-line and @phpstan-ignore-next-line.
Move phpstanApi.method and phpstanApi.classConstant ignores to phpstan.neon
for the tests/PHPStan/ directory.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
style: one method call per line per MLL guidelines
a4dd413 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
style: apply one thing per line guideline to integration test
40a25c1 
Extract method call results to variables before using them as
function parameters or in method chains.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
style: remove unnecessary comments explaining obvious code
1f37cf8 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
style: remove class docblocks that restate class names
dbe69a2 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
fix: add $ prefix to parameter names in error messages
96a489d 
Parameters are written with $ in PHP, so the error message should
show "$labId" not "labId" for consistency with variable errors.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
test: delete trivial VariableNameIdToIDRuleTest
b26da93 
Testing that getNodeType() returns a constant is pointless - no logic
is involved. The integration test already verifies rules work on actual
files, and CapitalizationOfIDRuleTest covers the shared detection logic.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
fix: use message-based PHPStan ignore for backwards compatibility
36e42ea 
The `identifier:` syntax is not supported in older PHPStan versions
used with PHP 7.4. Use message pattern matching instead.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@simbig simbig requested a review from spawnia December 5, 2025 10:21
spawnia
spawnia reviewed Dec 5, 2025
View reviewed changes
@claude
fix: address PR review feedback
c852b9b 
- Remove misleading comment from extension.neon
- Replace \Safe\preg_match with Str::contains for consistency
- Override fixIDCapitalization in ClassNameIdToIDRule (Id -> ID for classes)
- Format test arrays with one item per line
- Use array<T> notation consistently in PHPDoc
- Add test case for $id not causing an error
- Add ClassNameIdToIDRuleTest for Id -> ID behavior

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@simbig simbig force-pushed the extend-variable-name-id-rule branch from 8df9394 to c852b9b Compare December 5, 2025 14:42
@simbig simbig requested a review from spawnia December 5, 2025 14:46
spawnia
spawnia reviewed Dec 5, 2025
View reviewed changes
@simbig simbig requested a review from spawnia December 8, 2025 11:00
@spawnia spawnia merged commit 02b2f53 into master Dec 8, 2025
28 checks passed
@spawnia spawnia deleted the extend-variable-name-id-rule branch December 8, 2025 13:37
github-actions bot pushed a commit that referenced this pull request Dec 8, 2025
@semantic-release-bot
chore(release): 5.23.0 [skip ci]
e15a484 
# [5.23.0](v5.22.0...v5.23.0) (2025-12-08)

### Features

* **phpstan:** add separate ID capitalization rules for variables, parameters, methods, and classes ([#64](#64)) ([02b2f53](02b2f53))
@github-actions
Copy link

github-actions bot commented Dec 8, 2025

🎉 This PR is included in version 5.23.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@spawnia spawnia mentioned this pull request Dec 8, 2025
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@spawnia spawnia Awaiting requested review from spawnia

Assignees

No one assigned

Labels

released

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@simbig @spawnia