WP/I18n: remove the public check_translator_comments property

The `$check_translator_comments` property was introduced in WPCS `0.11.0` via PR 742 mostly to make our own lives easier managing the test case files.
It allowed the pre-existing test case file `1` to remain largely unchanged, while the errors for translators comments were tested in a new test case file `2`.

At the time, the ability to use modular ignore annotations, i.e. `// phpcs:disable Sniffcode`, did not exist yet.

As those now _do_ exist and the minimum supported PHPCS version is beyond the version in which support for the modular ignore annotations was introduced, we can use those instead in the test case files and no longer need the property.

For end-users, the use of the property has always been discouraged as they could exclude the error codes in their ruleset instead, so the impact of this change for end-users is expected to be minimal.

The removal of the property should be annotated in the wiki when it is being updated for the release of WPCS 3.0.0. Related 1917.

Author: jrfnl

WordPress/Sniffs/WP/I18nSniff.php

@@ -122,18 +122,6 @@ final class I18nSniff extends AbstractFunctionParameterSniff {
 		'_nx_noop'                       => 'noopnumber_context',
 	);
 
-	/**
-	 * Toggle whether or not to check for translators comments for text string containing placeholders.
-	 *
-	 * Intended to make this part of the sniff unit testable, but can be used by end-users too,
-	 * though they can just as easily disable this via the sniff code.
-	 *
-	 * @since 0.11.0
-	 *
-	 * @var bool
-	 */
-	public $check_translator_comments = true;
-
 	/**
 	 * Whether or not the `default` text domain is one of the allowed text domains.
 	 *
@@ -411,9 +399,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 		/*
 		 * Check if a translators comments is necessary and if so, if it exists.
 		 */
-		if ( true === $this->check_translator_comments ) {
-			$this->check_for_translator_comment( $stackPtr, $matched_content, $parameter_details );
-		}
+		$this->check_for_translator_comment( $stackPtr, $matched_content, $parameter_details );
 	}
 
 	/**

WordPress/Tests/WP/I18nUnitTest.1.inc

@@ -1,6 +1,6 @@
 <?php
 
-// phpcs:set WordPress.WP.I18n check_translator_comments false
+// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment -- Translator comment issues are tested in test case file 2.
 
 __( 'string' ); // OK - no text domain known, so not checked.
 __( 'string', 'something' ); // OK - no text domain known, so not checked.
@@ -302,4 +302,4 @@ _n_noop( domain: 'default' /*comment*/, singular: 'translate me', plural: 'trans
 _nx_noop( singular: 'translate me', domain /*comment*/: 'default', plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
 
 // phpcs:set WordPress.WP.I18n text_domain[]
-// phpcs:set WordPress.WP.I18n check_translator_comments true
+// phpcs:enable WordPress.WP.I18n.MissingTranslatorsComment

WordPress/Tests/WP/I18nUnitTest.1.inc.fixed

@@ -1,6 +1,6 @@
 <?php
 
-// phpcs:set WordPress.WP.I18n check_translator_comments false
+// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment -- Translator comment issues are tested in test case file 2.
 
 __( 'string' ); // OK - no text domain known, so not checked.
 __( 'string', 'something' ); // OK - no text domain known, so not checked.
@@ -302,4 +302,4 @@ _n_noop( domain: 'default' /*comment*/, singular: 'translate me', plural: 'trans
 _nx_noop( singular: 'translate me', domain /*comment*/: 'default', plural: 'translate me', context: 'context', ); // Bad: superfluous domain.
 
 // phpcs:set WordPress.WP.I18n text_domain[]
-// phpcs:set WordPress.WP.I18n check_translator_comments true
+// phpcs:enable WordPress.WP.I18n.MissingTranslatorsComment