text to translate', 'my-slug' );
+__( 'text to
translate', 'my-slug' );
+__( 'text < to translate', 'my-slug' );
+__( 'text to > translate', 'my-slug' );
+__( '
my address
', 'my-slug' );
+__( '
text to translate
', 'my-slug' );
+__( '<>text to translate', 'my-slug' );
+__( '<>text to translate<>', 'my-slug' );
+__( '
', 'my-slug' );
+__( '<<>>text to translate<<>', 'my-slug' );
+__( '<<>>123', 'my-slug' );
+__( '
Foo', 'my-slug' );
+__( '
Foo', 'my-slug' );
+__( '
Foo', 'my-slug' );
+
+// Test handling of more complex embedded variables and expressions. All of these should throw an error.
+__( "${foo}", 'my-slug' );
+__( "{$foo['bar']}", 'my-slug' );
+__( "{$foo->bar()}", 'my-slug' );
+__( "{$foo['bar']->baz()()}", 'my-slug' );
+__( "${foo->bar}", 'my-slug' );
+__( "${foo["${bar['baz']}"]}", 'my-slug' );
+
+// Safeguard defensive coding.
+__( /* comment */, 'my-slug' ); // Bad, missing first param (parse error).
+
+// phpcs:set WordPress.WP.I18n text_domain[] default
+
+// Safeguard that a comment after a "default" text domain is not removed.
+__( 'String default text domain.' /*comment*/ ); // Warning, text domain can be omitted.
+
+// Test mismatched placeholders.
+_n_noop( 'I have %1$d cat and %2$d dog.' ); // Bad, missing $plural argument, ignore for single/plural placeholder check.
+_n_noop( 'I have %1$d cat and %2$d dog.', $plural ); // Bad, non singular string $plural argument, ignore for single/plural placeholder check.
+_n_noop( 'I have %1$d cat and %2$d dog.', $plural . $text ); // Bad, non singular string $plural argument, ignore for single/plural placeholder check.
+
+_n_noop( 'I have %1$d cat and %2$d dog.', 'I have %1$d cats and %2$d dog.' ); // Ok.
+_n_noop( 'I have %2$d cat and %1$d dog.', 'I have %1$d cats and %2$d dog.' ); // Ok, or at least not something we flag.
+_n_noop( 'I have %1$d cat and %3$d dog.', 'I have %1$d cats and %2$d dog.' ); // Bad, different placeholders used in single vs plural text.
+_n_noop( 'I have %1$d cat, %2$d dog and %3$d canaries.', 'I have %1$d cats, %2$d dog and canaries.' ); // Bad, mismatched placeholders count.
+_n_noop( 'I have %1$d cat, %2$d dog and %3$d canaries.', 'I have %1$d cats, %2$d dog and canaries.' ); // Bad, mismatched numbered placeholders count.
+_n_noop( 'I have %1$d cat, %2$d dog and %2$d canaries.', 'I have %1$d cats, %2$d dog and canaries.' ); // Bad, mismatched numbered placeholders count.
+
+/*
+ * Safeguard support for PHP 8.0+ named parameters.
+ * Each of these function calls uses named parameters with an unconventional param order to test this properly.
+ */
+// phpcs:set WordPress.WP.I18n text_domain[] my-slug
+translate( domain: 'my-slug', text: 'translate me', extra: 'default' ); // Bad: too many arguments + use of translate().
+__( domain: 'my-slug' ); // Bad: missing $text argument.
+__( single: 'translate me', domain: 'my-slug' ); // Bad: missing $text argument (invalid 'single' named arg).
+esc_attr__(
+ domain: 'my-slug',
+ text: 'translate
+me multi line', // OK, multi-line text string.
+);
+esc_html__(
+ domain: PLUGIN_TEXTDOMAIN, // Bad: not single text string literal.
+ text: 'translate ' . 'me', // Bad: not single text string literal.
+);
+_e(
+ domain: 'my-slug',
+ text: $translateMe, // Bad: not single text string literal.
+);
+esc_attr_e(
+ domain: 'my-slug',
+ text: "translate
+$me multi line", // Bad: interpolated variable found.
+);
+esc_html_e(
+ domain: 'different-slug', // Bad: wrong text domain.
+ text: 'translate me',
+);
+esc_html_x(
+ context: 'context',
+ domain: 'my-slug',
+ text: 'trans %s late %1$s me', // Bad: mixing ordered and non-ordered placeholders.
+);
+_x( context: 'context', text: 'translate %1$s me %2$s', domain: 'my-slug' ); // Bad: multiple placeholders, but no ordering.
+_ex( domain: 'my-slug', text: '%s', context: 'context', ); // Bad: no translatable content.
+esc_attr_x( domain: 'my-slug', context: 'context', text: 'translate me
', ); // Bad: wrapped in HTML.
+_n( number: $i, domain: 'my-slug', single: 'translate me', plural: 'translate %s me' ); // Bad: missing singular placeholder.
+_nx( number: $i, domain: 'my-slug', plural: 'translate %s me', single: 'translate %1$s me', context: 'context', ); // Bad: mismatch between single/plural placeholders.
+
+// Safeguard that the SuperfluousDefaultTextDomain fixer handles trailing commas correctly.
+// Note: if the original code contained a trailing comma, it is fine for the fixed code to also contain a trailing comma.
+// phpcs:set WordPress.WP.I18n text_domain[] default
+__( 'translate me', ); // Bad: superfluous domain (positional with trailing comma).
+__( 'translate me' /*comment*/, ); // Bad: superfluous domain (positional with trailing comma and comment).
+
+// Safeguard handling of named params by the SuperfluousDefaultTextDomain fixer.
+__( text: 'translate me' ); // Bad: superfluous domain.
+__( text: 'translate me', ); // Bad: superfluous domain (with trailing comma).
+_n_noop( singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me' /*comment*/, plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
+// These should not be auto-fixable as we don't want to remove the comment.
+__( text: 'translate me', domain: /*comment*/ 'default' ); // Bad: superfluous domain.
+_n_noop( domain: 'default' /*comment*/, singular: 'translate me', plural: 'translate me', ); // Bad: superfluous domain.
+_nx_noop( singular: 'translate me', domain /*comment*/: 'default', plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
+
+// Safeguard bug fix: replacing placeholders in multi-line text strings.
+_nx( 'I have
+%1$d cat and %2$d dog.', 'I have
+%1$d cats and %2$d dogs.', $number, 'Not
+really.' ); // Bad, multiple arguments should be numbered.
+
+// Show an error when the text domain is an empty string.
+esc_html_e( 'foo', '' ); // Bad: text domain mismatch.
+
+// Issue #1948 - Show an error when the text domain is an empty string and no text domain has been passed.
+// phpcs:set WordPress.WP.I18n text_domain[]
+esc_html_e( 'foo', '' ); // Bad: text-domain can not be empty.
+
+// PHP 8.0+: safeguard handling of newly introduced placeholders.
+__( 'There are %1$h monkeys in the %H', 'my-slug' ); // Bad: multiple arguments should be numbered.
+
+// phpcs:enable WordPress.WP.I18n.MissingTranslatorsComment
diff --git a/WordPress/Tests/WP/I18nUnitTest.2.inc b/WordPress/Tests/WP/I18nUnitTest.2.inc
index 4ad5e2895b..dd5c246215 100644
--- a/WordPress/Tests/WP/I18nUnitTest.2.inc
+++ b/WordPress/Tests/WP/I18nUnitTest.2.inc
@@ -2,7 +2,7 @@
/*
* Test sniffing for translator comments.
*/
-// @codingStandardsChangeSetting WordPress.WP.I18n text_domain my-slug
+// phpcs:set WordPress.WP.I18n text_domain[] my-slug
/* Basic test ****************************************************************/
__( 'No placeholders here.', 'my-slug' ); // Ok, no placeholders, so no translators comment needed.
@@ -107,4 +107,22 @@ _e(); // Bad.
// phpcs:ignore Standard.Category.Sniff -- testing that the PHPCS annotations are handled correctly.
printf( __( 'There are %1$d monkeys in the %2$s', 'my-slug' ), intval( $number ), esc_html( $string ) ); // Bad.
-// @codingStandardsChangeSetting WordPress.WP.I18n text_domain false
+__( $notStringLiteral, 'my-slug' ); // Ignore for translators comment, $text not single string literal.
+__( 'text %s' . 'more text', 'my-slug' ); // Ignore for translators comment, $text not single string literal.
+
+
+/*
+ * Safeguard support for PHP 8.0+ named parameters.
+ */
+/* translators: %d: number of cats. */
+_n_noop( domain: 'my-slug', singular: 'I have %d cat.', plural: "I have %d cats.", ); // OK.
+
+esc_attr_e( domain: 'my-slug', translate: 'Text to translate to %1$d languages.' ); // Bad, missing $text param, missing translators comment is ignored.
+
+_n_noop( // Bad, missing translators comment.
+ domain: 'my-slug',
+ plural: "I have %d cats.",
+ singular: 'I have %d cat.',
+);
+
+// phpcs:set WordPress.WP.I18n text_domain[]
diff --git a/WordPress/Tests/WP/I18nUnitTest.3.inc b/WordPress/Tests/WP/I18nUnitTest.3.inc
index bac1dadca7..afcc9fe5fa 100644
--- a/WordPress/Tests/WP/I18nUnitTest.3.inc
+++ b/WordPress/Tests/WP/I18nUnitTest.3.inc
@@ -19,3 +19,9 @@ __( 'string', "something-$domain" ); // Bad, shouldn't use variable for domain.
__( 'string', 'something-else' ); // Bad, text domain mismatch.
__( 'string', "something-else" ); // Bad, text domain mismatch.
+
+/*
+ * Safeguard support for PHP 8.0+ named parameters.
+ */
+__( domain: 'something', text: 'string', ); // OK.
+__( domain: 'something-else', text: 'string', ); // Bad, text domain mismatch.
diff --git a/WordPress/Tests/WP/I18nUnitTest.php b/WordPress/Tests/WP/I18nUnitTest.php
index 6dc1c4a098..3834eb189f 100644
--- a/WordPress/Tests/WP/I18nUnitTest.php
+++ b/WordPress/Tests/WP/I18nUnitTest.php
@@ -3,48 +3,27 @@
* Unit test class for WordPress Coding Standard.
*
* @package WPCS\WordPressCodingStandards
- * @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
+ * @link https://github.com/WordPress/WordPress-Coding-Standards
* @license https://opensource.org/licenses/MIT MIT
*/
-namespace WordPress\Tests\WP;
+namespace WordPressCS\WordPress\Tests\WP;
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
-use WordPress\PHPCSHelper;
/**
* Unit test class for the I18n sniff.
*
- * @package WPCS\WordPressCodingStandards
+ * @since 0.10.0
+ * @since 0.13.0 Class name changed: this class is now namespaced.
*
- * @since 0.10.0
- * @since 0.13.0 Class name changed: this class is now namespaced.
+ * @covers \WordPressCS\WordPress\Sniffs\WP\I18nSniff
*/
-class I18nUnitTest extends AbstractSniffUnitTest {
-
- /**
- * Get a list of CLI values to set before the file is tested.
- *
- * Used by PHPCS 2.x.
- *
- * @param string $testFile The name of the file being tested.
- *
- * @return array
- */
- public function getCliValues( $testFile ) {
- // Test overruling the text domain from the command line for one test file.
- if ( 'I18nUnitTest.3.inc' === $testFile ) {
- PHPCSHelper::set_config_data( 'text_domain', 'something', true );
- }
-
- return array();
- }
+final class I18nUnitTest extends AbstractSniffUnitTest {
/**
* Set CLI values before the file is tested.
*
- * Used by PHPCS 3.x.
- *
* @param string $testFile The name of the file being tested.
* @param \PHP_CodeSniffer\Config $config The config data for the test run.
*
@@ -54,6 +33,9 @@ public function setCliValues( $testFile, $config ) {
// Test overruling the text domain from the command line for one test file.
if ( 'I18nUnitTest.3.inc' === $testFile ) {
$config->setConfigData( 'text_domain', 'something', true );
+ } else {
+ // Delete the text domain option so it doesn't persist for subsequent test files.
+ $config->setConfigData( 'text_domain', null, true );
}
}
@@ -61,7 +43,8 @@ public function setCliValues( $testFile, $config ) {
* Returns the lines where errors should occur.
*
* @param string $testFile The name of the file being tested.
- * @return array =>
+ *
+ * @return array Key is the line number, value is the number of expected errors.
*/
public function getErrorList( $testFile = '' ) {
@@ -135,11 +118,44 @@ public function getErrorList( $testFile = '' ) {
153 => 1,
157 => 1,
178 => 1,
+ 181 => 3,
+ 184 => 1,
+ 219 => 1,
+ 220 => 1,
+ 221 => 1,
+ 222 => 1,
+ 223 => 1,
+ 224 => 1,
+ 227 => 1,
+ 235 => 1,
+ 236 => 1,
+ 237 => 1,
+ 242 => 2,
+ 251 => 1,
+ 252 => 1,
+ 253 => 1,
+ 260 => 1,
+ 261 => 1,
+ 265 => 1,
+ 269 => 1,
+ 273 => 1,
+ 279 => 1,
+ 281 => 1,
+ 282 => 1,
+ 284 => 1,
+ 305 => 1,
+ 306 => 1,
+ 311 => 1,
+ 315 => 1,
+ 318 => 1,
);
case 'I18nUnitTest.2.inc':
return array(
104 => 2,
+ 110 => 1,
+ 111 => 1,
+ 120 => 1,
);
case 'I18nUnitTest.3.inc':
@@ -154,6 +170,7 @@ public function getErrorList( $testFile = '' ) {
18 => 1,
20 => 1,
21 => 1,
+ 27 => 1,
);
default:
@@ -165,7 +182,8 @@ public function getErrorList( $testFile = '' ) {
* Returns the lines where warnings should occur.
*
* @param string $testFile The name of the file being tested.
- * @return array =>
+ *
+ * @return array Key is the line number, value is the number of expected warnings.
*/
public function getWarningList( $testFile = '' ) {
switch ( $testFile ) {
@@ -173,13 +191,32 @@ public function getWarningList( $testFile = '' ) {
return array(
69 => 1,
70 => 1,
- 100 => 1,
- 101 => 1,
- 102 => 1,
- 103 => 1,
154 => 1,
158 => 1,
159 => 1,
+ 187 => 1,
+ 191 => 1,
+ 193 => 1,
+ 194 => 1,
+ 198 => 1,
+ 199 => 1,
+ 232 => 1,
+ 241 => 1,
+ 242 => 1,
+ 243 => 1,
+ 244 => 1,
+ 251 => 1,
+ 283 => 1,
+ 285 => 1,
+ 290 => 1,
+ 291 => 1,
+ 294 => 1,
+ 295 => 1,
+ 296 => 1,
+ 297 => 1,
+ 300 => 1,
+ 301 => 1,
+ 302 => 1,
);
case 'I18nUnitTest.2.inc':
@@ -191,11 +228,11 @@ public function getWarningList( $testFile = '' ) {
74 => 1,
85 => 1,
108 => 1,
+ 122 => 1,
);
default:
return array();
}
}
-
}
diff --git a/WordPress/Tests/WP/PostsPerPageUnitTest.inc b/WordPress/Tests/WP/PostsPerPageUnitTest.inc
index 61dbdf43d6..7474ba6c3c 100644
--- a/WordPress/Tests/WP/PostsPerPageUnitTest.inc
+++ b/WordPress/Tests/WP/PostsPerPageUnitTest.inc
@@ -17,14 +17,110 @@ $query_args['numberposts'] = '-1'; // OK.
$query_args['my_posts_per_page'] = -1; // OK.
-// @codingStandardsChangeSetting WordPress.WP.PostsPerPage posts_per_page 50
- $query_args['posts_per_page'] = 50; // OK.
- $query_args['posts_per_page'] = 100; // Bad.
- $query_args['posts_per_page'] = 200; // Bad.
- $query_args['posts_per_page'] = 300; // Bad.
-// @codingStandardsChangeSetting WordPress.WP.PostsPerPage posts_per_page 200
- $query_args['posts_per_page'] = 50; // OK.
- $query_args['posts_per_page'] = 100; // OK.
- $query_args['posts_per_page'] = 200; // OK.
- $query_args['posts_per_page'] = 300; // Bad.
-// @codingStandardsChangeSetting WordPress.WP.PostsPerPage posts_per_page 100
+// phpcs:set WordPress.WP.PostsPerPage posts_per_page 50
+$query_args['posts_per_page'] = 50; // OK.
+$query_args['posts_per_page'] = 100; // Bad.
+$query_args['posts_per_page'] = 200; // Bad.
+$query_args['posts_per_page'] = 300; // Bad.
+// phpcs:set WordPress.WP.PostsPerPage posts_per_page 200
+$query_args['posts_per_page'] = 50; // OK.
+$query_args['posts_per_page'] = 100; // OK.
+$query_args['posts_per_page'] = 200; // OK.
+$query_args['posts_per_page'] = 300; // Bad.
+// phpcs:set WordPress.WP.PostsPerPage posts_per_page 100
+
+// phpcs:set WordPress.WP.PostsPerPage exclude[] posts_per_page
+$query_args['posts_per_page'] = 300; // OK, group excluded.
+// phpcs:set WordPress.WP.PostsPerPage exclude[]
+
+// Ensure there will be no false positive for array access brackets when not used for an assignment.
+$var = $query_args['posts_per_page']; // OK.
+$firstChars = $text[0] . $text[1]; // OK.
+
+// Text strings which are not query strings should be ignored.
+_query_posts( 'numberposts' ); // OK.
+
+// Assignments to non-string keys should be ignored. Note: PHP will auto-cast numeric strings to ints, so those should also be disregarded.
+$var[10] = 300; // OK.
+$var[] = 400; // OK.
+$var['239'] = 500; // OK.
+
+// Ensure the sniff disregards comments.
+$query_args['posts_per_page' /* high */ ] = 999; // Bad.
+
+$query_args['posts_per_page'] /* high */ = 999; // Bad.
+
+$args = array(
+ 'posts_per_page' /* high */ => 999, // Bad.
+);
+
+$query_args['posts_per_page'] = /* high */ 999; // Bad.
+$args = array(
+ 'posts_per_page' => /* high */ 999, // Bad.
+);
+
+// Safeguard that when a query string contains duplicate key, the value of the last one is used.
+_query_posts( 'posts_per_page=999&nopaging=true&posts_per_page=50' ); // OK.
+
+// Ensure the error gets reported on the key pointer.
+$query_args[
+ 'posts_per_page'
+] = 300; // Bad, error should be reported on the above line.
+
+// Ensure that PHP 7.4 null coalesce equals get picked up on.
+$query_args['posts_per_page'] ??= 50; // OK.
+$query_args['posts_per_page'] ??= 200; // Bad.
+
+// Ensure that the sniff does not report on PHP 8.0 match arms.
+$val = match($val) {
+ 'posts_per_page' => 999, // OK, not an array assignment.
+};
+
+// Verify handling of arrays without trailing comma after the last array item.
+$args = array( 'posts_per_page' => 999 ); // Bad.
+$args = [
+ 'posts_per_page' => 999
+]; // Bad.
+
+// Verify that the complete value is being captured correctly and that non-numeric values are disregarded.
+$args = array(
+ 'posts_per_page' => min( max( $first, $last ), $default_min ), // Should be ignored as undetermined.
+ 'posts_per_page' => 10 + $extra, // Should be ignored as undetermined.
+ 'posts_per_page' => $value[0][1], // Should be ignored as undetermined.
+ 'posts_per_page' => $value ? 10 * $value : 300, // Should be ignored as undetermined.
+ 'posts_per_page' => get_value( name: 'post_per_page', type: 'query' ), // Should be ignored as undetermined.
+ 'posts_per_page' => function($a): int {
+ return do_something( $a );
+ }, // Should be ignored as undetermined.
+ 'posts_per_page' => [ 100, 200, 300 ], // Should be ignored as undetermined.
+ 'posts_per_page' => array(100, 200, 300), // Should be ignored as undetermined.
+);
+$query_args['posts_per_page'] = my\get_posts_per_page(); // Should be ignored as undetermined.
+$query_args['posts_per_page'] = '1e3'; // Should be ignored as undetermined. Would evaluate to 1000 with an int cast, but WP doesn't cast the value.
+
+// Purely numeric strings should probably be accepted still as this won't make a difference for the database query.
+$query_args['posts_per_page'] = '50'; // OK.
+$query_args['posts_per_page'] = '200'; // Bad.
+$query_args['posts_per_page'] = "200"; // Bad.
+
+// Verify handling of explicitly positive numbers.
+$args = array(
+ 'posts_per_page' => +50, // OK.
+ 'posts_per_page' => +200, // Bad.
+);
+
+// Verify handling of PHP 7.4+ numeric literals, PHP 8.1 octal literals, non-decimal numbers and floats.
+$args = array(
+ 'posts_per_page' => 0b1001011, // OK (75).
+ 'posts_per_page' => 0b10010110, // Bad (150).
+ 'posts_per_page' => 0x4B, // OK (75).
+ 'posts_per_page' => 0x96, // Bad (150).
+ 'posts_per_page' => 0113, // OK (75).
+ 'posts_per_page' => 0226, // Bad (150).
+ 'posts_per_page' => 0O113, // OK (75).
+ 'posts_per_page' => 0o226, // Bad (150).
+ 'posts_per_page' => 7_5, // OK (75).
+ 'posts_per_page' => 1_50, // Bad (150).
+ 'posts_per_page' => 75.0, // OK (75).
+ 'posts_per_page' => 150.000, // Bad (150).
+);
diff --git a/WordPress/Tests/WP/PostsPerPageUnitTest.php b/WordPress/Tests/WP/PostsPerPageUnitTest.php
index 233609bd8a..bf3296ce25 100644
--- a/WordPress/Tests/WP/PostsPerPageUnitTest.php
+++ b/WordPress/Tests/WP/PostsPerPageUnitTest.php
@@ -3,31 +3,32 @@
* Unit test class for WordPress Coding Standard.
*
* @package WPCS\WordPressCodingStandards
- * @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
+ * @link https://github.com/WordPress/WordPress-Coding-Standards
* @license https://opensource.org/licenses/MIT MIT
*/
-namespace WordPress\Tests\WP;
+namespace WordPressCS\WordPress\Tests\WP;
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
/**
* Unit test class for the PostsPerPage sniff.
*
- * @package WPCS\WordPressCodingStandards
+ * @since 0.3.0
+ * @since 0.13.0 Class name changed: this class is now namespaced.
+ * @since 1.0.0 This sniff has been split into two, with the check for high pagination
+ * limit being part of the WP category, and the check for pagination
+ * disabling being part of the VIP category.
*
- * @since 0.3.0
- * @since 0.13.0 Class name changed: this class is now namespaced.
- * @since 1.0.0 This sniff has been split into two, with the check for high pagination
- * limit being part of the WP category, and the check for pagination
- * disabling being part of the VIP category.
+ * @covers \WordPressCS\WordPress\AbstractArrayAssignmentRestrictionsSniff
+ * @covers \WordPressCS\WordPress\Sniffs\WP\PostsPerPageSniff
*/
-class PostsPerPageUnitTest extends AbstractSniffUnitTest {
+final class PostsPerPageUnitTest extends AbstractSniffUnitTest {
/**
* Returns the lines where errors should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected errors.
*/
public function getErrorList() {
return array();
@@ -36,19 +37,36 @@ public function getErrorList() {
/**
* Returns the lines where warnings should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected warnings.
*/
public function getWarningList() {
return array(
- 4 => 1,
- 10 => 1,
- 11 => 1,
- 13 => 1,
- 22 => 1,
- 23 => 1,
- 24 => 1,
- 29 => 1,
+ 4 => 1,
+ 10 => 1,
+ 11 => 1,
+ 13 => 1,
+ 22 => 1,
+ 23 => 1,
+ 24 => 1,
+ 29 => 1,
+ 49 => 1,
+ 51 => 1,
+ 54 => 1,
+ 57 => 1,
+ 59 => 1,
+ 67 => 1,
+ 72 => 1,
+ 80 => 1,
+ 82 => 1,
+ 103 => 1,
+ 104 => 1,
+ 109 => 1,
+ 115 => 1,
+ 117 => 1,
+ 119 => 1,
+ 121 => 1,
+ 123 => 1,
+ 125 => 1,
);
}
-
}
diff --git a/WordPress/Tests/WP/PreparedSQLUnitTest.inc b/WordPress/Tests/WP/PreparedSQLUnitTest.inc
deleted file mode 100644
index a1f5b17d94..0000000000
--- a/WordPress/Tests/WP/PreparedSQLUnitTest.inc
+++ /dev/null
@@ -1,3 +0,0 @@
- =>
- */
- public function getErrorList() {
- return array();
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @since 0.8.0
- *
- * @return array =>
- */
- public function getWarningList() {
- return array(
- 1 => 1,
- );
- }
-
-}
diff --git a/WordPress/Tests/WP/TimezoneChangeUnitTest.inc b/WordPress/Tests/WP/TimezoneChangeUnitTest.inc
deleted file mode 100644
index 4e38791f9b..0000000000
--- a/WordPress/Tests/WP/TimezoneChangeUnitTest.inc
+++ /dev/null
@@ -1,6 +0,0 @@
-setTimezone( new DateTimeZone( 'America/Toronto' ) ); // Yay!
diff --git a/WordPress/Tests/WP/TimezoneChangeUnitTest.php b/WordPress/Tests/WP/TimezoneChangeUnitTest.php
deleted file mode 100644
index 6f16015319..0000000000
--- a/WordPress/Tests/WP/TimezoneChangeUnitTest.php
+++ /dev/null
@@ -1,45 +0,0 @@
- =>
- */
- public function getErrorList() {
- return array(
- 3 => 1,
- );
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @return array =>
- */
- public function getWarningList() {
- return array();
- }
-
-}
diff --git a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc b/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc
deleted file mode 100644
index 0f3f714031..0000000000
--- a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc
+++ /dev/null
@@ -1,161 +0,0 @@
-{$var}( $foo,$bar );
-
-(function( $a, $b ) {
- return function( $c, $d ) use ( $a, $b ) {
- echo $a, $b, $c, $d;
- };
-})( 'a','b' )( 'c','d' );
-
-$closure( $foo,$bar );
-$var = $closure() + $closure( $foo,$bar ) + self::$closure( $foo,$bar );
-
-class Test {
- public static function baz( $foo, $bar ) {
- $a = new self( $foo,$bar );
- $b = new static( $foo,$bar );
- }
-}
-
-/*
- * Test warning for empty parentheses.
- */
-$a = 4 + (); // Warning.
-$a = 4 + ( ); // Warning.
-$a = 4 + (/* Not empty */);
-
-/*
- * Test the actual sniff.
- */
-if ((null !== $extra) && ($row->extra !== $extra)) {}
-
-if (( null !== $extra ) && ( $row->extra !== $extra )) {} // Bad x 4.
-
-if (( null !== $extra // Bad x 1.
- && is_int($extra))
- && ( $row->extra !== $extra // Bad x 1.
- || $something ) // Bad x 1.
-) {}
-
-if (( null !== $extra ) // Bad x 2.
- && ( $row->extra !== $extra ) // Bad x 2.
-) {}
-
-$a = (null !== $extra);
-$a = ( null !== $extra ); // Bad x 2.
-
-$sx = $vert ? ($w - 1) : 0;
-
-$this->is_overloaded = ( ( ini_get("mbstring.func_overload") & 2 ) != 0 ) && function_exists('mb_substr'); // Bad x 4.
-
-$image->flip( ($operation->axis & 1) != 0, ($operation->axis & 2) != 0 );
-
-if ( $success && ('nothumb' == $target || 'all' == $target) ) {}
-
-$directory = ('/' == $file[ strlen($file)-1 ]);
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 1
-if ((null !== $extra) && ($row->extra !== $extra)) {} // Bad x 4.
-
-if (( null !== $extra ) && ( $row->extra !== $extra )) {}
-
-if (( null !== $extra // Bad x 1.
- && is_int($extra)) // Bad x 1.
- && ( $row->extra !== $extra
- || $something ) // Bad x 1.
-) {}
-
-if ((null !== $extra) // Bad x 2.
- && ($row->extra !== $extra) // Bad x 2.
-) {}
-
-$a = (null !== $extra); // Bad x 2.
-$a = ( null !== $extra );
-
-$sx = $vert ? ($w - 1) : 0; // Bad x 2.
-
-$this->is_overloaded = ((ini_get("mbstring.func_overload") & 2) != 0) && function_exists('mb_substr'); // Bad x 4.
-
-$image->flip( ($operation->axis & 1) != 0, ($operation->axis & 2) != 0 ); // Bad x 4.
-
-if ( $success && ('nothumb' == $target || 'all' == $target) ) {} // Bad x 2.
-
-$directory = ('/' == $file[ strlen($file)-1 ]); // Bad x 2.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 0
-
-/*
- * Test handling of ignoreNewlines.
- */
-if (
- (
- null !== $extra
- ) && (
- $row->extra !== $extra
- )
-) {} // Bad x 4, 1 x line 123, 2 x line 125, 1 x line 127.
-
-
-$a = (
- null !== $extra
-); // Bad x 2, 1 x line 131, 1 x line 133.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 1
-if (
- (
- null !== $extra
- ) && (
- $row->extra !== $extra
- )
-) {} // Bad x 4, 1 x line 137, 2 x line 139, 1 x line 141.
-
-$a = (
- null !== $extra
-); // Bad x 2, 1 x line 144, 1 x line 146.
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 0
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing ignoreNewlines true
-if (
- (
- null !== $extra
- ) && (
- $row->extra !== $extra
- )
-) {}
-
-$a = (
- null !== $extra
-);
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing ignoreNewlines false
diff --git a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc.fixed b/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc.fixed
deleted file mode 100644
index 64c9edd4a7..0000000000
--- a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.inc.fixed
+++ /dev/null
@@ -1,149 +0,0 @@
-{$var}( $foo,$bar );
-
-(function( $a, $b ) {
- return function( $c, $d ) use ( $a, $b ) {
- echo $a, $b, $c, $d;
- };
-})( 'a','b' )( 'c','d' );
-
-$closure( $foo,$bar );
-$var = $closure() + $closure( $foo,$bar ) + self::$closure( $foo,$bar );
-
-class Test {
- public static function baz( $foo, $bar ) {
- $a = new self( $foo,$bar );
- $b = new static( $foo,$bar );
- }
-}
-
-/*
- * Test warning for empty parentheses.
- */
-$a = 4 + (); // Warning.
-$a = 4 + ( ); // Warning.
-$a = 4 + (/* Not empty */);
-
-/*
- * Test the actual sniff.
- */
-if ((null !== $extra) && ($row->extra !== $extra)) {}
-
-if ((null !== $extra) && ($row->extra !== $extra)) {} // Bad x 4.
-
-if ((null !== $extra // Bad x 1.
- && is_int($extra))
- && ($row->extra !== $extra // Bad x 1.
- || $something) // Bad x 1.
-) {}
-
-if ((null !== $extra) // Bad x 2.
- && ($row->extra !== $extra) // Bad x 2.
-) {}
-
-$a = (null !== $extra);
-$a = (null !== $extra); // Bad x 2.
-
-$sx = $vert ? ($w - 1) : 0;
-
-$this->is_overloaded = ((ini_get("mbstring.func_overload") & 2) != 0) && function_exists('mb_substr'); // Bad x 4.
-
-$image->flip( ($operation->axis & 1) != 0, ($operation->axis & 2) != 0 );
-
-if ( $success && ('nothumb' == $target || 'all' == $target) ) {}
-
-$directory = ('/' == $file[ strlen($file)-1 ]);
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 1
-if (( null !== $extra ) && ( $row->extra !== $extra )) {} // Bad x 4.
-
-if (( null !== $extra ) && ( $row->extra !== $extra )) {}
-
-if (( null !== $extra // Bad x 1.
- && is_int($extra) ) // Bad x 1.
- && ( $row->extra !== $extra
- || $something ) // Bad x 1.
-) {}
-
-if (( null !== $extra ) // Bad x 2.
- && ( $row->extra !== $extra ) // Bad x 2.
-) {}
-
-$a = ( null !== $extra ); // Bad x 2.
-$a = ( null !== $extra );
-
-$sx = $vert ? ( $w - 1 ) : 0; // Bad x 2.
-
-$this->is_overloaded = ( ( ini_get("mbstring.func_overload") & 2 ) != 0 ) && function_exists('mb_substr'); // Bad x 4.
-
-$image->flip( ( $operation->axis & 1 ) != 0, ( $operation->axis & 2 ) != 0 ); // Bad x 4.
-
-if ( $success && ( 'nothumb' == $target || 'all' == $target ) ) {} // Bad x 2.
-
-$directory = ( '/' == $file[ strlen($file)-1 ] ); // Bad x 2.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 0
-
-/*
- * Test handling of ignoreNewlines.
- */
-if (
- (null !== $extra) && ($row->extra !== $extra)
-) {} // Bad x 4, 1 x line 123, 2 x line 125, 1 x line 127.
-
-
-$a = (null !== $extra); // Bad x 2, 1 x line 131, 1 x line 133.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 1
-if (
- ( null !== $extra ) && ( $row->extra !== $extra )
-) {} // Bad x 4, 1 x line 137, 2 x line 139, 1 x line 141.
-
-$a = ( null !== $extra ); // Bad x 2, 1 x line 144, 1 x line 146.
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing spacingInside 0
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing ignoreNewlines true
-if (
- (
- null !== $extra
- ) && (
- $row->extra !== $extra
- )
-) {}
-
-$a = (
- null !== $extra
-);
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ArbitraryParenthesesSpacing ignoreNewlines false
diff --git a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.php b/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.php
deleted file mode 100644
index 66c2ddfcc3..0000000000
--- a/WordPress/Tests/WhiteSpace/ArbitraryParenthesesSpacingUnitTest.php
+++ /dev/null
@@ -1,75 +0,0 @@
- =>
- */
- public function getErrorList() {
- return array(
- 64 => 4,
- 66 => 1,
- 68 => 1,
- 69 => 1,
- 72 => 2,
- 73 => 2,
- 77 => 2,
- 81 => 4,
- 90 => 4,
- 94 => 1,
- 95 => 1,
- 97 => 1,
- 100 => 2,
- 101 => 2,
- 104 => 2,
- 107 => 2,
- 109 => 4,
- 111 => 4,
- 113 => 2,
- 115 => 2,
- 123 => 1,
- 125 => 2,
- 127 => 1,
- 131 => 1,
- 133 => 1,
- 137 => 1,
- 139 => 2,
- 141 => 1,
- 144 => 1,
- 146 => 1,
- );
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @return array =>
- */
- public function getWarningList() {
- return array(
- 55 => 1,
- 56 => 1,
- );
- }
-
-}
diff --git a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc
index b17bc2ce92..29c1ce52d5 100644
--- a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc
+++ b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc
@@ -20,3 +20,5 @@ $unset2 = (unset) $unset; // Ok.
$float1 =(float )$float; // Bad; n.b. spacing within the cast is dealt with by an upstream sniff.
$float2 = (float) $float; // Ok.
+
+function_call( ...(array) $mixed ); // OK.
diff --git a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc.fixed b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc.fixed
index a4ff985fe2..b596241f06 100644
--- a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc.fixed
+++ b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.inc.fixed
@@ -20,3 +20,5 @@ $unset2 = (unset) $unset; // Ok.
$float1 = (float )$float; // Bad; n.b. spacing within the cast is dealt with by an upstream sniff.
$float2 = (float) $float; // Ok.
+
+function_call( ...(array) $mixed ); // OK.
diff --git a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.php b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.php
index 9cf81858e0..5392cf4852 100644
--- a/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.php
+++ b/WordPress/Tests/WhiteSpace/CastStructureSpacingUnitTest.php
@@ -3,28 +3,28 @@
* Unit test class for WordPress Coding Standard.
*
* @package WPCS\WordPressCodingStandards
- * @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
+ * @link https://github.com/WordPress/WordPress-Coding-Standards
* @license https://opensource.org/licenses/MIT MIT
*/
-namespace WordPress\Tests\WhiteSpace;
+namespace WordPressCS\WordPress\Tests\WhiteSpace;
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
/**
* Unit test class for the CastStructureSpacing sniff.
*
- * @package WPCS\WordPressCodingStandards
+ * @since 0.3.0
+ * @since 0.13.0 Class name changed: this class is now namespaced.
*
- * @since 0.3.0
- * @since 0.13.0 Class name changed: this class is now namespaced.
+ * @covers \WordPressCS\WordPress\Sniffs\WhiteSpace\CastStructureSpacingSniff
*/
-class CastStructureSpacingUnitTest extends AbstractSniffUnitTest {
+final class CastStructureSpacingUnitTest extends AbstractSniffUnitTest {
/**
* Returns the lines where errors should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected errors.
*/
public function getErrorList() {
return array(
@@ -41,10 +41,9 @@ public function getErrorList() {
/**
* Returns the lines where warnings should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected warnings.
*/
public function getWarningList() {
return array();
}
-
}
diff --git a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc
index c8cede58b7..73f4b0a00e 100644
--- a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc
+++ b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc
@@ -5,7 +5,7 @@ while( have_posts() ) { // Okay, comments are okay here.
// Okay, comments are okay here as well.
} // Okay, comments are okay here.
-// See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/40 .
+// See https://github.com/WordPress/WordPress-Coding-Standards/issues/40 .
if ( true ) {
// code.
@@ -45,91 +45,6 @@ endif;
if ( false ) :
else :
endif;
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 1
-$a = function($arg){}; // Bad.
-$a = function ( $arg ) {
- // Ok.
-};
-
-$a = function () {
- // Ok.
-};
-
-function something($arg){} // Bad.
-function foo( $arg ) {
- // Ok.
-}
-
-function no_params() {
- // Ok.
-}
-
-function another () {} // Bad, space before open parenthesis prohibited.
-function and_another() {} // Bad, space before function name prohibited.
-function
-bar() {} // Bad.
-function baz() {} // Bad.
-function testA()
-{} // Bad.
-
-function &return_by_ref() {} // Ok.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 0
-
-$a = function() {}; // Ok.
-$a = function( $arg ) {}; // Ok.
-$a = function($arg){}; // Bad.
-$a = function () {}; // Bad.
-
-$closureWithArgsAndVars = function( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 1
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use( $var1, $var2 ) {}; // Bad, no space before open parenthesis prohibited.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space before opening parenthesis.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ){}; // Bad, space between closing parenthesis and control structure required.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 )use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-
-// Namespaces.
-use Foo\Admin;
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren -1
-
-$a = function( $arg ) {}; // Ok.
-$a = function ( $arg ) {}; // Ok.
-
-$closureWithArgsAndVars = function( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-
-/*
- * Test for bug where this sniff was triggering a "Blank line found after control structure" error
- * if there is a blank line after the last method in a class.
- *
- * Bug did not trigger when a comment was found after the closing brace of the method.
- *
- * Neither of the below examples should trigger the error.
- */
-class Bar_Foo {
-
- function foo() {
- } // Now you won't see the bug.
-
-}
-
-class Foo_Bar {
-
- // Now you will.
- function bar() {
- }
-
-}
// Handle try/catch statements as well.
try{ // Bad.
@@ -139,12 +54,12 @@ try{ // Bad.
}
// Upstream bug PEAR #20248.
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
// Bad.
if ( $one ) {
}
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
// Upstream bug PEAR #20247.
do {
@@ -152,7 +67,7 @@ do {
} while ($blah); // Bad.
// Upstream bug GH #782
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
if ( $foo ) {
@@ -173,12 +88,9 @@ if ( $foo ) {
}
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
// Check for too many spaces as long as the next non-blank token is on the same line.
-function test( $blah ) {} // Bad.
-$a = function( $bar ) {}; // Bad.
-
if ( 'abc' === $test ) { // Bad.
echo 'hi';
} elseif ( false === $foo ) { // Bad.
@@ -269,24 +181,85 @@ if ( $foo ) {
}
-// Issue 1202.
-function hi(): array
-{
- return [];
+// Handle (try/catch/) finally statements as well.
+try {
+ // Something
+} catch ( Exception $e ) {
+ // Something
+} finally { // OK.
+ // Something
+}
+
+try {
+ // Something
+} finally
+
+{ // Bad.
+ // Something
+}
+
+try {
+ // Something
+} finally{ // Bad.
+ // Something
+}
+
+if ( $condition ) {
+ try {
+ // Something
+ } finally {
+ // Something
+ }
+
+} // Bad: blank line between.
+
+// Handle PHP 8.0+ match expressions.
+$expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+};
+
+$expr = match($foo){
+ 1 => 1,
+ 2 => 2,
+} ;
+
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+$expr = match ( $foo ) {
+
+ 1 => 1,
+ 2 => 2,
+
+};
+
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+
+if ( $condition ) {
+ $expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+ };
+
+
+} // Bad: blank line between.
+
+// Ignore spacing rules in combination with enums as they tend to have their own rules.
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+if ( $foo ) {
+
+
+ enum MyEnumA {
+ // Code here
+ }
+
+
}
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+
+enum MyEnumB {
+ if ( $foo ) {
+ // Code here
+ }
+
-// Issue 1420.
-function returntype1(): string {} // Ok.
-function returntype2( $input ): string {} // Ok.
-function returntype3( $input ) : string {} // Ok.
-function returntype4( string $input ): string {} // Ok.
-function returntype5( string $input ) : string {} // Ok.
-function returntype6( string $input, array $inputs ): string {} // Ok.
-function returntype7( string $input, array $inputs ) : string {} // Ok.
-$returntype = function (): string {}; // Ok.
-$returntype = function ( $input ): string {}; // Ok.
-$returntype = function ( $input ) : string {}; // Ok.
-$returntype = function ( string $input ): string {}; // Ok.
-$returntype = function ( string $input ) : string {}; // Ok.
-$returntype = function ( string $input, array $inputs ): string {}; // Ok.
-$returntype = function ( string $input, array $inputs ) : string {}; // Ok.
+} // OK, defer to enum rules.
diff --git a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc.fixed b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc.fixed
index bed9205f68..1a2bf8ad3c 100644
--- a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc.fixed
+++ b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.1.inc.fixed
@@ -5,7 +5,7 @@ while ( have_posts() ) { // Okay, comments are okay here.
// Okay, comments are okay here as well.
} // Okay, comments are okay here.
-// See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/40 .
+// See https://github.com/WordPress/WordPress-Coding-Standards/issues/40 .
if ( true ) {
// code.
@@ -43,89 +43,6 @@ endif;
if ( false ) :
else :
endif;
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 1
-$a = function ( $arg ) {}; // Bad.
-$a = function ( $arg ) {
- // Ok.
-};
-
-$a = function () {
- // Ok.
-};
-
-function something( $arg ) {} // Bad.
-function foo( $arg ) {
- // Ok.
-}
-
-function no_params() {
- // Ok.
-}
-
-function another() {} // Bad, space before open parenthesis prohibited.
-function and_another() {} // Bad, space before function name prohibited.
-function bar() {} // Bad.
-function baz() {} // Bad.
-function testA() {} // Bad.
-
-function &return_by_ref() {} // Ok.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 0
-
-$a = function() {}; // Ok.
-$a = function( $arg ) {}; // Ok.
-$a = function( $arg ) {}; // Bad.
-$a = function() {}; // Bad.
-
-$closureWithArgsAndVars = function( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-$closureWithArgsAndVars = function( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad.
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren 1
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, no space before open parenthesis prohibited.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space before opening parenthesis.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, space between closing parenthesis and control structure required.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Bad, expected exactly one space between closing parenthesis and control structure.
-
-// Namespaces.
-use Foo\Admin;
-
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing spaces_before_closure_open_paren -1
-
-$a = function( $arg ) {}; // Ok.
-$a = function ( $arg ) {}; // Ok.
-
-$closureWithArgsAndVars = function( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-$closureWithArgsAndVars = function ( $arg1, $arg2 ) use ( $var1, $var2 ) {}; // Ok.
-
-/*
- * Test for bug where this sniff was triggering a "Blank line found after control structure" error
- * if there is a blank line after the last method in a class.
- *
- * Bug did not trigger when a comment was found after the closing brace of the method.
- *
- * Neither of the below examples should trigger the error.
- */
-class Bar_Foo {
-
- function foo() {
- } // Now you won't see the bug.
-
-}
-
-class Foo_Bar {
-
- // Now you will.
- function bar() {
- }
-
-}
// Handle try/catch statements as well.
try { // Bad.
@@ -135,11 +52,11 @@ try { // Bad.
}
// Upstream bug PEAR #20248.
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
// Bad.
if ( $one ) {
}
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
// Upstream bug PEAR #20247.
do {
@@ -147,7 +64,7 @@ do {
} while ( $blah ); // Bad.
// Upstream bug GH #782
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
if ( $foo ) {
@@ -168,12 +85,9 @@ if ( $foo ) {
}
-// @codingStandardsChangeSetting WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
// Check for too many spaces as long as the next non-blank token is on the same line.
-function test( $blah ) {} // Bad.
-$a = function( $bar ) {}; // Bad.
-
if ( 'abc' === $test ) { // Bad.
echo 'hi';
} elseif ( false === $foo ) { // Bad.
@@ -258,24 +172,78 @@ if ( $foo ) {
} // End try/catch <- Bad: "blank line after".
}
-// Issue 1202.
-function hi(): array
-{
- return [];
+// Handle (try/catch/) finally statements as well.
+try {
+ // Something
+} catch ( Exception $e ) {
+ // Something
+} finally { // OK.
+ // Something
+}
+
+try {
+ // Something
+} finally { // Bad.
+ // Something
+}
+
+try {
+ // Something
+} finally { // Bad.
+ // Something
+}
+
+if ( $condition ) {
+ try {
+ // Something
+ } finally {
+ // Something
+ }
+} // Bad: blank line between.
+
+// Handle PHP 8.0+ match expressions.
+$expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+};
+
+$expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+} ;
+
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+$expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+};
+
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+
+if ( $condition ) {
+ $expr = match ( $foo ) {
+ 1 => 1,
+ 2 => 2,
+ };
+} // Bad: blank line between.
+
+// Ignore spacing rules in combination with enums as they tend to have their own rules.
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check true
+if ( $foo ) {
+
+
+ enum MyEnumA {
+ // Code here
+ }
+
+
}
+// phpcs:set WordPress.WhiteSpace.ControlStructureSpacing blank_line_check false
+
+enum MyEnumB {
+ if ( $foo ) {
+ // Code here
+ }
+
-// Issue 1420.
-function returntype1(): string {} // Ok.
-function returntype2( $input ): string {} // Ok.
-function returntype3( $input ) : string {} // Ok.
-function returntype4( string $input ): string {} // Ok.
-function returntype5( string $input ) : string {} // Ok.
-function returntype6( string $input, array $inputs ): string {} // Ok.
-function returntype7( string $input, array $inputs ) : string {} // Ok.
-$returntype = function (): string {}; // Ok.
-$returntype = function ( $input ): string {}; // Ok.
-$returntype = function ( $input ) : string {}; // Ok.
-$returntype = function ( string $input ): string {}; // Ok.
-$returntype = function ( string $input ) : string {}; // Ok.
-$returntype = function ( string $input, array $inputs ): string {}; // Ok.
-$returntype = function ( string $input, array $inputs ) : string {}; // Ok.
+} // OK, defer to enum rules.
diff --git a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.2.inc b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.2.inc
index 44f7bd2b95..b70e3c658a 100644
--- a/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.2.inc
+++ b/WordPress/Tests/WhiteSpace/ControlStructureSpacingUnitTest.2.inc
@@ -1,7 +1,7 @@
=>
+ * @return array Key is the line number, value is the number of expected errors.
*/
public function getErrorList( $testFile = '' ) {
@@ -67,48 +39,28 @@ public function getErrorList( $testFile = '' ) {
37 => 1,
41 => 1,
42 => 1,
- 49 => 5,
- 58 => 3,
- 67 => 1,
- 68 => 1,
- 69 => 1,
- 71 => 1,
- 72 => 1,
- 81 => 3,
- 82 => 1,
- 85 => 1,
- 91 => 2,
- 92 => 1,
+ 50 => 2,
+ 52 => 5,
+ 59 => 1,
+ 67 => 2,
94 => 1,
- 95 => 1,
- 97 => 1,
- 98 => 1,
- 135 => 2,
- 137 => 5,
- 144 => 1,
- 152 => 2,
+ 96 => 1,
+ 102 => 1,
+ 104 => 1,
+ 108 => 2,
+ 112 => 2,
+ 159 => 1,
+ 169 => 1,
179 => 1,
- 180 => 1,
- 182 => 1,
- 184 => 1,
- 190 => 1,
- 192 => 1,
- 196 => 2,
- 200 => 2,
- 247 => 1,
- 257 => 1,
- 267 => 1,
+ 195 => 1,
+ 203 => 2,
+ 212 => 1,
+ 222 => 5,
+ 228 => 1,
+ 232 => 1,
+ 241 => 1,
);
- /*
- Uncomment when "$blank_line_check" parameter will be "true" by default.
-
- $ret[29] += 1;
- $ret[33] = 1;
- $ret[36] = 1;
- $ret[38] = 1;
- */
-
return $ret;
case 'ControlStructureSpacingUnitTest.2.inc':
@@ -126,10 +78,9 @@ public function getErrorList( $testFile = '' ) {
/**
* Returns the lines where warnings should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected warnings.
*/
public function getWarningList() {
return array();
}
-
}
diff --git a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc b/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc
deleted file mode 100644
index 5d7178c14d..0000000000
--- a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc
+++ /dev/null
@@ -1,39 +0,0 @@
-tokens[ $closer ]['column'] - 1 );
- $error = 'Array closer not aligned correctly; expected %s space(s) but found %s';
- $data = array(
- $expected_value => 'data',
- $found => 'more_data',
- );
-
-/**
- * @param int $var Description - Bad: alignment using tabs.
- * @param string $string Another description.
- */
-
- $expected = ( $column - 1 );
- $found = ( $this->tokens[ $closer ]['column'] - 1 ); // Bad.
- $error = 'Array closer not aligned correctly; expected %s space(s) but found %s'; // Bad.
- $data = array( // Bad.
- $expected_value => 'data',
- $found => 'more_data', // Bad.
- );
-
-/*
- * Test that the tab replacements do not negatively influence the existing mid-line alignments.
- */
-$a = true;
-$aa = true;
-$aaa = true;
-$aaaa = true;
-$aaaaa = true;
-$aaaaaa = true;
-$aaaaaaa = true;
-$aaaaaaaa = true;
diff --git a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc.fixed b/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc.fixed
deleted file mode 100644
index 20f2877f69..0000000000
--- a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.inc.fixed
+++ /dev/null
@@ -1,39 +0,0 @@
-tokens[ $closer ]['column'] - 1 );
- $error = 'Array closer not aligned correctly; expected %s space(s) but found %s';
- $data = array(
- $expected_value => 'data',
- $found => 'more_data',
- );
-
-/**
- * @param int $var Description - Bad: alignment using tabs.
- * @param string $string Another description.
- */
-
- $expected = ( $column - 1 );
- $found = ( $this->tokens[ $closer ]['column'] - 1 ); // Bad.
- $error = 'Array closer not aligned correctly; expected %s space(s) but found %s'; // Bad.
- $data = array( // Bad.
- $expected_value => 'data',
- $found => 'more_data', // Bad.
- );
-
-/*
- * Test that the tab replacements do not negatively influence the existing mid-line alignments.
- */
-$a = true;
-$aa = true;
-$aaa = true;
-$aaaa = true;
-$aaaaa = true;
-$aaaaaa = true;
-$aaaaaaa = true;
-$aaaaaaaa = true;
diff --git a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.php b/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.php
deleted file mode 100644
index fe446801d6..0000000000
--- a/WordPress/Tests/WhiteSpace/DisallowInlineTabsUnitTest.php
+++ /dev/null
@@ -1,88 +0,0 @@
-tab_width );
- }
-
- /**
- * Set CLI values before the file is tested.
- *
- * Used by PHPCS 3.x.
- *
- * @param string $testFile The name of the file being tested.
- * @param \PHP_CodeSniffer\Config $config The config data for the test run.
- *
- * @return void
- */
- public function setCliValues( $testFile, $config ) {
- $config->tabWidth = $this->tab_width;
- }
-
- /**
- * Returns the lines where errors should occur.
- *
- * @return array =>
- */
- public function getErrorList() {
- return array(
- 17 => 1,
- 22 => 1,
- 23 => 1,
- 24 => 1,
- 26 => 1,
- 32 => 1,
- 33 => 1,
- 34 => 1,
- 35 => 1,
- 36 => 1,
- 37 => 1,
- );
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @return array =>
- */
- public function getWarningList() {
- return array();
- }
-
-}
diff --git a/WordPress/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.inc b/WordPress/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.inc
new file mode 100644
index 0000000000..ec042a295f
--- /dev/null
+++ b/WordPress/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.inc
@@ -0,0 +1,55 @@
+
+ */
+ public function getErrorList() {
+ return array(
+ 11 => 2,
+ 12 => 2,
+ 13 => 2,
+ 16 => 2,
+ 19 => 2,
+ 22 => 2,
+ 26 => 2,
+ 36 => 2,
+ 37 => 2,
+ 38 => 2,
+ 47 => 2,
+ 51 => 2,
+ );
+ }
+
+ /**
+ * Returns the lines where warnings should occur.
+ *
+ * The key of the array should represent the line number and the value
+ * should represent the number of warnings that should occur on that line.
+ *
+ * @return array
+ */
+ public function getWarningList() {
+ return array();
+ }
+}
diff --git a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc
index bad89cc0af..e58abf8cd0 100644
--- a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc
+++ b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc
@@ -39,9 +39,9 @@ if ( $a === $b xor $b === $c ) {}
// Logical operators: Too little space.
if ( $a === $b&&$b === $c ) {}
if ( $a === $b||$b === $c ) {}
-if ( $a === {$b}and$b === $c ) {}
-if ( $a === {$b}or$b === $c ) {}
-if ( $a === {$b}xor$b === $c ) {}
+if ( $a === ($b)and$b === $c ) {}
+if ( $a === ($b)or$b === $c ) {}
+if ( $a === ($b)xor$b === $c ) {}
// Logical operators: Too much space.
if ( $a === $b && $b === $c ) {}
@@ -64,3 +64,14 @@ if ( $a === $b
if ( $a === $b or
$b === $c ) {}
+
+// Safeguard that the "|" in PHP 8.0 union types is disregarded.
+function foo( int|float $param ) : string|false {}
+
+// Safeguard that the "&" in PHP 8.1 intersection types is disregarded.
+function fooBar( TypeA&namespace\TypeB $param ) : \TypeC&Partially\Qualified {}
+
+// Safeguard handling of union type separator for readonly properties.
+class Foo {
+ public readonly int|string $prop;
+}
diff --git a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed
index 4a3214f57e..43ab5ae914 100644
--- a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed
+++ b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed
@@ -39,9 +39,9 @@ if ( $a === $b xor $b === $c ) {}
// Logical operators: Too little space.
if ( $a === $b && $b === $c ) {}
if ( $a === $b || $b === $c ) {}
-if ( $a === {$b} and $b === $c ) {}
-if ( $a === {$b} or $b === $c ) {}
-if ( $a === {$b} xor $b === $c ) {}
+if ( $a === ($b) and $b === $c ) {}
+if ( $a === ($b) or $b === $c ) {}
+if ( $a === ($b) xor $b === $c ) {}
// Logical operators: Too much space.
if ( $a === $b && $b === $c ) {}
@@ -64,3 +64,14 @@ if ( $a === $b
if ( $a === $b or
$b === $c ) {}
+
+// Safeguard that the "|" in PHP 8.0 union types is disregarded.
+function foo( int|float $param ) : string|false {}
+
+// Safeguard that the "&" in PHP 8.1 intersection types is disregarded.
+function fooBar( TypeA&namespace\TypeB $param ) : \TypeC&Partially\Qualified {}
+
+// Safeguard handling of union type separator for readonly properties.
+class Foo {
+ public readonly int|string $prop;
+}
diff --git a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.php b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.php
index 801cb15f09..d7343f1ec2 100644
--- a/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.php
+++ b/WordPress/Tests/WhiteSpace/OperatorSpacingUnitTest.php
@@ -3,30 +3,30 @@
* Unit test class for WordPress Coding Standard.
*
* @package WPCS\WordPressCodingStandards
- * @link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
+ * @link https://github.com/WordPress/WordPress-Coding-Standards
* @license https://opensource.org/licenses/MIT MIT
*/
-namespace WordPress\Tests\WhiteSpace;
+namespace WordPressCS\WordPress\Tests\WhiteSpace;
use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
/**
* Unit test class for the OperatorSpacing sniff.
*
- * @package WPCS\WordPressCodingStandards
+ * @since 2013-06-11
+ * @since 0.12.0 Now only tests the WPCS specific addition of T_BOOLEAN_NOT.
+ * The rest of the sniff is unit tested upstream.
+ * @since 0.13.0 Class name changed: this class is now namespaced.
*
- * @since 2013-06-11
- * @since 0.12.0 Now only tests the WPCS specific addition of T_BOOLEAN_NOT.
- * The rest of the sniff is unit tested upstream.
- * @since 0.13.0 Class name changed: this class is now namespaced.
+ * @covers \WordPressCS\WordPress\Sniffs\WhiteSpace\OperatorSpacingSniff
*/
-class OperatorSpacingUnitTest extends AbstractSniffUnitTest {
+final class OperatorSpacingUnitTest extends AbstractSniffUnitTest {
/**
* Returns the lines where errors should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected errors.
*/
public function getErrorList() {
return array(
@@ -48,10 +48,9 @@ public function getErrorList() {
/**
* Returns the lines where warnings should occur.
*
- * @return array =>
+ * @return array Key is the line number, value is the number of expected warnings.
*/
public function getWarningList() {
return array();
}
-
}
diff --git a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.1.inc b/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.1.inc
deleted file mode 100644
index 7bcca1217e..0000000000
--- a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.1.inc
+++ /dev/null
@@ -1,68 +0,0 @@
-
-
-
- Bad: Some text with precision alignment.
-
-
-
-
-
-
-
-
-
- Bad: Some text with precision alignment, but not reported as token type is whitelisted.
-
-
-Hello, Dolly in the upper right of your admin screen on every page.
-Author: Matt Mullenweg
-Version: 1.5.1
-Author URI: http://ma.tt/
-Text Domain: hello-dolly
-
-*/
-
-// Test for
-?>
diff --git a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.4.inc b/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.4.inc
deleted file mode 100644
index a7c5b5deff..0000000000
--- a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.4.inc
+++ /dev/null
@@ -1,5 +0,0 @@
-
diff --git a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.5.inc b/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.5.inc
deleted file mode 100644
index 4fb786f100..0000000000
--- a/WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.5.inc
+++ /dev/null
@@ -1,58 +0,0 @@
-tab_width );
- }
-
- /**
- * Set CLI values before the file is tested.
- *
- * Used by PHPCS 3.x.
- *
- * @param string $testFile The name of the file being tested.
- * @param \PHP_CodeSniffer\Config $config The config data for the test run.
- *
- * @return void
- */
- public function setCliValues( $testFile, $config ) {
- $config->tabWidth = $this->tab_width;
-
- // Setting "--ignore-annotations" is only possible since PHPCS 3.0.
- if ( 'PrecisionAlignmentUnitTest.6.inc' === $testFile ) {
- $config->annotations = false;
- }
- }
-
- /**
- * Get a list of all test files to check.
- *
- * @param string $testFileBase The base path that the unit tests files will have.
- *
- * @return string[]
- */
- protected function getTestFiles( $testFileBase ) {
-
- $testFiles = parent::getTestFiles( $testFileBase );
-
- /*
- * Testing whether the PHPCS annotations are properly respected is only useful on
- * PHPCS versions which support the PHPCS annotations.
- */
- if ( version_compare( PHPCSHelper::get_version(), '3.2.0', '<' ) === true ) {
- $key = array_search( $testFileBase . '5.inc', $testFiles, true );
- if ( false !== $key ) {
- unset( $testFiles[ $key ] );
- }
- }
-
- return $testFiles;
- }
-
- /**
- * Returns the lines where errors should occur.
- *
- * @return array =>
- */
- public function getErrorList() {
- return array();
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @param string $testFile The name of the file being tested.
- *
- * @return array =>
- */
- public function getWarningList( $testFile = '' ) {
- switch ( $testFile ) {
- case 'PrecisionAlignmentUnitTest.1.inc':
- return array(
- 20 => 1,
- 27 => 1,
- 30 => 1,
- 31 => 1,
- 32 => 1,
- 39 => 1,
- 65 => 1,
- );
-
- case 'PrecisionAlignmentUnitTest.4.inc':
- return array(
- 1 => 1, // Will show a `Internal.NoCodeFound` warning in PHP 5.3 with short open tags off.
- 2 => ( \PHP_VERSION_ID < 50400 && false === (bool) ini_get( 'short_open_tag' ) ) ? 0 : 1,
- 3 => ( \PHP_VERSION_ID < 50400 && false === (bool) ini_get( 'short_open_tag' ) ) ? 0 : 1,
- 4 => ( \PHP_VERSION_ID < 50400 && false === (bool) ini_get( 'short_open_tag' ) ) ? 0 : 1,
- 5 => ( \PHP_VERSION_ID < 50400 && false === (bool) ini_get( 'short_open_tag' ) ) ? 0 : 1,
- );
-
- case 'PrecisionAlignmentUnitTest.5.inc':
- $warnings = array(
- 9 => 1,
- 14 => 1,
- 19 => 1,
- 24 => 0,
- 29 => 0,
- 34 => 1,
- 39 => 1,
- 44 => 1,
- 54 => 0,
- 56 => 0,
- 58 => 0,
- );
-
- /*
- * The PHPCS 3.2.x versions contained a bug in the selective disable/enable logic
- * compared to the intended behaviour as documented, which prevented the particular
- * messages being tested on these lines from being thrown. See upstream issue #1986.
- */
- if ( version_compare( PHPCSHelper::get_version(), '3.3.0', '>=' ) === true ) {
- $warnings[24] = 1;
- $warnings[29] = 1;
- $warnings[54] = 1;
- $warnings[56] = 1;
- $warnings[58] = 1;
- }
-
- return $warnings;
-
- case 'PrecisionAlignmentUnitTest.6.inc':
- /*
- * {@internal Always returns 1 warning, as for PHPCS < 3.2.0, the PHPCS annotation
- * will be seen as a "normal" comment with precision alignment.
- * For PHPCS 3.2.0+, it will be seen as a PHPCS annotation, but annotations are ignored
- * for this test file, so the precision alignment will be reported.}}
- */
- return array(
- 4 => 1,
- );
-
- case 'PrecisionAlignmentUnitTest.css':
- return array(
- 4 => 1,
- );
-
- case 'PrecisionAlignmentUnitTest.js':
- return array(
- 4 => 1,
- 5 => 1,
- 6 => 1,
- );
-
- case 'PrecisionAlignmentUnitTest.2.inc':
- case 'PrecisionAlignmentUnitTest.3.inc':
- default:
- return array();
- }
- }
-
-}
diff --git a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc b/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc
deleted file mode 100644
index ec7f406707..0000000000
--- a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc
+++ /dev/null
@@ -1,12 +0,0 @@
-= 0; $ptr-- ) {}
-for ( ; ; ) {}
-
-// But it should when the whitespace is between a condition and a semi-colon.
-for ( $i = 1 ; ; $i++ ) {}
diff --git a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc.fixed b/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc.fixed
deleted file mode 100644
index 0a0820f150..0000000000
--- a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc.fixed
+++ /dev/null
@@ -1,12 +0,0 @@
-= 0; $ptr-- ) {}
-for ( ; ; ) {}
-
-// But it should when the whitespace is between a condition and a semi-colon.
-for ( $i = 1; ; $i++ ) {}
diff --git a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.php b/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.php
deleted file mode 100644
index 0dcd1950ef..0000000000
--- a/WordPress/Tests/WhiteSpace/SemicolonSpacingUnitTest.php
+++ /dev/null
@@ -1,46 +0,0 @@
- =>
- */
- public function getErrorList() {
- return array(
- 12 => 1,
- );
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @return array =>
- */
- public function getWarningList() {
- return array();
- }
-
-}
diff --git a/WordPress/Tests/XSS/EscapeOutputUnitTest.inc b/WordPress/Tests/XSS/EscapeOutputUnitTest.inc
deleted file mode 100644
index de23ba675a..0000000000
--- a/WordPress/Tests/XSS/EscapeOutputUnitTest.inc
+++ /dev/null
@@ -1,6 +0,0 @@
- =>
- */
- public function getErrorList() {
- return array();
- }
-
- /**
- * Returns the lines where warnings should occur.
- *
- * @return array =>
- */
- public function getWarningList() {
- return array(
- 1 => 2,
- );
- }
-
-}
diff --git a/WordPress/ruleset.xml b/WordPress/ruleset.xml
index cd3cd73dff..fd24ae6318 100644
--- a/WordPress/ruleset.xml
+++ b/WordPress/ruleset.xml
@@ -1,87 +1,13 @@
-
- WordPress Coding Standards
-
- ./PHPCSAliases.php
-
-
-
-
-
-
-
+
-
-
-
-
-
-
+ WordPress Coding Standards
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
-
- 0
-
-
- 0
-
-
- 0
-
-
-
-
- 0
-
-
-
-
- 0
-
+
+
diff --git a/bin/pre-commit b/bin/pre-commit
deleted file mode 100755
index 4b3e665d70..0000000000
--- a/bin/pre-commit
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/bin/bash
-set -e
-cd "$(git rev-parse --show-toplevel)"
-
-phpcs_root="$(dirname $(dirname $(which phpcs)))"
-
-if [ -z "$phpcs_root" ] || [ ! -d "$phpcs_root" ] || [ ! -e "$phpcs_root/tests/AllTests.php" ]; then
- echo "Unable to locate phpcs on path to locate the root of the PHP_CodeSniffer project" 1>&2
- exit 1
-fi
-
-find . \( -name '*.php' \) -exec php -lf {} \;
-
-PHPCS_DIR=$phpcs_root phpunit --bootstrap="./Test/phpcs3-bootstrap.php" --filter WordPress "$phpcs_root/tests/AllTests.php"
diff --git a/composer.json b/composer.json
index db2f784258..4a287cba2e 100644
--- a/composer.json
+++ b/composer.json
@@ -5,36 +5,84 @@
"keywords": [
"phpcs",
"standards",
+ "static analysis",
"WordPress"
],
"license": "MIT",
"authors": [
{
"name": "Contributors",
- "homepage": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/graphs/contributors"
+ "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors"
}
],
"require": {
- "php": ">=5.3",
- "squizlabs/php_codesniffer": "^2.9.0 || ^3.0.2"
+ "php": ">=5.4",
+ "ext-filter": "*",
+ "ext-libxml": "*",
+ "ext-tokenizer": "*",
+ "ext-xmlreader": "*",
+ "squizlabs/php_codesniffer": "^3.7.2",
+ "phpcsstandards/phpcsutils": "^1.0.8",
+ "phpcsstandards/phpcsextra": "^1.1.0"
},
"require-dev": {
- "phpcompatibility/php-compatibility": "^9.0"
+ "phpcompatibility/php-compatibility": "^9.0",
+ "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0",
+ "phpcsstandards/phpcsdevtools": "^1.2.0",
+ "php-parallel-lint/php-parallel-lint": "^1.3.2",
+ "php-parallel-lint/php-console-highlighter": "^1.0.0"
},
"suggest": {
- "dealerdirect/phpcodesniffer-composer-installer": "^0.4.3 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically."
+ "ext-iconv": "For improved results",
+ "ext-mbstring": "For improved results"
+ },
+ "config": {
+ "allow-plugins": {
+ "dealerdirect/phpcodesniffer-composer-installer": true
+ }
},
- "minimum-stability": "RC",
"scripts": {
- "post-install-cmd": "@install-codestandards",
- "post-update-cmd": "@install-codestandards",
- "check-cs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
- "fix-cs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf",
- "install-codestandards": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs --config-set installed_paths ../../..,../../phpcompatibility/php-compatibility"
+ "lint": [
+ "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --show-deprecated --exclude vendor --exclude .git"
+ ],
+ "check-cs": [
+ "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs"
+ ],
+ "fix-cs": [
+ "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
+ ],
+ "run-tests": [
+ "@php ./vendor/phpunit/phpunit/phpunit --filter WordPress ./vendor/squizlabs/php_codesniffer/tests/AllTests.php --no-coverage"
+ ],
+ "coverage": [
+ "@php ./vendor/phpunit/phpunit/phpunit --filter WordPress ./vendor/squizlabs/php_codesniffer/tests/AllTests.php"
+ ],
+ "check-complete": [
+ "@php ./vendor/phpcsstandards/phpcsdevtools/bin/phpcs-check-feature-completeness -q ./WordPress"
+ ],
+ "check-complete-strict": [
+ "@php ./vendor/phpcsstandards/phpcsdevtools/bin/phpcs-check-feature-completeness ./WordPress"
+ ],
+ "check-all": [
+ "@lint",
+ "@check-cs",
+ "@run-tests",
+ "@check-complete-strict"
+ ]
+ },
+ "scripts-descriptions": {
+ "lint": "Lint PHP files against parse errors.",
+ "check-cs": "Run the PHPCS script against the entire codebase.",
+ "fix-cs": "Run the PHPCBF script to fix all the autofixable violations on the codebase.",
+ "run-tests": "Run all the unit tests for the WordPress Coding Standards sniffs without code coverage.",
+ "coverage": "Run all the unit tests for the WordPress Coding Standards sniffs with code coverage.",
+ "check-complete": "Check if all the sniffs have tests.",
+ "check-complete-strict": "Check if all the sniffs have unit tests and XML documentation.",
+ "check-all": "Run all checks (lint, phpcs, feature completeness) and tests."
},
"support": {
- "issues": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues",
- "wiki": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki",
- "source": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards"
+ "issues": "https://github.com/WordPress/WordPress-Coding-Standards/issues",
+ "wiki": "https://github.com/WordPress/WordPress-Coding-Standards/wiki",
+ "source": "https://github.com/WordPress/WordPress-Coding-Standards"
}
}
diff --git a/phpcs.xml.dist.sample b/phpcs.xml.dist.sample
index 4563369602..c20d803f77 100644
--- a/phpcs.xml.dist.sample
+++ b/phpcs.xml.dist.sample
@@ -1,7 +1,17 @@
-
+
+
A custom set of rules to check for a WPized WordPress project
+
+
+ .
+
/docroot/wp-admin/*
/docroot/wp-includes/*
@@ -19,6 +29,19 @@
*.min.js
+
+
+
+
+
+
+
+
+
@@ -43,7 +66,6 @@
-
@@ -56,31 +78,76 @@
https://github.com/PHPCompatibility/PHPCompatibility
-->
+
+
+
-
+
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+ /path/to/Tests/*Test\.php
+
+
+ /path/to/Tests/*Test\.php
+
+
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
new file mode 100644
index 0000000000..3aafa9a3db
--- /dev/null
+++ b/phpstan.neon.dist
@@ -0,0 +1,26 @@
+parameters:
+ #phpVersion: 50400 # Needs to be 70100 or higher... sigh...
+ level: 5
+ paths:
+ - WordPress
+ bootstrapFiles:
+ - Tests/bootstrap.php
+ treatPhpDocTypesAsCertain: false
+
+ ignoreErrors:
+ # Level 0
+ - '#^Result of method \S+ \(void\) is used\.$#'
+
+ # Level 4
+ - '#^Property \S+::\$\S+ \([^)]+\) in isset\(\) is not nullable\.$#'
+ -
+ count: 1
+ message: '#^Result of && is always true\.$#'
+ path: WordPress/Sniffs/Security/EscapeOutputSniff.php
+ -
+ count: 1
+ message: '#^Strict comparison using === between true and false will always evaluate to false\.$#'
+ path: WordPress/Sniffs/Utils/I18nTextDomainFixerSniff.php
+
+ # Level 5
+ - '#^Parameter \#3 \$value of method \S+File::recordMetric\(\) expects string, \(?(float|int|bool)(\|(float|int|bool))*\)? given\.$#'
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
index 95f66654d0..d041cb7d99 100644
--- a/phpunit.xml.dist
+++ b/phpunit.xml.dist
@@ -3,7 +3,32 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.3/phpunit.xsd"
backupGlobals="true"
- bootstrap="./Test/bootstrap.php"
+ bootstrap="./Tests/bootstrap.php"
beStrictAboutTestsThatDoNotTestAnything="false"
- colors="true">
+ colors="true"
+ forceCoversAnnotation="true">
+
+
+
+ ./WordPress/Tests/
+
+
+
+
+
+ ./WordPress/Sniff.php
+ ./WordPress/AbstractArrayAssignmentRestrictionsSniff.php
+ ./WordPress/AbstractClassRestrictionsSniff.php
+ ./WordPress/AbstractFunctionParameterSniff.php
+ ./WordPress/AbstractFunctionRestrictionsSniff.php
+ ./WordPress/Sniffs/
+ ./WordPress/Helpers/
+
+
+
+
+
+
+
+