Configuration Options: add missing line break
a1d1201
Advanced Usage: fix broken link
0d08a96
Configuration Options: minor readability improvements
c243b02
4.0 | Wiki/User upgrade guide: update information about branch rename
c02349b
4.0 | Wiki: updates for change of the default standard from PEAR to PSR12
Includes automating various output example blocks via the automated replacement mechanism.
:warning: This commit should only be merged AFTER the PHPCS 4.0 release! The code samples used for the auto-generated output are specifically crafted to give errors/warnings against PSR12, not against the PEAR standard. :warning:
Note: this also means that the artifact containing the preprocessed output will need to be regenerated after the PHPCS 4.0 release to get an accurate representation of the updated wiki pages.
Where auto-generated output blocks was not an option, like when the output block in the documentation only displays part of a larger output stream, the command used to manually update the existing output block has been added as an inline comment.
Regarding the "diff" report - even with manually installing DiffUtils in GH Actions, the report does not display, so unless someone figures out why, this will need to be manually updated.
As for the "info" report, while this could be auto-generated using something like `{{COMMAND-OUTPUT "phpcs --parallel=1 --no-cache --no-colors --report-width=100 --report=info --basepath=build/wiki-code-samples build/wiki-code-samples/path/to/code/fileB.php build/wiki-code-samples/path/to/code/fileC.php"}}`, I believe the existing report example demonstrates the usecase for this report better, so I have deliberately not updated it.
Also not that for the "interactive" reporting code sample, I'm cheating a bit as interactive mode obviously cannot be auto-generated without user interaction, but we do know what the report should look like ;-)
b693006
4.0 | Wiki: update for removal of CSS/JS support in sniffs
d2cb5eb
4.0 | Wiki/Advanced Usage: update for change in PHP open tag tokenization
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.
a4c9029
4.0 | Wiki/Annotated-Ruleset: update information about deprecated/removed array property syntax
a7fba0e
4.0 | Wiki/FAQ: remove text about warning for parse errors
176728f
4.0 | Wiki/Customisable Properties: update for removed properties
c9de7ca
4.0 | Wiki: update for removed sniffs using external tooling
a55ed2e
4.0 | Wiki/Advanced Usage: update information about deprecated/removed ignore annotations
35bc4bf
4.0 | Wiki/Requirements: minimum PHP version is now 7.2.0
Includes some readability updates.
9af95db
Update wiki 544980c947781b7145c0dfa9dfdb11b9438739ed
a2ce8a9
4.0 dev upgrade guide: add section about the new parameter types
As per the proposal in PHPCSStandards/PHP_CodeSniffer 390 and executed in PHPCSStandards/PHP_CodeSniffer 1237.
95da492
4.0 dev upgrade guide: update for the change in tokenization of fully qualified exit/die/true/false/null
As per the proposal in PHPCSStandards/PHP_CodeSniffer 1201 and executed in PHPCSStandards/PHP_CodeSniffer 1206 (for 3.x, the implementation will change for 4.x in the "merge-up" to the 4.x branch.
bb496ac
a366ac3
4.0 | Wiki/Advanced-Usage: add the cumulative exit codes (#51)
- Added a table with the cumulative exit codes as documented in the interim proposal (https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/184#issuecomment-2644329771).
This ensures a complete exit code documentation where users and devs can easily read exactly what the cumulative exit codes are.
- Also added another description to the `0` exit code to describe when issues are fixed with no issues remaining, because "clean code base" could just be interpreted as no issues at all.
399a274
PHPCS 4.0 Dev upgrade guide: document PHPCS PR 1193 (#48)
PHPCS PR 1193 makes a small change in how empty string array keys are handled in PHPCS 3.x (as numeric keys) and when this will be merged up into 4.x, an additional change will be made to respect empty string array keys.
This commit documents this change in the Dev upgrade guide for 4.0.
Co-authored-by: jrfnl <[email protected] >
f58f9eb
Minor fixes and adjustments to the PHPCS 4.0 upgrade guides (#44)
29e82c1
Wiki/User Upgrade Guide: add some extra links
536b44f
Wiki/Reporting: update example output for `gitblame` reports
The generation of the output examples for the `gitblame` report cannot easily be automated for the following reasons:
1. If using code samples committed to this repo, there would (for now) only be one author, making the output example not a very good example.
2. If generating these output examples from an existing codebase, there may be privacy issues in play when using the handles/names of real developers.
All in all, for now, the output has been manually updated to use the current report format, but using fake data.
e8d1ca1
Wiki/Tutorial: update example output for the sniff
6e509c0
Wiki/Fixing-errors: update example output from `phpcbf`
972c6d3
GH Actions: add automation for generating output examples for the wiki (#20)
* GH Actions: prepare the workflow for auto-generating output snippets
* Run phpcs/phpcbf commands to auto-generate output blocks
* GH Actions/basic QA: add shellcheck job
As this repo now contains a shell script to find & replace placeholders for output snippets in the wiki files with real output, let's also run a minimal QA check on the code of the shell script.
Refs:
* https://github.com/koalaman/shellcheck
* https://github.com/koalaman/shellcheck/wiki
---------
Co-authored-by: jrfnl <[email protected] >
Co-authored-by: Dan Wallis <[email protected] >
00e017c
Wiki: improve readability for the 4.0 upgrade guides
The GitHub wiki markdown parser does not handle new lines in the same way as the markdown parser used, for instance, for GitHub issues.
The net effect of this, is that when there is a blank line between two sentences, the sentences will be formatted as separate paragraphs, but if there is only a new line between two sentences, they will be joined together into one long paragraph.
So using a new line will not enforce a "soft break" (`<br/>`) within a paragraph.
To get a "soft break" with the GH wiki markdown parser, you need two trailing spaces at the end of a sentence.
The trouble with that, is, of course, that a lot of editors will automatically try to remove these kind of trailing spaces, but so be it. Just means reviewers need to be extra careful about this.
e6ef29b
Wiki: always have filenames in backticks
Hoping I've caught them all, but not claiming completeness.
7f83b1c
Wiki/Reporting: improve report display
3853b05
Wiki/Advanced-Usage: update example output from `--config-show`
As the PHPCS installation used in GH Actions won't have a `CodeSniffer.conf` file yet, this cannot be automated.
Aside from that, automating this would yield inconsistent results when contributors would run the command output replacement script locally.
Replacing it now with a manually crafted, updated output example.
081cc1b
Wiki/Usage: update paths in commands
The `CodeSniffer` directory is a directory from way back in PHPCS 2.0 and is not really relevant to these output examples anyway, so let's use more generic names.
f11cde5