Extract strings contained within eval() #222

dd32 · 2020-07-24T05:11:31Z

Some build systems can result in the built files gettext functions being inside eval() calls.

One such example of this, is a webpack'd built file in this plugin: https://plugins.trac.wordpress.org/browser/mathml-block/trunk/dist/mathml-block.js?rev=2276811#L245

Currently, the relevant output is this:

#: src/mathml-block.js:35
msgid "MathML formula:"
msgstr ""

#: src/mathml-inline.js:10
msgid "MathML"
msgstr ""

which doesn't work for WordPress Translation files, as those src files are never enqueued, only the built files.
After the change, here's the output:

#: dist/mathml-block.js:245
#: src/mathml-block.js:35
msgid "MathML formula:"
msgstr ""

#: dist/mathml-block.js:257
#: src/mathml-inline.js:10
msgid "MathML"
msgstr ""

dd32 · 2020-07-25T00:52:43Z

The unit tests keep timing out on trunk only - I'm not sure why as I've not been able to run then locally.

swissspidy · 2020-07-30T09:29:21Z

Interesting edge case & nice solution for the line number!

Would you be able to add some Behat tests for this? Could probably just copy some lines from the MathML plugin and then verify that strings are extracted as expected with the correct line number.

dd32 · 2020-07-31T00:13:55Z

I'll get some tests added @swissspidy - Hopefully I can figure out how to run the tests locally

dd32 · 2020-07-31T06:11:39Z

Unfortunately I wasn't able to get tests running locally, and there are no existing tests for the JS set of extraction methods, so I can't really fly into it blind either.

swissspidy · 2020-07-31T08:49:24Z

There are no unit tests for it, but Behat tests, starting here:

i18n-command/features/makepot.feature

Lines 1559 to 1580 in b02ecdc

    
             Scenario: Extracts functions from JavaScript file 
        
               Given an empty foo-plugin directory 
        
               And a foo-plugin/foo-plugin.php file: 
        
                 """ 
        
                 <?php 
        
                 /** 
        
                  * Plugin Name: Foo Plugin 
        
                  */ 
        
                 """ 
        
               And a foo-plugin/foo-plugin.js file: 
        
                 """ 
        
                 // Included to test if peast correctly parses regexes containing a quote. 
        
                 // See: https://github.com/wp-cli/i18n-command/issues/98 
        
                 n = n.replace(/"/g, '&quot;'); 
        
                 n = n.replace(/"|'/g, '&quot;'); 
        
                 __( '__', 'foo-plugin' ); 
        
                 _x( '_x', '_x_context', 'foo-plugin' ); 
        
                 _n( '_n_single', '_n_plural', number, 'foo-plugin' ); 
        
                 _nx( '_nx_single', '_nx_plural', number, '_nx_context', 'foo-plugin' ); 
        
                 __( 'wrong-domain', 'wrong-domain' );

If it's not working, feel free to add me to your fork so I could amend, otherwise I can open a new PR with your commit in it and the tests.

swissspidy · 2020-09-19T08:42:33Z

@schlessera Any idea about the test timeouts? I can't re-start Travis in case it's just a flake.

…an the location within the eval contents.

…hat's a literal. Tests ran into a BinaryExpression here, which doesn't appear to be expected.

dd32 requested a review from wp-cli/committers as a code owner Jul 24, 2020

dd32 added bug command:i18n-make-pot labels Jul 24, 2020

dd32 mentioned this pull request Jul 24, 2020

Make JS translations work adamsilverstein/mathml-block#29

Merged

swissspidy approved these changes Aug 19, 2020

View changes

adamsilverstein mentioned this pull request Oct 19, 2020

Plugin translations not rendering fully translated strings google/site-kit-wp#2171

Closed

dd32 added 7 commits Jul 24, 2020

Extract strings contained within eval() contents.

121bc99

Set the line reference of the string to that of the eval(), rather th…

38548bb

…an the location within the eval contents.

Be more strict

e9d12ad

Pretend you never saw this variable typo.

3e861e4

Iterate over the node arguments and only process the first argument t…

65c6aac

…hat's a literal. Tests ran into a BinaryExpression here, which doesn't appear to be expected.

Attempt to add a behat test for string extraction from within evals.

6cda0c9

Whitespace is good

1ebe57f

schlessera force-pushed the dd32:extractJSEval branch from 7083bcf to 1ebe57f Mar 5, 2021

schlessera added this to the 2.2.7 milestone Mar 5, 2021

wp-cli / i18n-command

Extract strings contained within eval() #222

Extract strings contained within eval() #222

dd32 commented Jul 24, 2020

dd32 commented Jul 25, 2020

swissspidy commented Jul 30, 2020

dd32 commented Jul 31, 2020

dd32 commented Jul 31, 2020

swissspidy commented Jul 31, 2020

swissspidy commented Sep 19, 2020

wp-cli / i18n-command

Extract strings contained within eval() #222

Extract strings contained within eval() #222

Conversation

dd32 commented Jul 24, 2020

dd32 commented Jul 25, 2020

swissspidy commented Jul 30, 2020

dd32 commented Jul 31, 2020

dd32 commented Jul 31, 2020

swissspidy commented Jul 31, 2020

swissspidy commented Sep 19, 2020