Skip to content

JavaScript String Extraction #26

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

Merged
schlessera merged 20 commits into from
Jul 4, 2018
Merged

JavaScript String Extraction #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e40a373
First pass at JS string extraction
swissspidy Apr 27, 2018
dd032a0
Add some failing tests for translator comments
swissspidy Apr 27, 2018
299e12e
Remove dead code
swissspidy Apr 30, 2018
5ef5ab1
Add some helpful debug lines
swissspidy Apr 30, 2018
33970bc
Improve comments extraction
swissspidy Apr 30, 2018
08c3a34
Simplify comments extraction
swissspidy May 2, 2018
9ac13fa
Skip some common JS files
swissspidy May 2, 2018
5b0408e
Update mck89/peast for JSX support
swissspidy Jun 19, 2018
dd5fdcb
Use some JSX in tests
swissspidy Jun 19, 2018
c85c69c
Merge branch 'master' into js-code-extraction
swissspidy Jul 3, 2018
d5ce1ec
Fix typo in scenario name
swissspidy Jul 3, 2018
91004e3
Enable JSX option in Peast
swissspidy Jul 3, 2018
91f8fdc
Update readme
swissspidy Jul 3, 2018
36a3876
Add `--skip-js` option
swissspidy Jul 3, 2018
c34b0b9
Rename scan_js to skip_js for increased readability
swissspidy Jul 4, 2018
32b2135
Fix code annotations
swissspidy Jul 4, 2018
e04360a
Remove obsolete todo comment
swissspidy Jul 4, 2018
93a7fdd
Final & private
swissspidy Jul 4, 2018
f4f58ae
Merge branch 'master' into js-code-extraction
swissspidy Jul 4, 2018
57a4d58
Add missing new-line
schlessera Jul 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ wp i18n
Create a POT file for a WordPress plugin or theme.

~~~
wp i18n make-pot <source> [<destination>] [--slug=<slug>] [--domain=<domain>] [--merge[=<file>]] [--exclude=<paths>]
wp i18n make-pot <source> [<destination>] [--slug=<slug>] [--domain=<domain>] [--merge[=<file>]] [--exclude=<paths>] [--skip-js]
~~~

Scans PHP and JavaScript files, as well as theme stylesheets for translatable strings.

**OPTIONS**

