Update wiki a17c7dcb9b318bd11011318e1cd73dbb235a86b3
111035d
Update wiki a17c7dcb9b318bd11011318e1cd73dbb235a86b3
ca8fbf2
GH Actions: Bump actions/github-script from 8.0.0 to 9.0.0 (#109)
Bumps [actions/github-script](https://github.com/actions/github-script) from 8.0.0 to 9.0.0.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/ed597411d8f924073f98dfc5c65a23a2325f34cd...3a2844b7e9c422d3c10d287c895573f7108da1b3)
---
updated-dependencies:
- dependency-name: actions/github-script
dependency-version: 9.0.0
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
04e6b96
Clarify ignore patterns in Advanced Usage documentation (#107)
Updated the ignore patterns explanation to clarify that they are case-insensitive regular expressions and provided additional details on escaping dots in file extensions.
3a6ba1c
GH Actions: Bump mshick/add-pr-comment from 2.8.2 to 3.9.0
Bumps [mshick/add-pr-comment](https://github.com/mshick/add-pr-comment) from 2.8.2 to 3.9.0.
- [Release notes](https://github.com/mshick/add-pr-comment/releases)
- [Changelog](https://github.com/mshick/add-pr-comment/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mshick/add-pr-comment/compare/b8f338c590a895d50bcbfa6c5859251edc8952fc...ffd016c7e151d97d69d21a843022fd4cd5b96fe5)
---
updated-dependencies:
- dependency-name: mshick/add-pr-comment
dependency-version: 3.9.0
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
230bd8e
Wiki/Requirements: improve information about use of iconv in reports
262f10a
Add pcntl and grpc docs (#95)
* Requirements: document PCNTL as a recommended PHP extension
* Requirements: add warning about gRPC extension and parallel processing
The gRPC PHP extension is known to cause PHP_CodeSniffer to hang
when running with parallel processing enabled.
Includes details on how to handle the gRPC extension.
Refs: PHPCSStandards/PHP_CodeSniffer#294
* Spellcheck: also ignore code blocks inside blockquotes
The existing regex pattern for ignoring code blocks only matched
blocks at the start of a line (with optional whitespace). This
update makes it also match code blocks inside markdown
blockquotes, where lines are prefixed with `>`.
3d66444
Requirements: document iconv as a recommended PHP extension
4489c03
Customisable-Sniff-Properties: remove PSR12/OperatorSpacing sniff section
As per the inline comment replacing the section:
> While PSR12.Operators.OperatorSpacing inherits the `ignoreNewlines` and `ignoreSpacingBeforeAssignments` properties
> from the `Squiz.WhiteSpace.OperatorSpacing` sniff, these properties are not handled in the PSR12 sniff,
> so are deliberately not mentioned in this documentation.
02d9e63
Configuration-Options: fix link to javascript lint
Looks like the domain has lapsed.
09594fa
Wiki: use HTTPS links
... in various places where the current URLs were redirecting to their HTTPS counterparts.
d5dca60
Update wiki 9c65916217ab605f1c4f885ca6b396d4ca872f40
b515a98
Wiki/About Standards: small tweaks for text formatting
50bf5ab
Update wiki 7b97b06c3715f34aeb86702ea7dcc073ffdd620a
c27fe82
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