Ruleset::explain(): use natural sorting #3868
Conversation
... for the list of included sniffs. The `SORT_NATURAL` and the `SORT_FLAG_CASE` flag are available since PHP 5.4, so can be used without issue.
jrfnl
force-pushed
the
feature/ruleset-explain-use-natural-sort
branch
from
f468ab7
to
1757c04
Compare
| @@ -238,7 +238,7 @@ public function __construct(Config $config) | |||
| public function explain() | |||
| { | |||
| $sniffs = array_keys($this->sniffCodes); | |||
| sort($sniffs); | |||
| sort($sniffs, (SORT_NATURAL | SORT_FLAG_CASE)); | |||
There was a problem hiding this comment.
Would using natcasesort() be more legible here?
There was a problem hiding this comment.
Good point, I'll need to check if that function was available in PHP 5.4.
There was a problem hiding this comment.
Just checked, yes, the function is available, but is still not the right choice.
natcasesort() maintains key association. sort() does not.
The foreach() loop used in the function uses the (numeric) key to determine whether the end of the array has been reached, so the array not being re-indexed could cause it to stop the loop too early or even to display sniffs with the wrong standard.
There was a problem hiding this comment.
Ah yes, I'd forgotten about that inconsistency. Thanks for checking / remembering!
There was a problem hiding this comment.
Approved. The output now shows the PSR2 before the PSR12 sniffs.
--- /tmp/master.out 2023-08-28 20:52:17
+++ /tmp/diff.out 2023-08-28 20:53:08
@@ -43,16 +43,16 @@
PEAR.WhiteSpace.ScopeClosingBrace
PEAR.WhiteSpace.ScopeIndent
-PSR12 (1 sniff)
-----------------
- PSR12.Files.OpenTag
-
PSR2 (3 sniffs)
---------------
PSR2.Classes.PropertyDeclaration
PSR2.Files.EndFileNewline
PSR2.Methods.MethodDeclaration
+PSR12 (1 sniff)
+----------------
+ PSR12.Files.OpenTag
+
Squiz (25 sniffs)
-----------------
Squiz.Arrays.ArrayBracketSpacing
|
Closing as replaced by PHPCSStandards/PHP_CodeSniffer#79 |
Description
Use natural sorting for the list of included sniffs.
The
SORT_NATURALand theSORT_FLAG_CASEflag are available since PHP 5.4, so can be used without issue.Suggested changelog entry
The -e (explain) command will now list sniffs in natural order.
Types of changes