feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 8 commits into from
Dec 8, 2023
Merged

feat: [Commands] lang:find show bad keys when scanning (v2) #8285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
33357b6
feat: Show bad lang keys when scanning
neznaika0 Nov 4, 2023
6610e32
test: Test bad lang keys when scanning
neznaika0 Nov 4, 2023
25a1573
fix: Show the keys and files where they are used
neznaika0 Dec 3, 2023
a166470
feat: Sort array values by natural order
neznaika0 Dec 3, 2023
e23c44c
test: Add duplicate data for example
neznaika0 Dec 3, 2023
fe3b430
test: Fix test for bad language keys
neznaika0 Dec 3, 2023
66d4f0e
test: Add for ArrayHelper::sortValuesByNatural
neznaika0 Dec 3, 2023
9747d12
docs: Add example output bad lang keys
neznaika0 Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 39 additions & 9 deletions system/Commands/Translation/LocalizationFinder.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
if (is_string($optionDir)) {
$tempCurrentDir = realpath($currentDir . $optionDir);

if (false === $tempCurrentDir) {
if ($tempCurrentDir === false) {
CLI::error('Error: Directory must be located in "' . $currentDir . '"');

return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
$files = iterator_to_array($iterator, true);
ksort($files);

[$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
[
'foundLanguageKeys' => $foundLanguageKeys,
'badLanguageKeys' => $badLanguageKeys,
'countFiles' => $countFiles
] = $this->findLanguageKeysInFiles($files);

ksort($foundLanguageKeys);

$languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
$newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

if ($languageDiff !== []) {
if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
$this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
} else {
$this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

$this->writeIsVerbose('Files found: ' . $countFiles);
$this->writeIsVerbose('New translates found: ' . $countNewKeys);
$this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

if ($this->verbose && $badLanguageKeys !== []) {
$tableBadRows = [];

foreach ($badLanguageKeys as $value) {
$tableBadRows[] = [$value[1], $value[0]];
}

ArrayHelper::sortValuesByNatural($tableBadRows, 0);

CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
}
}

/**
* @param SplFileInfo|string $file
*
* @return array<string, array>
*/
private function findTranslationsInFile($file): array
{
$foundLanguageKeys = [];
$badLanguageKeys = [];

if (is_string($file) && is_file($file)) {
$file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);

@neznaika0neznaika0Dec 7, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.


if ($matches[1] === []) {
return [];
return compact('foundLanguageKeys', 'badLanguageKeys');
}

foreach ($matches[1] as $phraseKey) {
$phraseKeys = explode('.', $phraseKey);

// Language key not have Filename or Lang key
if (count($phraseKeys) < 2) {
$badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

continue;
}

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
|| ($languageFileName === '' && $phraseKeys[0] === '');

if ($isEmptyNestedArray) {
$badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

continue;
}

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
}
}

return $foundLanguageKeys;
return compact('foundLanguageKeys', 'badLanguageKeys');
}

private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
/**
* @param SplFileInfo[] $files
*
* @return array<int, array|int>
* @phpstan-return list{0: array<string, array<string, string>>, 1: int}
* @return array<string, array|int>
* @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
*/
private function findLanguageKeysInFiles(array $files): array
{
$foundLanguageKeys = [];
$badLanguageKeys = [];
$countFiles = 0;

foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

$this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
$countFiles++;
$foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

$findInFile = $this->findTranslationsInFile($file);

$foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
$badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
}

return [$foundLanguageKeys, $countFiles];
return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
}
}
19 changes: 19 additions & 0 deletions system/Helpers/Array/ArrayHelper.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
* If there are any methods that should be provided, make them
* public APIs via helper functions.
*
* @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
* @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
* @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
*/
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

return $counter;
}

/**
* Sorts array values in natural order
* If the value is an array, you need to specify the $sortByIndex of the key to sort
*
* @param int|string|null $sortByIndex
*/
public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
{
return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
if ($sortByIndex !== null) {
return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
}

return strnatcmp($currentValue, $nextValue);
});
}
}
7 changes: 7 additions & 0 deletions tests/_support/Services/Translation/TranslationTwo.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
$translationError6 = lang('TranslationTwo...');
$translationError7 = lang('..invalid_nested_key..');

