Describe the bug

Strings inside the ternary operators are not detected & extracted.

To Reproduce

const wpPot = require('wp-pot')

wpPot({
	destFile: 'file.pot',
	domain: 'domain',
	package: 'Example project',
	src: 'test.php',
})

Sample PHP file:

<?php

$condition = true;
$output = $condition ? __('Test 1', 'domain') : __('Test 2', 'domain');
$second_output = __('Test 3', 'domain');

Output:

# This file is distributed under the same license as the Example project package.
msgid ""
msgstr ""
"Project-Id-Version: Example project\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Poedit-Basepath: ..\n"
"X-Poedit-KeywordsList: __;_e;_ex:1,2c;_n:1,2;_n_noop:1,2;_nx:1,2,4c;_nx_noop:1,2,3c;_x:1,2c;esc_attr__;esc_attr_e;esc_attr_x:1,2c;esc_html__;esc_html_e;esc_html_x:1,2c\n"
"X-Poedit-SearchPath-0: .\n"
"X-Poedit-SearchPathExcluded-0: *.js\n"
"X-Poedit-SourceCharset: UTF-8\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#: test.php:5
msgid "Test 3"
msgstr ""

Outcome

Only "Test 3" string is in the pot file.

Expected

All 3 strings from the PHP file are in the final POT file.

Module versions

└─┬ [email protected]
  └─┬ [email protected]
    └─┬ [email protected]
      └── [email protected]

Describe the bug
This is an edge case.
When the source code have a call with an empty string, the generated .pot file creates a block for this string without the msgid.

This turns the .pot file invalid and this issue is carried when you create .po files from it.
If you try to compile the .po to .mo files you'll receive a fatal error.

To Reproduce
Generate a .pot with any empty call e.g. __( '', 'testdomain' );
Grab the generated file and create a .po from it.
Compile to .mo and receive a fatal error.

Module versions

[email protected] /Users/breno-proxio/wp-pot
└── [email protected]

Additional context
WP-CLI make-pot command skips those types of strings.

I was trying to fix this, but it seems more complex than I thought.
May involve some parser setup.

Describe the bug
When a translation string with a placeholder (%s) is used multiple times, the accompanying comment for translators is included as many times in the resulting POT file.

This also concerns the gulp-wp-pot package of course.

To Reproduce
I made a Gist with a minimal example to reproduce.

NB: This Gist also includes a feature that might be nice to include in the main package using an option.

Using version 1.1.5, translator notes in my PHP file are not getting added to the generated .pot file as expected.

Source:

<?php
/* translators: PHP date string used by mysql2date function */
$date_string = __( 'j F Y @ g:i a', 'my_textdomain' );
?>

Output:

#: assets/functions/admin.php:56
msgid "j F Y @ g:i a"
msgstr ""

I'd like to remove all the comments in the resulting .pot file. I don't see an option to do this, so thought I'd reach out for a feature request :-).

The devDependency eslint-plugin-import was updated from 2.14.0 to 2.15.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-import is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

can you please guide how can use this with php?

The devDependency eslint-config-standard was updated from 14.0.1 to 14.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-config-standard is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

I make custom blocks for Wordpress themes/plugins and I would like to also translate the fields like title and description in the block.json file. It has textdomain support, see: https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/

The default make-pot command already supports it as far as I know (https://developer.wordpress.org/cli/commands/i18n/make-pot/).

Example block.json:

{
  "name": "my-plugin/button",
  "title": "Button",
  "description": "A custom button block.",
  "category": "my-plugin-blocks",
  "icon": "block-default",
  "keywords": ["my-plugin", "button"],
  "textdomain": "my-plugin",
  "acf": {
    "mode": "preview",
    "renderTemplate": "block.php"
  }
}

Is your feature request related to a problem? Please describe.
I'm getting template names as translatable strings in the pot file, wich I think is unneeded (what's the case for this)?
Describe the solution you'd like
I'd like to not include these strings in the POT file because it is confusing for translators.

esc_html_e - OK
\esc_html_e - ignored

after a few hours of testing I found an issue.

if translatable file is placed within php's exit function, it will never be translated.

ex:

$a = exit( __( 'Test 1', 'my-theme' ) );
$b = __( 'Test 2', 'my-theme' );

