Skip to content
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.

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

Generic/TraitNameSuffix: improve code coverage #659

Merged

Conversation

rodrigoprimo
Copy link
Contributor

Description

This PR improves code coverage for the Generic.NamingConventions.TraitNameSuffix sniff and adds a new inline comment to the sniff to follow the same pattern used in the AbstractClassNamePrefix sniff.

Related issues/external references

Part of #146

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

- Remove redundant tests.
- Use proper punctuation in code comments.
- Make some tests more descriptive by making the trait name reflect what
is being tested.
Doing this to be able to create tests with syntax errors on separate
files.
- Add a separate test case file with a live coding/parse error test.
- Add a new test with a comment and whitespaces in unexpected places.
This commit just adds an inline comment documenting why the sniff bails
early if there is no trait name. Doing this to follow the same pattern
used by other similar sniffs like AbstractClassName
https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/8a7ee56347bb4017ffc778a42a532cbb1651a20b/src/Standards/Generic/Sniffs/NamingConventions/AbstractClassNamePrefixSniff.php#L48
Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rodrigoprimo!

@jrfnl jrfnl merged commit 01e247b into PHPCSStandards:master Nov 1, 2024
43 checks passed
@jrfnl jrfnl deleted the test-coverage-trait-name-suffix branch November 1, 2024 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants