4.0 | .gitattributes: ignore test files, don't ignore test framework #73
Conversation
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
jrfnl
force-pushed
the
phpcs-4.x/gitattributes-dont-ignore-test-framework-files
branch
from
ae48201 to
7541d94
Compare
jrfnl
changed the title
jrfnl
force-pushed
the
phpcs-4.x/gitattributes-dont-ignore-test-framework-files
branch
from
7541d94 to
1da2742
Compare
As of PHPCS 4.0, the tests will no longer ship in a packaged version of the repo 🎉 However, while this removes a lot of friction, it can also cause some, as quite a few external standards use the PHPCS native test framework to run their tests. To continue to do so, those external standards would now have to use `--prefer-source`, which would make their builds a lot slower and will cause extra support questions from new contributors to those standards. This commit proposes a solution to this issue by making a few small changes to the `.gitattributes` file. With these updates directives in place, the PHPCS native test _framework_ will still be included in the packaged up versions, but the test _files_ will not be. In practice, this means that the following files should still be included in a packaged up version: * `/tests/AllTests.php` * `/tests/bootstrap.php` * `/tests/FileList.php` * `/tests/TestSuite.php` * `/tests/Core/AbstractMethodUnitTest.php` * `/tests/Core/AllTests.php` * `/tests/Standards/AbstractSniffTest.php` * `/tests/Standards/AllSniffs.php` ... but that all other test files will be excluded. This removes the need for external standards to use `--prefer-source`.
jrfnl
force-pushed
the
phpcs-4.x/gitattributes-dont-ignore-test-framework-files
branch
from
1da2742 to
ba40937
Compare
fredden
approved these changes
Feb 15, 2025
jrfnl
added a commit
that referenced
this pull request
Apr 14, 2025
.. but the test _framework_ files will be. This is set up in this way to prevent external standards having to use `--prefer-source` when their (sniff) tests are using the PHPCS test framework. Fixes squizlabs/PHP_CodeSniffer 1908 Fixes squizlabs/PHP_CodeSniffer 3158 Closes #73 Fixes 636 Co-authored-by: jrfnl <[email protected]>
|
Closing as fixed via #993 |
jrfnl
deleted the
phpcs-4.x/gitattributes-dont-ignore-test-framework-files
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
As of PHPCS 4.0, the tests will no longer ship in a packaged version of the repo 🎉
However, while this removes a lot of friction, it can also cause some, as quite a few external standards use the PHPCS native test framework to run their tests. To continue to do so, those external standards would now have to use
--prefer-source, which would make their builds a lot slower and will cause extra support questions from new contributors to those standards.This commit proposes a solution to this issue by making a few small changes to the
.gitattributesfile. With these updates directives in place, the PHPCS native test framework will still be included in the packaged up versions, but the test files will not be.In practice, this means that the following files should still be included in a packaged up version:
/tests/AllTests.php/tests/bootstrap.php/tests/FileList.php/tests/TestSuite.php/tests/Core/AbstractMethodUnitTest.php/tests/Core/AllTests.php/tests/Standards/AbstractSniffTest.php/tests/Standards/AllSniffs.php... but that all other test files will be excluded.
This removes the need for external standards to use
--prefer-source.Suggested changelog entry
Update the existing changelog entry:
Related issues/external references
Fixes squizlabs/PHP_CodeSniffer#3158