Result.

Copyright (C) 2017 Project

This file is distributed under the same license as the Project package.

msgid ""
msgstr ""
"Project-Id-Version: Project\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Poedit-Basepath: ..\n"
"X-Poedit-KeywordsList: __;_e;_ex:1,2c;_n:1,2;n_noop:1,2;nx:1,2,4c;nx_noop:1,2,3c;x:1,2c;esc_attr;esc_attr_e;esc_attr_x:1,2c;esc_html;esc_html_e;esc_html_x:1,2c\n"
"X-Poedit-SearchPath-0: .\n"
"X-Poedit-SearchPathExcluded-0: *.js\n"
"X-Poedit-SourceCharset: UTF-8\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#: project/functions.php:5
msgid "Test 2"
msgstr ""

Describe the bug
I noticed recently, in wp-pot 1.9.2, that translatable strings inside ternary statements don't get picked up for internationalization.

To Reproduce
In the following statement, I'd expect 'yolo' to appear in the .pot file. It does not.

echo ( $bool_flag ) ? esc_html__( 'yolo', 'my-textdomain' ) : '';

Module versions
Include output of npm ls wp-pot php-parser so I know what versions you are using

than@muspellheim:~/workspace $ npm ls wp-pot php-parser
[email protected] /home/than/workspace
└─┬ [email protected]
  └─┬ [email protected] 
    └── [email protected] 

Additional context
Rewriting these ternaries as if {} statements works to get them picked up for internationalization.

Thanks for your work maintaining this library!

Describe the bug
I am using this boilerplate for plugin development https://github.com/wp-strap/wordpress-plugin-boilerplate.

package.json has this script:

"translate": "wp-pot --src '**/**/**/*.php' --dest-file 'languages/test-plugin.pot' --package 'test-plugin' --domain 'test-plugin' --last-translator 'Test Plugin <[email protected]>' --team 'Test Plugin <[email protected]>' --bug-report 'testplugin.com'"

When i run yarn translate i get the following error:

yarn run v1.22.19
$ wp-pot --src '**/**/**/*.php' --dest-file 'languages/test-plugin.pot' --package 'test-plugin' --domain 'test-plugin' --last-translator 'Test Plugin <[email protected]>' --team 'Test Plugin <[email protected]>' --bug-report 'testplugin.com'
The system cannot find the file specified.
error Command failed with exit code 1.

To Reproduce
run yarn translate (wp-pot)

This will throw the following error:
The system cannot find the file specified.
error Command failed with exit code 1.

Module versions
└─┬ [email protected]
└─┬ [email protected]
└── [email protected]

Additional context
What can cause this issue, can't find anything related to it.

Describe the bug
Hi, I've noticed recently (I think version 1.9.0) that some of the places I used the __() functions are getting ignored.

To Reproduce
The following place in the following PR is suddenly getting ignored: https://github.com/skaut/crdm-modern/pull/135/files#diff-59dcbaa970c2ffbf709b8a620272ee44R84

Module versions

$ npm ls wp-pot php-parser
[email protected] /home/user/crdm-modern
└─┬ [email protected]
  └─┬ [email protected]
    └── [email protected]

Additional context
If you want to fully replicate the issue, clone https://github.com/skaut/crdm-modern/tree/preset-sync, checkout commit fda80d7 and run npm run update-translations. You should see 3 places where the POT file is suddenly missing the translation, even though they are still there, jut moved a bit...

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch [email protected] for the project I'm working on.

I realized that the package goes only one level deep when trying to figure out a prototype call.

So if I have something like

gettextFunctions: [
    {name: '$this->_fs->get_text_inline'},
    {name: '$this->_fs->get_text_x_inline', context: 2},
]

It fails to extract. However the following works:

gettextFunctions: [
    {name: '$fs->get_text_inline'},
    {name: '$fs->get_text_x_inline', context: 2},
]

Here is the diff that solved my problem:

diff --git a/node_modules/wp-pot/src/parsers/php-parser.js b/node_modules/wp-pot/src/parsers/php-parser.js
index c8f411d..319a5da 100644
--- a/node_modules/wp-pot/src/parsers/php-parser.js
+++ b/node_modules/wp-pot/src/parsers/php-parser.js
@@ -220,6 +220,32 @@ class PHPParser {
     return comment;
   }
 
