Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes I18NSniff for multi-line gettext calls #1962

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fixes I18NSniff for multi-line gettext calls #1962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
92 changes: 51 additions & 41 deletions WordPress/Sniffs/WP/I18nSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,63 +701,73 @@ protected function check_for_translator_comment( $stack_ptr, $args ) {
continue;
}

$previous_comment = $this->phpcsFile->findPrevious( Tokens::$commentTokens, ( $stack_ptr - 1 ) );

if ( false !== $previous_comment ) {
/*
* Check that the comment is either on the line before the gettext call or
* if it's not, that there is only whitespace between.
*/
$correctly_placed = false;

if ( ( $this->tokens[ $previous_comment ]['line'] + 1 ) === $this->tokens[ $stack_ptr ]['line'] ) {
/*
* Check that the comment is either on the line before the gettext call or
* if it's not, that there is only whitespace between.
*
* For multiline gettext calls, check that the comment is either on the same line with the gettext call
* or between the gettext call and the next string
*/

$correctly_placed = false;
$instruction_end = $this->phpcsFile->findEndOfStatement( $stack_ptr );
$next_string = $this->phpcsFile->findNext( Tokens::$stringTokens, $stack_ptr + 1 );

if ( $this->tokens[ $instruction_end ]['line'] > $this->tokens[ $stack_ptr ]['line'] && $next_string && $this->tokens[ $next_string ]['line'] !== $this->tokens[ $stack_ptr ]['line'] ) {
$comment = $this->phpcsFile->findNext( Tokens::$commentTokens, $stack_ptr + 1 );
if ( $this->tokens[ $comment ]['line'] >= $this->tokens[ $stack_ptr ]['line'] && $this->tokens[ $comment ]['line'] <= $this->tokens[ $next_string ]['line'] ) {
$correctly_placed = true;
}
} else {
$comment = $this->phpcsFile->findPrevious( Tokens::$commentTokens, $stack_ptr - 1 );
if ( ( $this->tokens[ $comment ]['line'] + 1 ) === $this->tokens[ $stack_ptr ]['line'] ) {
$correctly_placed = true;
} else {
$next_non_whitespace = $this->phpcsFile->findNext( \T_WHITESPACE, ( $previous_comment + 1 ), $stack_ptr, true );
$next_non_whitespace = $this->phpcsFile->findNext( \T_WHITESPACE, ( $comment + 1 ), $stack_ptr, true );
if ( false === $next_non_whitespace || $this->tokens[ $next_non_whitespace ]['line'] === $this->tokens[ $stack_ptr ]['line'] ) {
// No non-whitespace found or next non-whitespace is on same line as gettext call.
$correctly_placed = true;
}
unset( $next_non_whitespace );
}
}

if ( false !== $comment && true === $correctly_placed ) {
/*
* Check that the comment starts with 'translators:'.
*/
if ( true === $correctly_placed ) {

if ( \T_COMMENT === $this->tokens[ $previous_comment ]['code'] ) {
$comment_text = trim( $this->tokens[ $previous_comment ]['content'] );

// If it's multi-line /* */ comment, collect all the parts.
if ( '*/' === substr( $comment_text, -2 ) && '/*' !== substr( $comment_text, 0, 2 ) ) {
for ( $i = ( $previous_comment - 1 ); 0 <= $i; $i-- ) {
if ( \T_COMMENT !== $this->tokens[ $i ]['code'] ) {
break;
}

$comment_text = trim( $this->tokens[ $i ]['content'] ) . $comment_text;
if ( \T_COMMENT === $this->tokens[ $comment ]['code'] ) {
$comment_text = trim( $this->tokens[ $comment ]['content'] );

// If it's multi-line /* */ comment, collect all the parts.
if ( '*/' === substr( $comment_text, - 2 ) && '/*' !== substr( $comment_text, 0, 2 ) ) {
for ( $i = ( $comment - 1 ); 0 <= $i; $i -- ) {
if ( \T_COMMENT !== $this->tokens[ $i ]['code'] ) {
break;
}
}

if ( true === $this->is_translators_comment( $comment_text ) ) {
// Comment is ok.
return;
}
} elseif ( \T_DOC_COMMENT_CLOSE_TAG === $this->tokens[ $previous_comment ]['code'] ) {
// If it's docblock comment (wrong style) make sure that it's a translators comment.
$db_start = $this->phpcsFile->findPrevious( \T_DOC_COMMENT_OPEN_TAG, ( $previous_comment - 1 ) );
$db_first_text = $this->phpcsFile->findNext( \T_DOC_COMMENT_STRING, ( $db_start + 1 ), $previous_comment );

if ( true === $this->is_translators_comment( $this->tokens[ $db_first_text ]['content'] ) ) {
$this->phpcsFile->addWarning(
'A "translators:" comment must be a "/* */" style comment. Docblock comments will not be picked up by the tools to generate a ".pot" file.',
$stack_ptr,
'TranslatorsCommentWrongStyle'
);
return;
$comment_text = trim( $this->tokens[ $i ]['content'] ) . $comment_text;
}
}

if ( true === $this->is_translators_comment( $comment_text ) ) {
// Comment is ok.
return;
}
} elseif ( \T_DOC_COMMENT_CLOSE_TAG === $this->tokens[ $comment ]['code'] ) {
// If it's docblock comment (wrong style) make sure that it's a translators comment.
$db_start = $this->phpcsFile->findPrevious( \T_DOC_COMMENT_OPEN_TAG, ( $comment - 1 ) );
$db_first_text = $this->phpcsFile->findNext( \T_DOC_COMMENT_STRING, ( $db_start + 1 ), $comment );

if ( true === $this->is_translators_comment( $this->tokens[ $db_first_text ]['content'] ) ) {
$this->phpcsFile->addWarning(
'A "translators:" comment must be a "/* */" style comment. Docblock comments will not be picked up by the tools to generate a ".pot" file.',
$stack_ptr,
'TranslatorsCommentWrongStyle'
);

return;
}
}
}

Expand Down
20 changes: 20 additions & 0 deletions WordPress/Tests/WP/I18nUnitTest.2.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,23 @@ _e(); // Bad.
printf( __( 'There are %1$d monkeys in the %2$s', 'my-slug' ), intval( $number ), esc_html( $string ) ); // Bad.

// phpcs:set WordPress.WP.I18n text_domain[]

/* translators: number of monkeys, location. */
__( 'There are %1$d monkeys in the %2$s'
); // Ok, the string is on the same line as the gettext call

__( /* translators: number of monkeys, location. */
'There are %1$d monkeys in the %2$s'
); // OK, comment is on the same line as the gettext call

/* translators: number of monkeys, location. */
_n(
'There are %1$d monkeys in the %2$s',
'There are %1$d monkeys in the %2$s'
); // Bad, comment will not be extracted

_n(
/* translators: number of monkeys, location. */
'There are %1$d monkeys in the %2$s',
'There are %1$d monkeys in the %2$s'
); // Ok, comment will be extracted
2 changes: 2 additions & 0 deletions WordPress/Tests/WP/I18nUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,9 @@ public function getWarningList( $testFile = '' ) {
52 => 1,
74 => 1,
85 => 1,
94 => 1,
108 => 1,
121 => 1,
);

default:
Expand Down