<source>
Expand All @@ -57,6 +59,9 @@ wp i18n make-pot <source> [<destination>] [--slug=<slug>] [--domain=<domain>] [-
By default, the following files and folders are ignored: node_modules, .git, .svn, .CVS, .hg, vendor.
Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`.

[--skip-js]
Skips JavaScript string extraction. Useful when this is done in another build step, e.g. through Babel.

**EXAMPLES**

# Create a POT file for the WordPress plugin/theme in the current directory
Expand Down
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
]
},
"require": {
"gettext/gettext": "dev-master#37882dc3b58c2357fc6ddc204c1f22f7bb2b6601"
"gettext/gettext": "dev-master#37882dc3b58c2357fc6ddc204c1f22f7bb2b6601",
"mck89/peast": "^1.8"
},
"require-dev": {
"wp-cli/wp-cli": "^1.1.0",
Expand Down
283 changes: 274 additions & 9 deletions features/makepot.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Feature: Generate a POT file of a WordPress plugin
"""
Description of the plugin
"""

Scenario: Adds copyright comments
When I run `wp scaffold plugin hello-world`

Expand Down Expand Up @@ -188,12 +189,20 @@ Feature: Generate a POT file of a WordPress plugin

__( 'Hello World', 'foo-plugin' );
"""
And a foo-plugin/foo-plugin.js file:
"""
__( 'Hello World', 'foo-plugin' );
"""

When I run `wp i18n make-pot foo-plugin foo-plugin.pot`
And the foo-plugin.pot file should contain:
"""
#: foo-plugin.php:15
"""
And the foo-plugin.pot file should contain:
"""
#: foo-plugin.js:1
"""

Scenario: Uses the current folder as destination path when none is set.
When I run `wp scaffold plugin hello-world`
Expand Down Expand Up @@ -401,14 +410,6 @@ Feature: Generate a POT file of a WordPress plugin
"""
msgid_plural "__ngettext_noop_plural"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "__"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "__"
"""
And the foo-plugin/foo-plugin.pot file should not contain:
"""
msgid "__unsupported_func"
Expand Down Expand Up @@ -447,7 +448,7 @@ Feature: Generate a POT file of a WordPress plugin

/* translators: this should get extracted. */ $foo = __( 'baba', 'foo-plugin' );

/* translators: boo */ /* translators: this should get extracted too. */ /* some other comment */ $bar = g ( __( 'baba', 'foo-plugin' ) );
/* translators: boo */ /* translators: this should get extracted too. */ /* some other comment */ $bar = g ( __( 'bubu', 'foo-plugin' ) );
"""

When I run `wp i18n make-pot foo-plugin`
Expand Down Expand Up @@ -997,3 +998,267 @@ Feature: Generate a POT file of a WordPress plugin
"""
msgid "Foo Plugin"
"""

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:
"""
__( '__', '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' );

__( 'Hello world' ); // translators: Greeting

// translators: Foo Bar Comment
__( 'Foo Bar', 'foo-plugin' );

// TrANslAtORs: Bar Baz Comment
__( 'Bar Baz', 'foo-plugin' );

// translators: Software name
const string = __( 'WordPress', 'foo-plugin' );

// translators: So much space

__( 'Spacey text', 'foo-plugin' );

/* translators: Long comment
spanning multiple
lines */
const string = __( 'Short text', 'foo-plugin' );

ReactDOM.render(
<h1>{__( 'Hello JSX', 'foo-plugin' )}</h1>,
document.getElementById('root')
);
"""

When I run `wp i18n make-pot foo-plugin`
Then STDOUT should be:
"""
Plugin file detected.
Success: POT file successfully generated!
"""
And the foo-plugin/foo-plugin.pot file should exist
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "__"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "_x"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgctxt "_x_context"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "_n_single"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid_plural "_n_plural"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "_nx_single"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid_plural "_nx_plural"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgctxt "_nx_context"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "Hello JSX"
"""
And the foo-plugin/foo-plugin.pot file should not contain:
"""
msgid "wrong-domain"
"""

Scenario: Extract translator comments 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:
"""
/* translators: Translators 1! */
__( 'hello world', 'foo-plugin' );

/* Translators: Translators 2! */
const foo = __( 'foo', 'foo-plugin' );

/* translators: localized date and time format, see https://secure.php.net/date */
__( 'F j, Y g:i a', 'foo-plugin' );

// translators: let your ears fly!
__( 'on', 'foo-plugin' );

/*
* Translators: If there are characters in your language that are not supported
* by Lato, translate this to 'off'. Do not translate into your own language.
*/
__( 'off', 'foo-plugin' );

/* translators: this should get extracted. */ let bar = __( 'baba', 'foo-plugin' );

/* translators: boo */ /* translators: this should get extracted too. */ /* some other comment */ let bar = g ( __( 'bubu', 'foo-plugin' ) );

/* translators: this is before the multiline call. */
var baz = __(
/* translators: this is inside the multiline call. */
'This is the original',
'foo-plugin'
);

ReactDOM.render(
/* translators: this is JSX */
<h1>{__( 'Hello JSX', 'foo-plugin' )}</h1>,
document.getElementById('root')
);
"""

When I run `wp i18n make-pot foo-plugin`
Then STDOUT should be:
"""
Plugin file detected.
Success: POT file successfully generated!
"""
And the foo-plugin/foo-plugin.pot file should exist
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "Foo Plugin"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: Translators 1!
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. Translators: Translators 2!
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
msgid "F j, Y g:i a"
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: localized date and time format, see https://secure.php.net/date
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: let your ears fly!
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. Translators: If there are characters in your language that are not supported by Lato, translate this to 'off'. Do not translate into your own language.
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: this should get extracted.
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: boo
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: this should get extracted too.
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: this is before the multiline call.
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: this is inside the multiline call.
"""
And the foo-plugin/foo-plugin.pot file should contain:
"""
#. translators: this is JSX
"""

Scenario: Ignores any other text domain in 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:
"""
__( 'Hello World', 'foo-plugin' );

__( 'Foo', 'bar' );

__( 'bar' );

ReactDOM.render(
<h1>{__( 'Hello JSX', 'baz' )}</h1>,
document.getElementById('root')
);
"""

When I run `wp i18n make-pot foo-plugin foo-plugin.pot --domain=bar`
And the foo-plugin.pot file should contain:
"""
msgid "Foo"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello World"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "bar"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello JSX"
"""

Scenario: Skips JavaScript file altogether
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:
"""
__( 'Hello World', 'foo-plugin' );
"""

When I run `wp i18n make-pot foo-plugin foo-plugin.pot --skip-js`
And the foo-plugin.pot file should contain:
"""
msgid "Foo Plugin"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello World"
"""
Loading