Skip to content

feat: [Commands] lang:find show bad keys when scanning#8149

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

Closed
neznaika0 wants to merge 2 commits into from
Closed

feat: [Commands] lang:find show bad keys when scanning #8149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5c51f2
feat: Show bad lang keys when scanning
neznaika0 Nov 4, 2023
4e2127b
test: Test bad lang keys when scanning
neznaika0 Nov 4, 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
36 changes: 29 additions & 7 deletions system/Commands/Translation/LocalizationFinder.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
$files = iterator_to_array($iterator, true);
ksort($files);

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

$languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
$tableBadRows[] = [$key, $value];
}

CLI::table($tableBadRows, ['№', 'Bad key']);

@kenjiskenjisNov 5, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change
CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);

@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?

@kenjiskenjisNov 6, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.

No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php

@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.

}
}

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

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

if ($matches[1] === []) {
return [];
return [[], []];
}

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

// Language key not have Filename or Lang key
if (count($phraseKeys) < 2) {
$badLanguageKeys[] = $phraseKey;

continue;
}

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

if ($isEmptyNestedArray) {
$badLanguageKeys[] = $phraseKey;

continue;
}

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

return $foundLanguageKeys;
return [$foundLanguageKeys, $badLanguageKeys];
}

private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
* @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
*/
private function findLanguageKeysInFiles(array $files): array
{
$foundLanguageKeys = [];
$foundLanguageKeys = [[], []];
$countFiles = 0;

foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
$foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);
Comment on lines +373 to +374

@kenjiskenjisNov 6, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].
Name meaningful variable names.

@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one

}

return [$foundLanguageKeys, $countFiles];
return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
}
}
24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
TEXT_WRAP;
}

private function getActualTableWithBadKeys(): string
{
return <<<'TEXT_WRAP'
+---+------------------------+
| № | Bad key |
+---+------------------------+
| 0 | TranslationTwo |
| 1 | .invalid_key |
| 2 | TranslationTwo. |
| 3 | TranslationTwo... |
| 4 | ..invalid_nested_key.. |
+---+------------------------+
TEXT_WRAP;
}

private function assertTranslationsExistAndHaveTranslatedKeys(): void
{
$this->assertFileExists(self::$languageTestPath . self::$locale . '/TranslationOne.php');
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: [Commands] `lang:find` show bad keys when scanning by neznaika0 · Pull Request #8149 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
feat: [Commands] lang:find show bad keys when scanning#8149

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: [Commands] `lang:find` show bad keys when scanning by neznaika0 · Pull Request #8149 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
feat: [Commands] lang:find show bad keys when scanning#8149

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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

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

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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

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

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: [Commands] `lang:find` show bad keys when scanning by neznaika0 · Pull Request #8149 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
feat: [Commands] lang:find show bad keys when scanning#8149

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
feat: [Commands] `lang:find` show bad keys when scanning by neznaika0 · Pull Request #8149 · codeigniter4/CodeIgniter4 · GitHub
Skip to content
feat: [Commands] lang:find show bad keys when scanning#8149

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

 Closed

neznaika0
wants to merge
2
commits into

from

 Closed


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

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d5c51f2

feat: Show bad lang keys when scanning


neznaika0 Nov 4, 2023
4e2127b

test: Test bad lang keys when scanning


neznaika0 Nov 4, 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


36 changes: 29 additions & 7 deletions
system/Commands/Translation/LocalizationFinder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,7 +111,7 @@ private function process(string $currentDir, string $currentLocale): void
 $files = iterator_to_array($iterator, true);
 ksort($files);

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

 $languageDiff = [];
Expand DownExpand Up@@ -155,14 +155,28 @@ 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 $key => $value) {
 $tableBadRows[] = [$key, $value];
 }

 CLI::table($tableBadRows, ['№', 'Bad key']);
@kenjiskenjisNov 5, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

What do you need the No. for? I want the file paths.

Suggested change

CLI::table($tableBadRows, ['№', 'Bad key']);
CLI::table($tableBadRows, ['№', 'Bad Key']);
@neznaika0neznaika0Nov 5, 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.

The number is just for understanding which line. I think file paths are not an option to show. Since one language key can be in ~1000 different files. How do you see it?
@kenjiskenjisNov 6, 2023•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

If a bad key is used in 1000 files, then those 1000 locations should be shown.
No.Bad KeyFile
1BadKey1path/to/file1.php
2BadKey1path/to/file2.php
.........
1000BadKey1path/to/file1000.php
@neznaika0neznaika0Nov 6, 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.

Heh, I'll try to do it.
 }
 }

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

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

 if ($matches[1] === []) {
 return [];
 return [[], []];
 }

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

 // Language key not have Filename or Lang key
 if (count($phraseKeys) < 2) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 if ($isEmptyNestedArray) {
 $badLanguageKeys[] = $phraseKey;

 continue;
 }

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

 return $foundLanguageKeys;
 return [$foundLanguageKeys, $badLanguageKeys];
 }

 private function isIgnoredFile(SplFileInfo $file): bool
Expand DownExpand Up@@ -335,11 +353,11 @@ 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}
 * @phpstan-return list{0: array<string, array<string, string>>, 1: array<string, array<string, string>>, 2: int}
 */
 private function findLanguageKeysInFiles(array $files): array
 {
 $foundLanguageKeys = [];
 $foundLanguageKeys = [[], []];
 $countFiles = 0;

 foreach ($files as $file) {
Expand All@@ -349,9 +367,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[0] = array_replace_recursive($findInFile[0], $foundLanguageKeys[0]);
 $foundLanguageKeys[1] = array_merge($findInFile[1], $foundLanguageKeys[1]);

Comment on lines

+373
 to 
+374

@kenjiskenjisNov 6, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

The variable names are difficult to understand. Don't use [0] or [1].

Name meaningful variable names.
@neznaika0neznaika0Nov 6, 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.

Good. this is because the function returns multiple values instead of one
 }

 return [$foundLanguageKeys, $countFiles];
 return [$foundLanguageKeys[0], array_unique($foundLanguageKeys[1]), $countFiles];
 }
}

24 changes: 24 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,21 @@ private function getActualTableWithNewKeys(): string
 TEXT_WRAP;
 }

 private function getActualTableWithBadKeys(): string
 {
 return <<<'TEXT_WRAP'
 +---+------------------------+
 | № | Bad key |
 +---+------------------------+
 | 0 | TranslationTwo |
 | 1 | .invalid_key |
 | 2 | TranslationTwo. |
 | 3 | TranslationTwo... |
 | 4 | ..invalid_nested_key.. |
 +---+------------------------+
 TEXT_WRAP;
 }

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