Skip to content

Add option --skip-php to i18n make-pot command #207

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 8 commits into from
Apr 1, 2020
Merged

Add option --skip-php to i18n make-pot command #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d75df4d
--skip-php param introduced
pmbaldha Apr 1, 2020
6360c93
Removed extra s which remained by mistake
pmbaldha Apr 1, 2020
2461b84
Remove extra comment to debug
pmbaldha Apr 1, 2020
19f76b4
PHPCBF fixed
pmbaldha Apr 1, 2020
f9fdaa3
Added var default initialization
pmbaldha Apr 1, 2020
06f8d0c
i18n make-pot --skip-php behat tests added
pmbaldha Apr 1, 2020
f282e87
Remove unneeded extra lines from behat tests
pmbaldha Apr 1, 2020
726924f
--skip-js behat test corrected
pmbaldha Apr 1, 2020
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
70 changes: 70 additions & 0 deletions features/makepot.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1981,6 +1981,76 @@ Feature: Generate a POT file of a WordPress project
msgid "Hello World"
"""

Scenario: Skips PHP file altogether
Given an empty foo-plugin directory
And a foo-plugin/foo-plugin.php file:
"""
<?php
/**
* Plugin Name: Foo Plugin
*/

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

When I run `wp i18n make-pot foo-plugin foo-plugin.pot --skip-php`
Then STDOUT should be:
"""
Plugin file detected.
Success: POT file successfully generated!
"""
And the foo-plugin.pot file should contain:
"""
msgid "Foo Plugin"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello World from PHP"
"""
And the foo-plugin.pot file should contain:
"""
msgid "Hello World from JavaScript"
"""

Scenario: Skips JavaScript file and PHP file altogether
Given an empty foo-plugin directory
And a foo-plugin/foo-plugin.php file:
"""
<?php
/**
* Plugin Name: Foo Plugin
*/

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

When I run `wp i18n make-pot foo-plugin foo-plugin.pot --skip-js --skip-php`
Then STDOUT should be:
"""
Plugin file detected.
Success: POT file successfully generated!
"""
And the foo-plugin.pot file should contain:
"""
msgid "Foo Plugin"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello World from PHP"
"""
And the foo-plugin.pot file should not contain:
"""
msgid "Hello World from JavaScript"
"""

Scenario: Extract all strings regardless of text domain
Given an empty foo-plugin directory
And a foo-plugin/foo-plugin.php file:
Expand Down
27 changes: 19 additions & 8 deletions src/MakePotCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ class MakePotCommand extends WP_CLI_Command {
*/
protected $skip_js = false;

/**
* @var bool
*/
protected $skip_php = false;

/**
* @var bool
*/
Expand Down Expand Up @@ -190,6 +195,9 @@ class MakePotCommand extends WP_CLI_Command {
* [--skip-js]
* : Skips JavaScript string extraction. Useful when this is done in another build step, e.g. through Babel.
*
* [--skip-php]
* : Skips PHP string extraction.
*
* [--skip-audit]
* : Skips string audit where it tries to find possible mistakes in translatable strings. Useful when running in an
* automated environment.
Expand Down Expand Up @@ -267,6 +275,7 @@ public function handle_arguments( $args, $assoc_args ) {
$this->source = realpath( $args[0] );
$this->slug = Utils\get_flag_value( $assoc_args, 'slug', Utils\basename( $this->source ) );
$this->skip_js = Utils\get_flag_value( $assoc_args, 'skip-js', $this->skip_js );
$this->skip_php = Utils\get_flag_value( $assoc_args, 'skip-php', $this->skip_php );
$this->skip_audit = Utils\get_flag_value( $assoc_args, 'skip-audit', $this->skip_audit );
$this->headers = Utils\get_flag_value( $assoc_args, 'headers', $this->headers );
$this->file_comment = Utils\get_flag_value( $assoc_args, 'file-comment' );
Expand Down Expand Up @@ -560,14 +569,16 @@ protected function extract_strings() {
}

try {
$options = [
// Extract 'Template Name' headers in theme files.
'wpExtractTemplates' => isset( $this->main_file_data['Theme Name'] ),
'include' => $this->include,
'exclude' => $this->exclude,
'extensions' => [ 'php' ],
];
PhpCodeExtractor::fromDirectory( $this->source, $translations, $options );
if ( ! $this->skip_php ) {
$options = [
// Extract 'Template Name' headers in theme files.
'wpExtractTemplates' => isset( $this->main_file_data['Theme Name'] ),
'include' => $this->include,
'exclude' => $this->exclude,
'extensions' => [ 'php' ],
];
PhpCodeExtractor::fromDirectory( $this->source, $translations, $options );
}

if ( ! $this->skip_js ) {
JsCodeExtractor::fromDirectory(
Expand Down