Skip to content

Add i18n context for resolving invalid blocks#10779

Merged
youknowriad merged 2 commits intomasterfrom
add/context-for-block-resolve-strings
Oct 27, 2018
Merged

Add i18n context for resolving invalid blocks#10779
youknowriad merged 2 commits intomasterfrom
add/context-for-block-resolve-strings

Conversation

@brandonpayton
Copy link
Copy Markdown
Member

@brandonpayton brandonpayton commented Oct 19, 2018

Description

This is a simple PR to add i18n context for "Resolve" and "Resolve Block" strings to resolve translation concerns from this comment.

@gAllegr, does this address your issue with the strings?

Screenshots

screen shot 2018-10-19 at 12 18 12 am

screen shot 2018-10-19 at 12 18 20 am

@brandonpayton brandonpayton added the Internationalization (i18n) Issues or PRs related to internationalization efforts label Oct 19, 2018
@brandonpayton brandonpayton self-assigned this Oct 19, 2018
@brandonpayton brandonpayton requested a review from aduth October 19, 2018 07:22
@brandonpayton brandonpayton mentioned this pull request Oct 19, 2018
Merged
@gziolo gziolo added this to the 4.2 - API freeze milestone Oct 19, 2018
@gAllegr
Copy link
Copy Markdown

gAllegr commented Oct 19, 2018

Yes, thank you, these screenshots are much more explicative.
Even better would be add a specific comment for the two strings, something like the following screenshot. While translating it's not obvious where strings are located.
Maybe Button to fix content for Resolve string and Window title to fix content for the Resolve block one?

comment

@brandonpayton brandonpayton force-pushed the add/context-for-block-resolve-strings branch from 06bab87 to 4593fb8 Compare October 25, 2018 19:38
@brandonpayton
Copy link
Copy Markdown
Member Author

brandonpayton commented Oct 25, 2018

Thanks for the additional suggestions, @gAllegr. This is good to be learning.

I made an update based on your comments. How does the latest look?

mcsf
mcsf approved these changes Oct 26, 2018
View reviewed changes
Copy link
Copy Markdown
Contributor

@mcsf mcsf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: is the line break needed at all?

// translators: Dialog title to fix block content
title={ __( 'Resolve Block' ) }

other than that question: good to merge, the notes and syntactic case are good.

@aduth
Copy link
Copy Markdown
Member

aduth commented Oct 26, 2018

Nitpick: is the line break needed at all?

The parser is a little picky, and while the comment doesn't need to strictly be a leading comment of the translation call, it does need to be a leading comment of one of its parents in the AST hierarchy. This might actually work here as the leading comment of the attribute assignment, but it's worth verifying.

tl;dr The parser doesn't strictly consider "previous line", it considers leading comments of its AST ancestry which occur on the current or previous line.

See

gutenberg/packages/babel-plugin-makepot/src/index.js

Lines 109 to 157 in a548961

/**
* Returns translator comment for a given AST traversal path if one exists.
*
* @param {Object} path Traversal path.
* @param {number} _originalNodeLine Private: In recursion, line number of
* the original node passed.
*
* @return {?string} Translator comment.
*/
function getTranslatorComment( path, _originalNodeLine ) {
const { node, parent, parentPath } = path;
// Assign original node line so we can keep track in recursion whether a
// matched comment or parent occurs on the same or previous line
if ( ! _originalNodeLine ) {
_originalNodeLine = node.loc.start.line;
}
let comment;
forEach( node.leadingComments, ( commentNode ) => {
const { line } = commentNode.loc.end;
if ( line < _originalNodeLine - 1 || line > _originalNodeLine ) {
return;
}
const match = commentNode.value.match( REGEXP_TRANSLATOR_COMMENT );
if ( match ) {
// Extract text from matched translator prefix
comment = match[ 1 ].split( '\n' ).map( ( text ) => text.trim() ).join( ' ' );
// False return indicates to Lodash to break iteration
return false;
}
} );
if ( comment ) {
return comment;
}
if ( ! parent || ! parent.loc || ! parentPath ) {
return;
}
// Only recurse as long as parent node is on the same or previous line
const { line } = parent.loc.start;
if ( line >= _originalNodeLine - 1 && line <= _originalNodeLine ) {
return getTranslatorComment( parentPath, _originalNodeLine );
}
}

@gAllegr
Copy link
Copy Markdown

gAllegr commented Oct 26, 2018

Thanks for the additional suggestions, @gAllegr. This is good to be learning.

I made an update based on your comments. How does the latest look?

Looks ok to me
Generally speaking, while coding and preparing for internationalization, if you found something that might generate confusion it is great to add a comment for translators

@youknowriad youknowriad merged commit 9d33098 into master Oct 27, 2018
@youknowriad youknowriad deleted the add/context-for-block-resolve-strings branch October 27, 2018 11:55
@mtias mtias added the [Type] Enhancement A suggestion for improvement. label Oct 30, 2018
@aduth
Copy link
Copy Markdown
Member

aduth commented Nov 6, 2018

Nitpick: is the line break needed at all?

Based on #11494 / #11514, it appears it is needed (as merged here should be fine).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcsf mcsf mcsf approved these changes

@aduth aduth Awaiting requested review from aduth

Assignees

@brandonpayton brandonpayton

Labels

Internationalization (i18n) Issues or PRs related to internationalization efforts [Type] Enhancement A suggestion for improvement.

Projects

None yet

Milestone

4.2

Development

Successfully merging this pull request may close these issues.

7 participants

@brandonpayton @gAllegr @aduth @mcsf @youknowriad @mtias @gziolo