Reedy has submitted this change and it was merged.
Change subject: Utility script for trimming i18n files.
......................................................................
Utility script for trimming i18n files.
This allows messages keys that have been removed from
a master file (typically en.json) manually to be
automatically removed from the other i18n files.
The most common use case for removing message keys is
splitting components: moving functionality from core
into an extension, or from an extension into a library,
etc.
Change-Id: I5b81a29880fcc94ebc9b6f2eb9f86325a50bf8ae
---
A trim-i18n.php
1 file changed, 134 insertions(+), 0 deletions(-)
Approvals:
Reedy: Verified; Looks good to me, approved
Legoktm: Looks good to me, approved
Nikerabbit: Looks good to me, approved
Thiemo Mättig (WMDE): Looks good to me, but someone else must approve
diff --git a/trim-i18n.php b/trim-i18n.php
new file mode 100644
index 0000000..c275d9e
--- /dev/null
+++ b/trim-i18n.php
@@ -0,0 +1,134 @@
+<?php
+
+if ( PHP_SAPI !== 'cli' ) {
+ die( 'This is a command line script, it cannot be run in ' . PHP_SAPI .
" mode\n" );
+}
+
+if ( count( $argv ) < 3 ) {
+ print( "USAGE: $argv[0] <base> <target>\n" );
+ print( "SYNOPSIS: Given <base> and <target> are JSON files, this will
remove any keys from <target>\n" );
+ print( " which are not in <base>.\n" );
+ die();
+}
+
+class TrimI18n {
+
+ /**
+ * @var int A combination of JSON_... constants.
+ */
+ private $jsonFlags = 0;
+
+ /**
+ * @var string
+ */
+ private $tab = "\t";
+
+ /**
+ * @param int $jsonFlags A combination of JSON_... constants.
+ */
+ public function setJsonFlags( $jsonFlags ) {
+ $this->jsonFlags = $jsonFlags;
+ }
+
+ /**
+ * @return int A combination of JSON_... constants.
+ */
+ public function getJsonFlags() {
+ return $this->jsonFlags;
+ }
+
+ /**
+ * @param string $path
+ *
+ * @throws RuntimeException
+ * @return array
+ */
+ private function load( $path ) {
+ $json = file_get_contents( $path );
+
+ if ( $json === false ) {
+ throw new RuntimeException( "Can't load JSON data from
$path." );
+ }
+
+ $data = json_decode( $json, true );
+
+ if ( !is_array( $data ) ) {
+ throw new RuntimeException( "Can't decode JSON data
found in $path." );
+ }
+
+ return $data;
+ }
+
+ /**
+ * @param string $json
+ *
+ * @return string
+ */
+ private function prettify( $json ) {
+ if ( ( $this->jsonFlags & JSON_PRETTY_PRINT ) === 0 ) {
+ return $json;
+ }
+
+ //NOTE: json_encode uses four spaces for indenting in
pretty-print mode.
+
+ if ( $this->tab === ' ' ) {
+ return $json;
+ }
+
+ $tab = $this->tab;
+ return preg_replace_callback( '/^(?: )+/m', function(
$matches ) use ( $tab ) {
+ return str_repeat( $tab, strlen( $matches[0] ) / 4 );
+ }, $json );
+ }
+
+ /**
+ * @param string $path
+ * @param array $data
+ *
+ * @throws RuntimeException
+ */
+ private function save( $path, array $data ) {
+ $json = json_encode( $data, $this->jsonFlags );
+
+ if ( $json === false ) {
+ throw new RuntimeException( 'Can\'t encode data as
JSON!' );
+ }
+
+ $json = $this->prettify( $json );
+
+ $ok = file_put_contents( $path, $json );
+
+ if ( $ok === false ) {
+ throw new RuntimeException( "Failed to save JSON data
to $path!" );
+ }
+ }
+
+ /**
+ * @param string $basePath
+ * @param string $targetPath
+ */
+ public function run( $basePath, $targetPath ) {
+ $baseData = $this->load( $basePath );
+ $targetData = $this->load( $targetPath );
+
+ $targetData = array_intersect_key( $targetData, $baseData );
+ $this->save( $targetPath, $targetData );
+ }
+
+}
+
+$basePath = $argv[1];
+$targetPath = $argv[2];
+
+try {
+ $trim = new TrimI18n();
+
+ // Flags are set for consistency with the flags used by
EncodeJson::encode54()
+ $trim->setJsonFlags( JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE |
JSON_UNESCAPED_SLASHES );
+
+ $trim->run( $basePath, $targetPath );
+
+ print "Updated $targetPath, retaining all keys found in $basePath.\n";
+} catch ( RuntimeException $ex ) {
+ die( $ex->getMessage() . "\n" );
+}
--
To view, visit https://gerrit.wikimedia.org/r/190825
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I5b81a29880fcc94ebc9b6f2eb9f86325a50bf8ae
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/tools/code-utils
Gerrit-Branch: master
Gerrit-Owner: Daniel Kinzler <[email protected]>
Gerrit-Reviewer: Aklapper <[email protected]>
Gerrit-Reviewer: Daniel Kinzler <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: Nemo bis <[email protected]>
Gerrit-Reviewer: Nikerabbit <[email protected]>
Gerrit-Reviewer: Reedy <[email protected]>
Gerrit-Reviewer: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
