mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-01-20 03:07:56 -05:00
4b29e666b0
* Adds logic for validation * Adds validation to do-install * Adds help to do-install * Adds validation & help to reconfigure * Adds validation to check.translation * Adds validation to manipulate.translation * Small fixes to help texts * Refactors language option validation * Adds default options to validation * Fixes validation with regex * Refactors readAs functions * Updates to new regex validation format * Fixes typing around default values * Adds file extension validation * Restandardises validation & parsing typing around array of strings * Adds NotOneOf validation * Adds ArrayOfString read as * Refactors existing validation * Adds validation throughout cli * Removes unused file * Adds new CL parser with goal of wrapping CLI behaviour * Hides parsing and validation * Rewites CL parser to make better use of classes * Rolls out new parser across CL * Fixes error during unknown option check * Fixes misnamed property calls * Seperates validations into more appropriate locations * Adds common boolean forms to validation * Moves CommandLineParser and Option classes into their own files * Fixes error when validating Int type * Rewrites appendTypedValues -> appendTypedValidValues now filters invalid values from output * Renames -> for clarity * Adds some docs clarifying option defaults and value taking behaviour * Refactors getUsageMessage for readability * Minor formatting changes * Adds tests for CommandLineParser * Adds more tests * Adds minor fixs * Reconfigure now correctly updates config * More fixes to reconfigure * Fixes required files for CommandLineParserTest * Use .php extension for PHP file * PHPStan ignore instead of wrong typing * Refactors to support php 7.4 * Moves away from dynamic properties by adding 'Definintions' to all commands * Renames target to definition for clarity * Stops null from being returned as a valid value in a certain edge case * Adds PHPStan ignore instead of incorrect typing * Refactors tests to take account of new typing solution * Marks file as executable * Draft CLI rework * Finish rewrite as object-oriented * Fix PHPStan ignore and make more strongly typed * Rename class Option to CliOption * Light renaming + anonymous classes --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
128 lines
3.4 KiB
PHP
Executable File
128 lines
3.4 KiB
PHP
Executable File
#!/usr/bin/env php
|
|
<?php
|
|
declare(strict_types=1);
|
|
require_once __DIR__ . '/_cli.php';
|
|
require_once __DIR__ . '/i18n/I18nCompletionValidator.php';
|
|
require_once __DIR__ . '/i18n/I18nData.php';
|
|
require_once __DIR__ . '/i18n/I18nFile.php';
|
|
require_once __DIR__ . '/i18n/I18nUsageValidator.php';
|
|
require_once __DIR__ . '/../constants.php';
|
|
|
|
$cliOptions = new class extends CliOptionsParser {
|
|
/** @var array<int,string> $language */
|
|
public array $language;
|
|
public string $displayResult;
|
|
public string $help;
|
|
public string $displayReport;
|
|
|
|
public function __construct() {
|
|
$this->addOption('language', (new CliOption('language', 'l'))->typeOfArrayOfString());
|
|
$this->addOption('displayResult', (new CliOption('display-result', 'd'))->withValueNone());
|
|
$this->addOption('help', (new CliOption('help', 'h'))->withValueNone());
|
|
$this->addOption('displayReport', (new CliOption('display-report', 'r'))->withValueNone());
|
|
parent::__construct();
|
|
}
|
|
};
|
|
|
|
if (!empty($cliOptions->errors)) {
|
|
fail('FreshRSS error: ' . array_shift($cliOptions->errors) . "\n" . $cliOptions->usage);
|
|
}
|
|
if (isset($cliOptions->help)) {
|
|
checkHelp();
|
|
}
|
|
|
|
$i18nFile = new I18nFile();
|
|
$i18nData = new I18nData($i18nFile->load());
|
|
|
|
if (isset($cliOptions->language)) {
|
|
$languages = $cliOptions->language;
|
|
} else {
|
|
$languages = $i18nData->getAvailableLanguages();
|
|
}
|
|
$displayResults = isset($cliOptions->displayResult);
|
|
$displayReport = isset($cliOptions->displayReport);
|
|
|
|
$isValidated = true;
|
|
$result = [];
|
|
$report = [];
|
|
|
|
foreach ($languages as $language) {
|
|
if ($language === $i18nData::REFERENCE_LANGUAGE) {
|
|
$i18nValidator = new I18nUsageValidator($i18nData->getReferenceLanguage(), findUsedTranslations());
|
|
} else {
|
|
$i18nValidator = new I18nCompletionValidator($i18nData->getReferenceLanguage(), $i18nData->getLanguage($language));
|
|
}
|
|
$isValidated = $i18nValidator->validate() && $isValidated;
|
|
|
|
$report[$language] = sprintf('%-5s - %s', $language, $i18nValidator->displayReport());
|
|
$result[$language] = $i18nValidator->displayResult();
|
|
}
|
|
|
|
if ($displayResults) {
|
|
foreach ($result as $lang => $value) {
|
|
echo 'Language: ', $lang, PHP_EOL;
|
|
print_r($value);
|
|
echo PHP_EOL;
|
|
}
|
|
}
|
|
|
|
if ($displayReport) {
|
|
foreach ($report as $value) {
|
|
echo $value;
|
|
}
|
|
}
|
|
|
|
if (!$isValidated) {
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* Find used translation keys in the project
|
|
*
|
|
* Iterates through all php and phtml files in the whole project and extracts all
|
|
* translation keys used.
|
|
*
|
|
* @return array<string>
|
|
*/
|
|
function findUsedTranslations(): array {
|
|
$directory = new RecursiveDirectoryIterator(__DIR__ . '/..');
|
|
$iterator = new RecursiveIteratorIterator($directory);
|
|
$regex = new RegexIterator($iterator, '/^.+\.(php|phtml)$/i', RecursiveRegexIterator::GET_MATCH);
|
|
$usedI18n = [];
|
|
foreach (array_keys(iterator_to_array($regex)) as $file) {
|
|
$fileContent = file_get_contents($file);
|
|
if ($fileContent === false) {
|
|
continue;
|
|
}
|
|
preg_match_all('/_t\([\'"](?P<strings>[^\'"]+)[\'"]/', $fileContent, $matches);
|
|
$usedI18n = array_merge($usedI18n, $matches['strings']);
|
|
}
|
|
return $usedI18n;
|
|
}
|
|
|
|
/**
|
|
* Output help message.
|
|
* @return never
|
|
*/
|
|
function checkHelp() {
|
|
$file = str_replace(__DIR__ . '/', '', __FILE__);
|
|
|
|
echo <<<HELP
|
|
NAME
|
|
$file
|
|
|
|
SYNOPSIS
|
|
php $file [OPTION]...
|
|
|
|
DESCRIPTION
|
|
Check if translation files have missing keys or missing translations.
|
|
|
|
-d, --display-result display results.
|
|
-h, --help display this help and exit.
|
|
-l, --language=LANG filter by LANG.
|
|
-r, --display-report display completion report.
|
|
|
|
HELP;
|
|
exit();
|
|
}
|