Allow @api annotation#44
Merged
Merged
Conversation
Why: @api is a meaningful annotation for marking public API surface (used by PHPStan, Psalm, IDEs), not a useless metadata tag like @author/@Version. Remove it from both the phpcs ForbiddenAnnotations list and the php-cs-fixer general_phpdoc_annotation_remove list, and add a valid fixture so a future re-add would fail the test suite. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
rieschl
approved these changes
May 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@apiis meaningful (used by PHPStan, Psalm, IDEs to mark public API surface), unlike the other forbidden tags (@author,@version, etc.) which Git/LICENSE already cover.@apifromSlevomatCodingStandard.Commenting.ForbiddenAnnotationsinEventjet/ruleset.xml.'api'fromgeneral_phpdoc_annotation_removeinphp-cs-fixer-rules.php.tests/fixtures/valid/api-annotation.phpso a future re-add fails the test suite.Test plan
vendor/bin/phpunit— 208 tests pass (phpcs + php-cs-fixer both accept the new fixture)🤖 Generated with Claude Code