Standards: introduce prepareInstalledStandardsForDisplay() method
#1054
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
This was referenced Apr 26, 2025
GaryJones
approved these changes
Apr 28, 2025
This commit introduces a new `Standards::prepareInstalledStandardsForDisplay()` method. This new method only prepares the "list" into displayable phrases. It doesn't include output formatting with new lines, that's up to the actual display. This new method allows for getting rid of some output buffering calls in select places. Includes improving the readability of the "coding standard is not installed" error. Includes deprecating the `Standards::printInstalledStandards()` method, which is now no longer used by PHPCS itself.
|
Rebased without changes. Merging once the build has passed. |
jrfnl
force-pushed
the
phpcs-4.0/feature/standards-allow-for-removing-more-output-buffering
branch
from
8f590a7 to
4b912a7
Compare
jrfnl
deleted the
phpcs-4.0/feature/standards-allow-for-removing-more-output-buffering
branch
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.
Description
This commit introduces a new
Standards::prepareInstalledStandardsForDisplay()method. This new method only prepares the "list" into displayable phrases. It doesn't include output formatting with new lines, that's up to the actual display.This new method allows for getting rid of some output buffering calls in select places.
Includes improving the readability of the "coding standard is not installed" error.
Includes deprecating the
Standards::printInstalledStandards()method, which is now no longer used by PHPCS itself.Suggested changelog entry
Deprecated:
Standards::printInstalledStandards(). Useecho Standards::prepareInstalledStandardsForDisplay()instead.Additional context
This is the readability improvement I mention above:
