Skip to content

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jul 15, 2025

Description

Update the docs for change PHPCSStandards/PHP_CodeSniffer#1015

Notes:

  1. I've toned down the indentation a little to reduce the need for vertical scrolling.
    This is in line with how these output samples were previously presented in the wiki.
  2. And while I am adding a annotated-ruleset/debug-output.php file which can be used to generate these output samples to the build/wiki-code-samples directory, at this time, we cannot yet selectively only retrieve the desired output for this documentation, so we cannot automate updating these output blocks.
    This will hopefully change in the foreseeable future once PHPCSStandards/PHP_CodeSniffer 1030 has been implemented, though as there is also a textual part which refers to line numbers in the output blocks, manually updating these output blocks may still be the more stable way.
    For the "Verbose Token Processing Output" I've added a comment to document how to retrieve the desired output to update this output block.
    I've used the PEAR standard, not the PSR12 standard to keep the output within reasonable bounds.

…tion

Notes:
1. I've toned down the indentation a little to reduce the need for vertical scrolling.
    This is in line with how these output samples were previously presented in the wiki.
2. And while I _am_ adding a `annotated-ruleset/debug-output.php` file which can be used to generate these output samples to the `build/wiki-code-samples` directory, at this time, we cannot yet selectively only retrieve the desired output for this documentation, so we cannot automate updating these output blocks.
    This will hopefully change in the foreseeable future once PHPCSStandards/PHP_CodeSniffer 1030 has been implemented, though as there is also a textual part which refers to line numbers in the output blocks, manually updating these output blocks may still be the more stable way.
    For the "Verbose Token Processing Output" I've added a comment to document how to retrieve the desired output to update this output block.
    I've used the `PEAR` standard, not the `PSR12` standard to keep the output within reasonable bounds.
Copy link

Thank you for your PR.
A dry-run has been executed on your PR, executing all markdown pre-processing for the wiki files.

Please review the resulting final markdown files via the created artifact.
This is especially important when adding new pages or updating auto-generated output blocks.

N.B.: the above link will automatically be updated when this PR is updated.

@jrfnl jrfnl marked this pull request as ready for review September 15, 2025 10:20
@jrfnl jrfnl merged commit b57133c into main Sep 16, 2025
16 checks passed
@jrfnl jrfnl deleted the wiki/phpcs-4.0/advanced-usage-update-for-tokenization-change branch September 16, 2025 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

1 participant