+  /**
+   * Get method name from property lookup, going as deep as necessary.
+   * Example: $this->plugin->text_domain->translate
+   *
+   * @param {object} what
+   * @return {string}
+   * @private
+   */
+  _getMethodNameFromPropertyLookup(what) {
+    let methodName = [];
+
+    while(what) {
+      if (what.kind === 'propertylookup') {
+        methodName.push(what.offset.name);
+        what = what.what;
+      } else if (what.kind === 'variable') {
+        methodName.push(what.name);
+        what = null;
+      } else {
+        what = null;
+      }
+    }
+
+    return `\$${methodName.reverse().join('->')}`;
+  }
+
   /**
    * Check if ast is a valid function call
    *
@@ -231,8 +257,8 @@ class PHPParser {
     if (ast.kind === 'call') {
       let methodName = ast.what.name;
 
-      if (ast.what.kind === 'propertylookup' && ast.what.what.kind === 'variable') {
-        methodName = ['$', ast.what.what.name, '->', ast.what.offset.name].join('');
+      if (ast.what.kind === 'propertylookup') {
+        methodName = this._getMethodNameFromPropertyLookup(ast.what);
       } else if (ast.what.kind === 'name' && ast.what.resolution === 'fqn') {
         methodName = ast.what.name.replace(/^\\/, '');
       }

This will keep on looking down the prototype until it has found the variable and then create the method name.

If you're interested in this kind of solution, please let me know. I will create a PR, with tests. Thank you.

This issue body was partially generated by patch-package.

Hi,

If I am trying to run wp-pot I am retrieving the following error:
SyntaxError: Parse Error : syntax error, unexpected 'endif' (T_ENDIF) on line 72 | Unable to parse comments.php

The comments.php file looks as follow: http://pastebin.com/gisRzWdz

Am I doing something wrong?

The devDependency eslint was updated from 5.15.3 to 5.16.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

This issue provides visibility into Renovate updates and their statuses. Learn more

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency minimist to 1.2.6 [SECURITY]

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update Node.js to v16

• Check this box to trigger a request for Renovate to run again on this repository

Currently certain portions of the header for the generated .pot file are fairly inflexible. Specifically, these items:

https://github.com/rasmusbe/wp-pot/blob/6a15bd29fc8840a60f29ad11921b8a85544a3253/pot-maker.js#L140

https://github.com/rasmusbe/wp-pot/blob/6a15bd29fc8840a60f29ad11921b8a85544a3253/pot-maker.js#L144

For the Copyright line, it would be nice to have the ability to specify a different value than the package name, since the copyright is often for a person or company rather than a project.

For the Project-Id-Version line, there's currently no way to include the version.

Is your feature request related to a problem? Please describe.
I'm working on a WordPress project that sometime calls the translation functions (like __) passing a variable (or an object's property) as the translatable string, like this:

__( $object->name, 'domain' );

When generating the .pot file (using the gulp wrapper), this PHP code is defined as the translatable string value:

msgid "$object->name"
msgstr ""

Describe the solution you'd like
I'd like some kind of way to tell the POT generator to simply discard those calls to the translation functions.
Maybe using some kind of option parameter, or maybe this should be the default behavior (I don't see a use case where having PHP variables in a .pot file would be useful)

Additional context
I tried (rather quickly, I confess) looking at the source code to see where one would need to update the code to implement this, but couldn't find exactly where the matching would be done.

This is similar to #11, but there are a few cases where the translator strings are still missed. Here are a few examples:

Works as expected

/* translators: sprintf test translation */
sprintf( __( 'sprintf translation', 'example-domain' ) );

produces

#. translators: sprintf test translation
#: path/to/file.php:113
msgid "sprintf translation"
msgstr ""

Broken

Case 1

This seems to be an issue when inside an array.

$t = [
	/* translators: sprintf test translation in array */
	sprintf( __( 'sprintf translation in array', 'example-domain' ) ),
];

produces

#: path/to/file.php:117
msgid "sprintf translation in array"
msgstr ""

Case 2

A slightly different example of an issue inside an array.

$t = [
	/* translators: test translation in keyed array */
	'foo' => __( 'translation in keyed array', 'example-domain' ),
];

