Merge pull request #428 from wp-cli/fix/427-format-flag

swissspidy · web-flow · commit 32744a45231d · 2025-02-28T09:10:18.000+01:00
Add php-format and js-format flags
diff --git a/features/makepot.feature b/features/makepot.feature
@@ -2608,6 +2608,7 @@ Feature: Generate a POT file of a WordPress project
       """
       #. translators: %s: test
       #: foo-plugin.js:1
+      #, js-format
       msgid "Hi %s"
       msgstr ""
       """
@@ -4097,3 +4098,60 @@ Feature: Generate a POT file of a WordPress project
       """
       msgid "Not extracted style variation description"
       """
+
+  Scenario: Add php-format and js-format flags for printf usage
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin.php file:
+      """
+      <?php
+      /**
+       * Plugin Name: Foo Plugin
+       * Plugin URI:  https://example.com
+       * Description:
+       * Version:     0.1.0
+       * Author:
+       * Author URI:
+       * License:     GPL-2.0+
+       * License URI: https://www.gnu.org/licenses/gpl-2.0.txt
+       * Text Domain: foo-plugin
+       * Domain Path: /languages
+       */
+
+       /* translators: %s: Name */
+       __( 'Hello %s', 'foo-plugin' );
+       /* translators: 1: Name */
+       __( 'Bonjour %1$s', 'foo-plugin' );
+      """
+    And a foo-plugin/foo.js file:
+      """
+      /* translators: %s: Name */
+      __( 'Hallo %s', 'foo-plugin' );
+      /* translators: 1: Name */
+      __( 'Buongiorno %1$s', 'foo-plugin' );
+      """
+
+    When I run `wp i18n make-pot foo-plugin foo-plugin.pot`
+    Then the foo-plugin.pot file should contain:
+      """
+      #: foo-plugin.php:16
+      #, php-format
+      msgid "Hello %s"
+      """
+    And the foo-plugin.pot file should contain:
+      """
+      #: foo-plugin.php:18
+      #, php-format
+      msgid "Bonjour %1$s"
+      """
+    And the foo-plugin.pot file should contain:
+      """
+      #: foo.js:2
+      #, js-format
+      msgid "Hallo %s"
+      """
+    And the foo-plugin.pot file should contain:
+      """
+      #: foo.js:4
+      #, js-format
+      msgid "Buongiorno %1$s"
+      """
diff --git a/src/JsFunctionsScanner.php b/src/JsFunctionsScanner.php
@@ -176,10 +176,18 @@ function ( $node ) use ( &$translations, $options, &$all_comments ) {
 				}
 
 				$translation = $translations->insert( $context, $original, $plural );
+
 				if ( $add_reference ) {
 					$translation->addReference( $file, $line );
 				}
 
+				if (
+					1 === preg_match( MakePotCommand::SPRINTF_PLACEHOLDER_REGEX, $original ) ||
+					1 === preg_match( MakePotCommand::UNORDERED_SPRINTF_PLACEHOLDER_REGEX, $original )
+				) {
+					$translation->addFlag( 'js-format' );
+				}
+
 				/** @var Node\Comment $comment */
 				foreach ( $all_comments as $comment ) {
 					// Comments should be before the translation.
diff --git a/src/PhpFunctionsScanner.php b/src/PhpFunctionsScanner.php
@@ -72,10 +72,18 @@ public function saveGettextFunctions( $translations, array $options ) {
 			}
 
 			$translation = $translations->insert( $context, $original, $plural );
+
 			if ( $add_reference ) {
 				$translation = $translation->addReference( $file, $line );
 			}
 
+			if (
+				1 === preg_match( MakePotCommand::SPRINTF_PLACEHOLDER_REGEX, $original ) ||
+				1 === preg_match( MakePotCommand::UNORDERED_SPRINTF_PLACEHOLDER_REGEX, $original )
+			) {
+				$translation->addFlag( 'php-format' );
+			}
+
 			if ( isset( $function[3] ) ) {
 				foreach ( $function[3] as $extracted_comment ) {
 					$translation = $translation->addExtractedComment( $extracted_comment );