$copyTranslationError1 = lang('TranslationTwo');
$copyTranslationError2 = lang(' ');
$copyTranslationError3 = lang('');
$copyTranslationError4 = lang('.invalid_key');
$copyTranslationError5 = lang('TranslationTwo.');
$copyTranslationError6 = lang('TranslationTwo...');
$copyTranslationError7 = lang('..invalid_nested_key..');
// Empty in comments lang('') lang(' ')
}
}
29 changes: 29 additions & 0 deletions tests/system/Commands/Translation/LocalizationFinderTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
$this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
}

public function testShowBadTranslation(): void
{
$this->makeLocaleDirectory();

command('lang:find --dir Translation --verbose');

$this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
}

private function getActualTranslationOneKeys(): array
{
return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
TEXT_WRAP;
}

private function getActualTableWithBadKeys(): string
{
return <<<'TEXT_WRAP'
+------------------------+--------------------------------------------------------+
| Bad Key | Filepath |
+------------------------+--------------------------------------------------------+
| ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
| ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
| .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
| .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
| TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
+------------------------+--------------------------------------------------------+
TEXT_WRAP;
}

private function assertTranslationsExistAndHaveTranslatedKeys(): void
{
$this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down
121 changes: 121 additions & 0 deletions tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
* @group Others
*
* @internal
*/
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
private array $arrayWithStringValues = [
'apple10',
'banana',
'apple1',
'банан',
'Banana',
'Apple',
100000,
'яблоко',
1200,
13000,
'Банан',
'Яблоко',
'apple',
];
private array $arrayWithArrayValues = [
['apple', 'Banana'],
['apple10', 'Apple'],
['Яблоко', 1200],
[13000, 'Банан'],
['Apple', 'apple1'],
['banana', 'банан'],
[100000, 13000],
['Banana', 'Яблоко'],
['Банан', 'banana'],
[1200, 'apple'],
['apple1', 'apple10'],
['яблоко', 100000],
['банан', 'яблоко'],
];

public function testSortWithStringValues(): void
{
shuffle($this->arrayWithStringValues);

ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

$this->assertSame([
1200,
13000,
100000,
'Apple',
'Banana',
'apple',
'apple1',
'apple10',
'banana',
'Банан',
'Яблоко',
'банан',
'яблоко',
], $this->arrayWithStringValues);
}

public function testSortWithArrayValues(): void
{
shuffle($this->arrayWithArrayValues);

// For first index
ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

$this->assertSame([
[1200, 'apple'],
[13000, 'Банан'],
[100000, 13000],
['Apple', 'apple1'],
['Banana', 'Яблоко'],
['apple', 'Banana'],
['apple1', 'apple10'],
['apple10', 'Apple'],
['banana', 'банан'],
['Банан', 'banana'],
['Яблоко', 1200],
['банан', 'яблоко'],
['яблоко', 100000],
], $this->arrayWithArrayValues);

shuffle($this->arrayWithArrayValues);

// For other index
ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

$this->assertSame([
['Яблоко', 1200],
[100000, 13000],
['яблоко', 100000],
['apple10', 'Apple'],
['apple', 'Banana'],
[1200, 'apple'],
['Apple', 'apple1'],
['apple1', 'apple10'],
['Банан', 'banana'],
[13000, 'Банан'],
['Banana', 'Яблоко'],
['banana', 'банан'],
['банан', 'яблоко'],
], $this->arrayWithArrayValues);
}
}
21 changes: 21 additions & 0 deletions user_guide_src/source/outgoing/localization.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

...

Files found: 10
New translates found: 30
Bad translates found: 5
+------------------------+---------------------------------+
| Bad Key | Filepath |
+------------------------+---------------------------------+
| ..invalid_nested_key.. | app/Controllers/Translation.php |
| .invalid_key | app/Controllers/Translation.php |
| TranslationBad | app/Controllers/Translation.php |
| TranslationBad. | app/Controllers/Translation.php |
| TranslationBad... | app/Controllers/Translation.php |
+------------------------+---------------------------------+

All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: [Commands] lang:find show bad keys when scanning (v2)#8285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 8 commits into

from

Dec 8, 2023
 Merged


feat: [Commands] lang:find show bad keys when scanning (v2)
#8285
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
33357b6

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
6610e32

test: Test bad lang keys when scanning


neznaika0 Nov 4, 2023
25a1573

fix: Show the keys and files where they are used


neznaika0 Dec 3, 2023
a166470

feat: Sort array values by natural order


neznaika0 Dec 3, 2023
e23c44c

test: Add duplicate data for example


neznaika0 Dec 3, 2023
fe3b430

test: Fix test for bad language keys


neznaika0 Dec 3, 2023
66d4f0e

test: Add for ArrayHelper::sortValuesByNatural


neznaika0 Dec 3, 2023
9747d12

docs: Add example output bad lang keys


neznaika0 Dec 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


48 changes: 39 additions & 9 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function run(array $params)
 if (is_string($optionDir)) {
 $tempCurrentDir = realpath($currentDir . $optionDir);

 if (false === $tempCurrentDir) {
 if ($tempCurrentDir === false) {
 CLI::error('Error: Directory must be located in "' . $currentDir . '"');

 return EXIT_USER_INPUT;
Expand DownExpand Up@@ -111,7 +111,12 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

 [$foundLanguageKeys, $countFiles] = $this->findLanguageKeysInFiles($files);
 [
 'foundLanguageKeys' => $foundLanguageKeys,
 'badLanguageKeys' => $badLanguageKeys,
 'countFiles' => $countFiles
 ] = $this->findLanguageKeysInFiles($files);

 ksort($foundLanguageKeys);

 $languageDiff = [];
Expand All@@ -135,7 +140,7 @@ private function process(string $currentDir, string $currentLocale): void
 $newLanguageKeys = array_replace_recursive($foundLanguageKeys[$langFileName], $languageStoredKeys);

 if ($languageDiff !== []) {
 if (false === file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys))) {
 if (file_put_contents($languageFilePath, $this->templateFile($newLanguageKeys)) === false) {
 $this->writeIsVerbose('Lang file ' . $langFileName . ' (error write).', 'red');
 } else {
 $this->writeIsVerbose('Lang file "' . $langFileName . '" successful updated!', 'green');
Expand All@@ -155,14 +160,30 @@ private function process(string $currentDir, string $currentLocale): void

 $this->writeIsVerbose('Files found: ' . $countFiles);
 $this->writeIsVerbose('New translates found: ' . $countNewKeys);
 $this->writeIsVerbose('Bad translates found: ' . count($badLanguageKeys));

 if ($this->verbose && $badLanguageKeys !== []) {
 $tableBadRows = [];

 foreach ($badLanguageKeys as $value) {
 $tableBadRows[] = [$value[1], $value[0]];
 }

 ArrayHelper::sortValuesByNatural($tableBadRows, 0);

 CLI::table($tableBadRows, ['Bad Key', 'Filepath']);
 }
 }

 /**
 * @param SplFileInfo|string $file
 *
 * @return array<string, array>
 */
 private function findTranslationsInFile($file): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];

 if (is_string($file) && is_file($file)) {
 $file = new SplFileInfo($file);
Expand All@@ -172,14 +193,16 @@ private function findTranslationsInFile($file): array
 preg_match_all('/lang\(\'([._a-z0-9\-]+)\'\)/ui', $fileContent, $matches);
@neznaika0neznaika0Dec 7, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one feature: The regular expression initially discards bad keys. They will not be shown in the list.

 if ($matches[1] === []) {
 return [];
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 foreach ($matches[1] as $phraseKey) {
 $phraseKeys = explode('.', $phraseKey);

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -189,6 +212,8 @@ private function findTranslationsInFile($file): array
 || ($languageFileName === '' && $phraseKeys[0] === '');

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = [mb_substr($file->getRealPath(), mb_strlen(ROOTPATH)), $phraseKey];

 continue;
 }

Expand All@@ -201,7 +226,7 @@ private function findTranslationsInFile($file): array
 }
 }

 return $foundLanguageKeys;
 return compact('foundLanguageKeys', 'badLanguageKeys');
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -334,12 +359,13 @@ private function isSubDirectory(string $directory, string $rootDirectory): bool
 /**
 * @param SplFileInfo[] $files
 *
 * @return array<int, array|int>
 * @phpstan-return list{0: array<string, array<string, string>>, 1: int}
 * @return array<string, array|int>
 * @phpstan-return array{'foundLanguageKeys': array<string, array<string, string>>, 'badLanguageKeys': array<int, array<int, string>>, 'countFiles': int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $badLanguageKeys = [];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +375,13 @@ private function findLanguageKeysInFiles(array $files): array

 $this->writeIsVerbose('File found: ' . mb_substr($file->getRealPath(), mb_strlen(APPPATH)));
 $countFiles++;
 $foundLanguageKeys = array_replace_recursive($this->findTranslationsInFile($file), $foundLanguageKeys);

 $findInFile = $this->findTranslationsInFile($file);

 $foundLanguageKeys = array_replace_recursive($findInFile['foundLanguageKeys'], $foundLanguageKeys);
 $badLanguageKeys = array_merge($findInFile['badLanguageKeys'], $badLanguageKeys);
 }

 return [$foundLanguageKeys, $countFiles];
 return compact('foundLanguageKeys', 'badLanguageKeys', 'countFiles');
 }
}

19 changes: 19 additions & 0 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,9 @@
 * If there are any methods that should be provided, make them
 * public APIs via helper functions.
 *
 * @see \CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest
 * @see \CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest
 */
final class ArrayHelper
{
Expand DownExpand Up@@ -297,4 +299,21 @@ public static function recursiveCount(array $array, int $counter = 0): int

 return $counter;
 }

 /**
 * Sorts array values in natural order
 * If the value is an array, you need to specify the $sortByIndex of the key to sort
 *
 * @param int|string|null $sortByIndex
 */
 public static function sortValuesByNatural(array &$array, $sortByIndex = null): bool
 {
 return usort($array, static function ($currentValue, $nextValue) use ($sortByIndex) {
 if ($sortByIndex !== null) {
 return strnatcmp($currentValue[$sortByIndex], $nextValue[$sortByIndex]);
 }

 return strnatcmp($currentValue, $nextValue);
 });
 }
}

7 changes: 7 additions & 0 deletions
tests/_support/Services/Translation/TranslationTwo.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,13 @@ public function list()
 $translationError6 = lang('TranslationTwo...');
 $translationError7 = lang('..invalid_nested_key..');

 $copyTranslationError1 = lang('TranslationTwo');
 $copyTranslationError2 = lang(' ');
 $copyTranslationError3 = lang('');
 $copyTranslationError4 = lang('.invalid_key');
 $copyTranslationError5 = lang('TranslationTwo.');
 $copyTranslationError6 = lang('TranslationTwo...');
 $copyTranslationError7 = lang('..invalid_nested_key..');
 // Empty in comments lang('') lang(' ')
 }
}