produces

#: path/to/file.php:120
msgid "translation in keyed array"
msgstr ""

Case 3

this is an issue when inside of a function call.

$message = sprintf(
	/* translators: example inside sprintf */
	__( 'Example inside sprintf', 'example-domain' )
);

produces

#: path/to/file.php:108
msgid "Example inside sprintf"
msgstr ""

The devDependency mocha was updated from 6.2.0 to 6.2.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

mocha is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Describe the bug
If a PHP file has an error in it, wp-pot causes my entire script to stop. Ideally if a PHP error exists, wp-pot should gracefully fail, rather than completely lock up the remaining scripts.

To Reproduce
Introduce any error in to a PHP file, such as a missing semicolon.

Module versions

└─┬ [email protected]
  └─┬ [email protected]
    └── [email protected]

I am currently running wp-pot in a watch build task, and php-edits are causing noise in the pot files due to line numbers changing. Would you be open to adding an option to surpress generation of the comments? If so I could create a pull request.

Is there a way to sync existing *.po files with the *.pot?

For example, there're new stings in theme files, we generate the new *.pot file with wp-pot, but the existing translation files de_DE.po will not contain the new strings.

Thanks!

Describe the bug
When a __ function call is inside of a match statement, the translatable text is not added to the .pot file.

To Reproduce
Add a match statement with a __ function call. Run wp-pot. Confirm that the text is not added to the .pot file.

Module versions
└─┬ [email protected]
└── [email protected]

Additional context
Example of text that doesn't get added to the .pot file:

return match ($product_type) {
	'text' => __( 'Text', 'namspace' )
};

Example of text that does get added to the .pot file:

$types = [
	'text' => __( 'Text', 'namspace' ),
];
return $types[ $product_type ] ?? null;

The devDependency eslint was updated from 5.12.1 to 5.13.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency eslint was updated from 5.12.0 to 5.12.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Describe the bug
wpPot is generating invalid (Content-Transfer-Econdig) and duplicated headers for the POT file.

To Reproduce
Simply execute the Gulp task to generate a POT file using gulp-wp-pot package.

Module versions
[email protected]
[email protected]
[email protected]

Additional context
The typo for the headers can be found at,

Is your feature request related to a problem? Please describe.

• Localization for strings on js files.

Describe the solution you'd like

• extract strings from js files (wp i18n make-pot)
• extract translations from .po files based on js source path (wp i18n make-json)

Additional context

• New! JavaScript i18n support in WordPress 5.0

I'm most probably overlooking something. If so my sincere apologies.

Is there a way to auto-populate the POT-Creation-Date and the PO-Revision-Date headers automatically? I'm using the gulp wrapper and these headers do not get populated by default.

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

The dependency php-parser was updated from 3.0.0-prerelease.9 to 3.0.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

php-parser is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

See wp-pot/gulp-wp-pot#40

Hello!

My task with wp-pot was broken after update to gulp 4.0.

[16:40:13] The following tasks did not complete: build-translate
[16:40:13] Did you forget to signal async completion?

I use this command for test "gulp build-translate"

Is your feature request related to a problem? Please describe.

If I have vendor folder in my theme, running with config

const wpPot = require('wp-pot');

wpPot({
  destFile: 'src/languages/my-theme.pot',
  domain: 'theme-domain',
  package: 'Theme Name',
  src: ['**/*.php'],
});

