Added testing of embedded PHP snippets#3166
Open
mnocon wants to merge 6 commits into
Open
Conversation
|
Preview of modified files: Too many files modified in a single PR, preview link list is skipped. (339 files > 150) |
mnocon
changed the title
mnocon
force-pushed
the
test-php-snippets
branch
3 times, most recently
from
2e6778b to
84ab43c
Compare
|
mnocon
force-pushed
the
test-php-snippets
branch
3 times, most recently
from
1bff95b to
5150030
Compare
mnocon
force-pushed
the
test-php-snippets
branch
3 times, most recently
from
02b34ef to
c72a5c4
Compare
mnocon
force-pushed
the
test-php-snippets
branch
2 times, most recently
from
e00a7df to
3c8d5ef
Compare
adriendupuis
reviewed
Jul 2, 2026
|
|
||
| // Clean up the output directory from the previous run to avoid stale files | ||
| // (e.g. from docs that were renamed, moved, or had snippets removed). | ||
| removeDirectory(OUTPUT_DIR); |
Contributor
There was a problem hiding this comment.
I feel like this OUTPUT_DIR could be used for cache but I don't see how. The code must be extracted and the hash computed to know that the extraction file already exist, so the time is lost anyway. Afterward, there the php-cs-fixer.cache that might remember already checked files.
Contributor
There was a problem hiding this comment.
No error to catch there if the directory can't be removed?
adriendupuis
reviewed
Jul 3, 2026
Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
adriendupuis
approved these changes
Jul 3, 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.
This PR makes it possible to run code quality checks (PHPStan, CS-Fixer, Rector, Deptrac) on embedded PHP code samples.
It build upon the code samples extraction mechanism added in #3165
Thanks to this, we no longer need to extract the code samples to separate files - they can stay within the Markdown files, making it easier to work with them, while keeping the advantage of the code quality tools.
How it works
Before a code quality tool is run, the code samples are extracted from Markdown files.
They are not extracted if:
{skip-validation}The rest of them are extracted to
code_samples/_inline_phpfor the tools to pick up.When the tool can automatically fix the issue (CS-Fixer, Rector), the changes are synced back to the Markdown files.
All the existing inline code samples are marked with
{skip-validation}, a special attribute to disable the code sample checking.This keeps this PR small and allow us using this for new content - the fixing of code samples will be done in a follow-up (#3206)