e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
86 lines
2.5 KiB
PHP
86 lines
2.5 KiB
PHP
<?php
|
|
|
|
use MediaWiki\Json\FormatJson;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Convert existing ExtensionMessagesFiles to JSON files in different language codes that can be used as
|
|
* input for TranslationAliasesDirs configuration.
|
|
*
|
|
* @since 1.42
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
class ConvertExtensionsMessagesToTranslationAlias extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Convert ExtensionMessagesFiles to JSON files in different language codes.' );
|
|
|
|
$this->addArg( 'destination', 'Destination folder where the JSON files should be created' );
|
|
$this->addArg(
|
|
'files', 'ExtensionMessageFiles to be converted', true, true
|
|
);
|
|
}
|
|
|
|
public function execute() {
|
|
$errors = [];
|
|
$destinationFolder = $this->getArg( 0 );
|
|
if ( !is_dir( $destinationFolder ) || !is_writable( $destinationFolder ) ) {
|
|
$errors[] = "The path: $destinationFolder does not exist, is not a folder or is not writable.";
|
|
}
|
|
|
|
$messageFiles = $this->getArgs( 1 );
|
|
foreach ( $messageFiles as $file ) {
|
|
if ( !file_exists( $file ) ) {
|
|
$errors[] = "The message file: $file does not exist";
|
|
}
|
|
}
|
|
|
|
if ( $errors ) {
|
|
$this->fatalError( implode( "\n* ", $errors ) );
|
|
}
|
|
|
|
$data = [];
|
|
|
|
foreach ( $messageFiles as $file ) {
|
|
include $file;
|
|
|
|
foreach ( LocalisationCache::ALL_ALIAS_KEYS as $key ) {
|
|
// Can be removed once LocalisationCache::ALL_ALIAS_KEYS has multiple entries
|
|
// @phan-suppress-next-line PhanImpossibleConditionInLoop False positive
|
|
if ( isset( $$key ) ) {
|
|
// Can be removed once LocalisationCache::ALL_ALIAS_KEYS has multiple entries
|
|
// @phan-suppress-next-line PhanUndeclaredVariable Possibly declared in $file
|
|
$data[$key] = $$key;
|
|
}
|
|
}
|
|
}
|
|
|
|
$json = [];
|
|
foreach ( $data as $key => $item ) {
|
|
$normalizedKey = ucfirst( $key );
|
|
// @phan-suppress-next-line PhanTypeMismatchForeach False positive
|
|
foreach ( $item as $languageCode => $itemData ) {
|
|
$json[$languageCode][$normalizedKey] = $itemData;
|
|
}
|
|
}
|
|
|
|
foreach ( $json as $languageCode => $data ) {
|
|
$filePath = $destinationFolder . '/' . $languageCode . ".json";
|
|
file_put_contents(
|
|
$filePath,
|
|
FormatJson::encode( $data, "\t", FormatJson::UTF8_OK ) . "\n"
|
|
);
|
|
}
|
|
|
|
$this->output( "Done!\n" );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = ConvertExtensionsMessagesToTranslationAlias::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|