the files inside the vendor folder will get picked up, and throw an error (because the packages there don't use translation system like WordPress is).

Describe the solution you'd like

It would be great if there was an option

wpPot({
  src: ['**/*.php'],
  exclude: ['vendor/*.php'],
});

That would exclude this folder from .potfile generation.

Hi there,

I found another issue. Texts within "catch" are not generated in .POT file. Please see example:
try{ $a = esc_html__("Text Within Try", "test"); } catch ( Exception $e) { $b = esc_html__("Text Within Catch", "test"); }

And the result of this is:

`# Copyright (C) 2017 Test

This file is distributed under the same license as the test package.

msgid ""
msgstr ""
"Project-Id-Version: test\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Poedit-Basepath: ..\n"
"X-Poedit-KeywordsList: __;_e;_ex:1,2c;_n:1,2;n_noop:1,2;nx:1,2,4c;nx_noop:1,2,3c;x:1,2c;esc_attr;esc_attr_e;esc_attr_x:1,2c;esc_html;esc_html_e;esc_html_x:1,2c\n"
"X-Poedit-SearchPath-0: .\n"
"X-Poedit-SearchPathExcluded-0: *.js\n"
"X-Poedit-SourceCharset: UTF-8\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

#: test-file.php:307
msgid "Text Within Try"
msgstr ""`

Thanks.

The devDependency eslint was updated from 6.4.0 to 6.5.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

same setup worked before and I cannot find any reason why these strings and not others.

Node v8.0.0
NPM v5.0.2
wp-pot v1.3.2
gulp-wp-pot v2.0.5

As Timber uses .twig templates for views where gettext functions would be found, and this project uses a PHP parser, it's not currently possible to extract strings when using Timber.

Describe the solution you'd like
It would be nice to have 2 new related (optional) features:

• line wrapping, using an option to set the max length (GNU Gettext uses 79 characters including quotes)
• reference comments on separate lines instead of comma-seperated on one line (see also the woocommerce.pot file for example)

The first option might auto-enable the second one for clarity in the resulting POT file.

Is your feature request related to a problem? Please describe.
We often have po files for different locales. Updating all of them manually when the strings are added/updated is tedious.

Describe the solution you'd like
There should be an option to update the po files as well when generating the pot file. For example grunt-wp-i18n has the option updatePoFiles.

Describe the bug
Hi, I'm developing a GitHub action based on your library.
But I'm receiving a parse error in the following line:

<?php
$custom = new self::$allowed_providers[ $source ]['class']();

Error: Parse Error : syntax error, unexpected '[', expecting ';' on line 131 | Unable to parse ../widgets/proxio-sso-app-widget.php

Module versions

18:17 $ npm ls wp-pot php-parser
[email protected] /Users/breno-proxio/action-wp-pot
└─┬ [email protected] 
  └── [email protected]

Version 10.2.0 of eslint-config-standard just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As eslint-config-standard is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

I've been noticing a lot of instances of #. undefined preceding translations on the generated .pot file and was able to track this down to what seems to be an issue with comment parsing.

I traced this to:

https://github.com/rasmusbe/wp-pot/blob/master/pot-maker.js#L93

If I wrap line 93 in a simple if statement to check comment for a truthy like:

if (comment) {
  output.push(`#. ${comment}`);
}

I don't get these on the pot file.

I tried to figure out a deeper source but I must confess I'm not well-versed enough to understand exactly what is happening prior to this function with the comment and translation parsing.

I considered opening a PR with this above added but I feel like this is a bandaid patch as opposed to an actual solution or possibly I'm doing something wrong that's causing this to happen.

Thanks,

TypeError: ast.children[Symbol.iterator] is not a function
    at parseCodeTree (...\node_modules\wp-pot\index.js:271:28)
    at parseCodeTree (...\node_modules\wp-pot\index.js:272:7)
    at parseFile (...\node_modules\wp-pot\index.js:300:3)
    at wpPot (...\node_modules\wp-pot\index.js:479:5)
    at DestroyableTransform._flush (...\node_modules\gulp-wp-pot\index.js:51:25)
    at DestroyableTransform.<anonymous> (...\node_modules\readable-stream\lib\_stream_transform.js:115:49)
    at DestroyableTransform.g (events.js:292:16)
    at emitNone (events.js:86:13)
    at DestroyableTransform.emit (events.js:185:7)
    at prefinish (...\node_modules\readable-stream\lib\_stream_writable.js:503:12)
    at finishMaybe (...\node_modules\readable-stream\lib\_stream_writable.js:511:7)

• I'm using gulp-wp-pot but seems to me it's wp-pot problem.
• also on another wp plugin, this update works fine.
• guess it's about parsing wp noop functions.

Version 7.0.1 of eslint-plugin-node was just published.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Always disturbs when your POT file includes strings that do not belong to your domain.

__('My text', 'my-domain') -- include
__('Something', 'woocommerce') -- not mine, ignore.
__('Save') -- not textdomain, ignore (a standard WP message?)

Version 2.4.0 of eslint-plugin-import just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As eslint-plugin-import is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