29 changes: 29 additions & 0 deletions
tests/system/Commands/Translation/LocalizationFinderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,15 @@ public function testShowNewTranslation(): void
 $this->assertStringContainsString($this->getActualTableWithNewKeys(), $this->getStreamFilterBuffer());
 }

 public function testShowBadTranslation(): void
 {
 $this->makeLocaleDirectory();

 command('lang:find --dir Translation --verbose');

 $this->assertStringContainsString($this->getActualTableWithBadKeys(), $this->getStreamFilterBuffer());
 }

 private function getActualTranslationOneKeys(): array
 {
 return [
Expand DownExpand Up@@ -193,6 +202,26 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +------------------------+--------------------------------------------------------+
 | Bad Key | Filepath |
 +------------------------+--------------------------------------------------------+
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | ..invalid_nested_key.. | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | .invalid_key | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo. | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 | TranslationTwo... | tests/_support/Services/Translation/TranslationTwo.php |
 +------------------------+--------------------------------------------------------+
 TEXT_WRAP;
 }

 private function assertTranslationsExistAndHaveTranslatedKeys(): void
 {
 $this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down

121 changes: 121 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperSortValuesByNaturalTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperSortValuesByNaturalTest extends CIUnitTestCase
{
 private array $arrayWithStringValues = [
 'apple10',
 'banana',
 'apple1',
 'банан',
 'Banana',
 'Apple',
 100000,
 'яблоко',
 1200,
 13000,
 'Банан',
 'Яблоко',
 'apple',
 ];
 private array $arrayWithArrayValues = [
 ['apple', 'Banana'],
 ['apple10', 'Apple'],
 ['Яблоко', 1200],
 [13000, 'Банан'],
 ['Apple', 'apple1'],
 ['banana', 'банан'],
 [100000, 13000],
 ['Banana', 'Яблоко'],
 ['Банан', 'banana'],
 [1200, 'apple'],
 ['apple1', 'apple10'],
 ['яблоко', 100000],
 ['банан', 'яблоко'],
 ];

 public function testSortWithStringValues(): void
 {
 shuffle($this->arrayWithStringValues);

 ArrayHelper::sortValuesByNatural($this->arrayWithStringValues);

 $this->assertSame([
 1200,
 13000,
 100000,
 'Apple',
 'Banana',
 'apple',
 'apple1',
 'apple10',
 'banana',
 'Банан',
 'Яблоко',
 'банан',
 'яблоко',
 ], $this->arrayWithStringValues);
 }

 public function testSortWithArrayValues(): void
 {
 shuffle($this->arrayWithArrayValues);

 // For first index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 0);

 $this->assertSame([
 [1200, 'apple'],
 [13000, 'Банан'],
 [100000, 13000],
 ['Apple', 'apple1'],
 ['Banana', 'Яблоко'],
 ['apple', 'Banana'],
 ['apple1', 'apple10'],
 ['apple10', 'Apple'],
 ['banana', 'банан'],
 ['Банан', 'banana'],
 ['Яблоко', 1200],
 ['банан', 'яблоко'],
 ['яблоко', 100000],
 ], $this->arrayWithArrayValues);

 shuffle($this->arrayWithArrayValues);

 // For other index
 ArrayHelper::sortValuesByNatural($this->arrayWithArrayValues, 1);

 $this->assertSame([
 ['Яблоко', 1200],
 [100000, 13000],
 ['яблоко', 100000],
 ['apple10', 'Apple'],
 ['apple', 'Banana'],
 [1200, 'apple'],
 ['Apple', 'apple1'],
 ['apple1', 'apple10'],
 ['Банан', 'banana'],
 [13000, 'Банан'],
 ['Banana', 'Яблоко'],
 ['banana', 'банан'],
 ['банан', 'яблоко'],
 ], $this->arrayWithArrayValues);
 }
}

21 changes: 21 additions & 0 deletions
user_guide_src/source/outgoing/localization.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -284,6 +284,27 @@ Before updating, it is possible to preview the translations found by the command

 php spark lang:find --verbose --show-new

The detailed output of ``--verbose`` also shows a list of invalid keys. For example:

.. code-block:: console

 ...

 Files found: 10
 New translates found: 30
 Bad translates found: 5
 +------------------------+---------------------------------+
 | Bad Key | Filepath |
 +------------------------+---------------------------------+
 | ..invalid_nested_key.. | app/Controllers/Translation.php |
 | .invalid_key | app/Controllers/Translation.php |
 | TranslationBad | app/Controllers/Translation.php |
 | TranslationBad. | app/Controllers/Translation.php |
 | TranslationBad... | app/Controllers/Translation.php |
 +------------------------+---------------------------------+

 All operations done!

For a more accurate search, specify the desired locale or directory to scan.

.. code-block:: console
Expand Down