Merge pull request #458 from wp-cli/copilot/add-pretty-print-arg

Author: swissspidy

features/makephp.feature

@@ -259,3 +259,44 @@ Feature: Generate PHP files from PO files
       """
       new message
       """
+
+  Scenario: Should create pretty-printed PHP files
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin-de_DE.po file:
+      """
+      # Copyright (C) 2018 Foo Plugin
+      # This file is distributed under the same license as the Foo Plugin package.
+      msgid ""
+      msgstr ""
+      "Project-Id-Version: Foo Plugin\n"
+      "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/foo-plugin\n"
+      "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+      "Language-Team: LANGUAGE <[email protected]>\n"
+      "Language: de_DE\n"
+      "MIME-Version: 1.0\n"
+      "Content-Type: text/plain; charset=UTF-8\n"
+      "Content-Transfer-Encoding: 8bit\n"
+      "POT-Creation-Date: 2018-05-02T22:06:24+00:00\n"
+      "PO-Revision-Date: 2018-05-02T22:06:24+00:00\n"
+      "X-Domain: foo-plugin\n"
+      "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+      #: foo-plugin.php:15
+      msgid "Foo Plugin"
+      msgstr "Bar Plugin"
+      """
+
+    When I run `wp i18n make-php foo-plugin --pretty-print`
+    Then STDOUT should contain:
+      """
+      Success: Created 1 file.
+      """
+    And the return code should be 0
+    And the foo-plugin/foo-plugin-de_DE.l10n.php file should contain:
+      """
+      	'domain' => 'foo-plugin',
+      """
+    And the foo-plugin/foo-plugin-de_DE.l10n.php file should contain:
+      """
+      	'messages' => [
+      """

src/MakePhpCommand.php

@@ -22,6 +22,9 @@ class MakePhpCommand extends WP_CLI_Command {
 	 * [<destination>]
 	 * : Path to the destination directory for the resulting PHP files. Defaults to the source directory.
 	 *
+	 * [--pretty-print]
+	 * : Pretty-print resulting PHP files.
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     # Create PHP files for all PO files in the current directory.
@@ -32,6 +35,10 @@ class MakePhpCommand extends WP_CLI_Command {
 	 *     $ wp i18n make-php example-plugin-de_DE.po languages
 	 *     Success: Created 1 file.
 	 *
+	 *     # Create a pretty-printed PHP file.
+	 *     $ wp i18n make-php example-plugin-de_DE.po languages --pretty-print
+	 *     Success: Created 1 file.
+	 *
 	 * @when before_wp_load
 	 *
 	 * @throws WP_CLI\ExitException
@@ -57,6 +64,8 @@ public function __invoke( $args, $assoc_args ) {
 			$files = new IteratorIterator( new DirectoryIterator( $source ) );
 		}
 
+		$pretty_print = Utils\get_flag_value( $assoc_args, 'pretty-print', false );
+
 		$result_count = 0;
 		/** @var DirectoryIterator $file */
 		foreach ( $files as $file ) {
@@ -73,7 +82,8 @@ public function __invoke( $args, $assoc_args ) {
 			$destination_file = "{$destination}/{$file_basename}.l10n.php";
 
 			$translations = Translations::fromPoFile( $file->getPathname() );
-			if ( ! PhpArrayGenerator::toFile( $translations, $destination_file ) ) {
+			$options      = [ 'prettyPrint' => $pretty_print ];
+			if ( ! PhpArrayGenerator::toFile( $translations, $destination_file, $options ) ) {
 				WP_CLI::warning( sprintf( 'Could not create file %s', $destination_file ) );
 				continue;
 			}

src/PhpArrayGenerator.php

@@ -14,15 +14,17 @@
 class PhpArrayGenerator extends PhpArray {
 	public static $options = [
 		'includeHeaders' => false,
+		'prettyPrint'    => false,
 	];
 
 	/**
 	 * {@inheritdoc}
 	 */
 	public static function toString( Translations $translations, array $options = [] ) {
-		$array = static::generate( $translations, $options );
+		$options = array_merge( static::$options, $options );
+		$array   = static::generate( $translations, $options );
 
-		return '<?php' . PHP_EOL . 'return ' . static::var_export( $array ) . ';';
+		return '<?php' . PHP_EOL . 'return ' . static::var_export( $array, $options['prettyPrint'] ) . ';';
 	}
 
 	/**
@@ -146,22 +148,39 @@ private static function array_is_list( array $arr ) {
 	 *
 	 * @since 4.0.0
 	 *
-	 * @param mixed $value The variable you want to export.
+	 * @param mixed $value       The variable you want to export.
+	 * @param bool  $pretty_print Whether to pretty-print the output.
+	 * @param int   $indent_level Current indentation level (used for recursion).
 	 * @return string The variable representation.
 	 */
-	private static function var_export( $value ) {
+	private static function var_export( $value, $pretty_print = false, $indent_level = 0 ) {
 		if ( ! is_array( $value ) ) {
 			return var_export( $value, true );
 		}
 
 		$entries = array();
-
 		$is_list = self::array_is_list( $value );
 
-		foreach ( $value as $key => $val ) {
-			$entries[] = $is_list ? self::var_export( $val ) : var_export( $key, true ) . '=>' . self::var_export( $val );
-		}
+		if ( $pretty_print ) {
+			$indent         = str_repeat( "\t", $indent_level + 1 );
+			$closing_indent = str_repeat( "\t", $indent_level );
+			$separator      = ',' . PHP_EOL;
+
+			foreach ( $value as $key => $val ) {
+				if ( $is_list ) {
+					$entries[] = $indent . self::var_export( $val, $pretty_print, $indent_level + 1 );
+				} else {
+					$entries[] = $indent . var_export( $key, true ) . ' => ' . self::var_export( $val, $pretty_print, $indent_level + 1 );
+				}
+			}
 
-		return '[' . implode( ',', $entries ) . ']';
+			return '[' . PHP_EOL . implode( $separator, $entries ) . ',' . PHP_EOL . $closing_indent . ']';
+		} else {
+			foreach ( $value as $key => $val ) {
+				$entries[] = $is_list ? self::var_export( $val, $pretty_print, $indent_level ) : var_export( $key, true ) . '=>' . self::var_export( $val, $pretty_print, $indent_level );
+			}
+
+			return '[' . implode( ',', $entries ) . ']';
+		}
 	}
 }