scripts/set-alias-page.py: fix status message for existing files #15389

Zamoca42 · 2024-12-30T15:16:05Z

This PR addresses an issue in the set-alias-page.py script where it incorrectly shows “page would be added” for files that already exist and improves handling for diverse alias patterns.

Changes

Modified set_alias_page() function to check file existence before determining status.
Changed status determination logic from checking original_command to checking path.exists().
Replaced the regular expression logic in get_alias_command_in_page() with pre-parsed alias patterns specific to each language
(e.g., "This command is an alias of" for English, "이 명령은" for Korean, "このコマンドは" for Japanese).

Before

Shows "page would be added" even for existing files that need to be updated.
Regular expression did not handle variations like GNU or trailing descriptions.

After

Shows "page would be added" only for new files.
Shows "page would be updated" for existing files that need to be updated.
Uses pre-parsed alias patterns for language-specific detection, improving robustness and readability.

This reverts commit cf7648e.

This reverts commit ecf2dd9.

tldr-bot · 2024-12-30T16:15:42Z

Hello! I've noticed something unusual when checking this PR:

The page pages.ko/linux/i386.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/linux32.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/linux64.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-d.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-f.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-q.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-r.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-s.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-t.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/pacman-u.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/uname26.md is outdated, based on the command contents itself, compared to the English page.
The page pages.ko/linux/x86_64.md is outdated, based on the command contents itself, compared to the English page.

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

tldr-bot · 2024-12-30T16:20:38Z

The build for this PR failed with the following error(s):

would reformat /home/runner/work/tldr/tldr/scripts/set-alias-page.py

Oh no! 💥 💔 💥
1 file would be reformatted, 6 files would be left unchanged.

Please fix the error(s) and push again.

sebastiaanspeck · 2024-12-30T17:12:46Z

Could you remove the Korean changes? I think you have committed them by accident when testing

sebastiaanspeck

After removing the Korean changes (or moving them to a separate PR), this LGTM!

scripts/set-alias-page.py

Zamoca42 · 2024-12-31T05:21:51Z

Could you remove the Korean changes? I think you have committed them by accident when testing

Let's separate the Korean alias page into a different PR

sebastiaanspeck · 2024-12-31T08:13:06Z

A minor fix needs to be made I think.

When running it (scripts/set-alias-pages.py -l nl -S), it also changed a lot of pages.nl/osx/g....md files, updating false-positives:

sebastiaanspeck · 2024-12-31T08:35:28Z

scripts/set-alias-page.py

                    root / "pages" / command,
-                    r"^> This command is an alias of `(.+)`\.$",
+                    r"^> This command is an alias of(?: \w+)? `([^`]+)`(?:,.*)?",


This regex is not completely working correctly anymore:

CHECKING tldr-pages/tldr/pages/osx/gsum.md using the regex: ^> This command is an alias of(?: \w+)? `([^`]+)`(?:,.*)?... RESULT tldr-pages/tldr/pages/osx/gsum.md using the regex: ^> This command is an alias of(?: \w+)? `([^`]+)`(?:,.*)?: COMMAND_NAME= sum

I expected it to be -p linux sum.

It seems that the command in the description and the tldr command might differ. I’ll try modifying the get_alias_command_in_page() function.

I tested the changes by creating and running an arbitrary test function, and the updated logic works as expected for most files.

❯ python scripts/set-alias-page.py --test pages/osx/gsum.md Testing file: pages/osx/gsum.md Content: # gsum > This command is an alias of GNU `sum`. - View documentation for the original command: `tldr -p linux sum` Original command: sum Documentation command: -p linux sum ❯ python scripts/set-alias-page.py --test pages.nl/osx/gsum.md Testing file: pages.nl/osx/gsum.md Content: # gsum > Dit commando is een alias van `-p linux sum`. - Bekijk de documentatie van het originele commando: `tldr -p linux sum` Original command: -p linux sum Documentation command: -p linux sum ❯ python scripts/set-alias-page.py --test pages/osx/g\[.md Testing file: pages/osx/g[.md Content: # g[ > This command is an alias of GNU `[`. - View documentation for the original command: `tldr -p linux [` Original command: [ Documentation command: -p linux [ ❯ python scripts/set-alias-page.py --test pages.nl/osx/g\[.md Testing file: pages.nl/osx/g[.md Content: # g[ > Dit commando is een alias van `-p linux [`. - Bekijk de documentatie van het originele commando: `tldr -p linux [` Original command: -p linux [ Documentation command: -p linux [

When testing with the latest version, it is still "broken". --test does not exist anymore. I use python scripts/set-alias-page.py -Snl nl which still results in the long list with the osx/g*.md.

It was just for output, but now added a function for testing.

The function to test isn't needed. It was just not working as expected.

- Seperate original command and documentation command - Update variable names

…on commands

sebastiaanspeck · 2025-01-02T16:06:47Z

scripts/set-alias-page.py

@@ -241,9 +317,23 @@ def main():
    parser = create_argument_parser(
        "Sets the alias page for all translations of a page"
    )
-    parser.add_argument("command", type=str, nargs="?", default="")
+    parser.add_argument(
+        "original_command",


Please update the usage at the beginning of the file to rename "command" to "original command" and add "documentation command".

I added documentation examples for 'ORIGINAL_CMD' and 'DOC_CMD.' While testing, I found that commands like python3 scripts/set-alias-page.py -P osx/gsum sum '-p linux sum' failed due to the -p argument being incorrect. To fix this, I changed the page argument from -p to -P.

scripts/set-alias-page.py

- Extract locale alias pattern logic into a separate function for better readability - Change -p to -P to avoid collision with tldr's -p flag in documentation command (e.g., "-p linux sum" in "python3 scripts/set-alias-page.py -P osx/gsum sum '-p linux sum'") - Update documentation to use consistent command argument names (ORIGINAL_CMD, DOC_CMD) - Change bullet points to asterisks in examples for better visibility

Zamoca42 added 5 commits December 30, 2024 21:21

Update set alias page when file already exists

e94501a

Update Korean translation alias pages

cf7648e

Revert "Update Korean translation alias pages"

b7895f8

This reverts commit cf7648e.

Update original command

f21edaf

Add Korean translation for alias pages

ecf2dd9

Zamoca42 requested review from sebastiaanspeck, kbdharun, IMHOJEONG and CodePsy-2001 as code owners December 30, 2024 15:16

github-actions bot added documentation Issues/PRs modifying the documentation. tooling Helper tools, scripts and automated processes. translation Translate pages from one language to another. labels Dec 30, 2024

Zamoca42 added 4 commits December 31, 2024 00:34

Revert "Add Korean translation for alias pages"

a2394f3

This reverts commit ecf2dd9.

Improve alias page template processing

6e641be

Add Korean translation for alias pages

7138ad6

Update format of alias pages

4ca4c90

Update format of alias pages

56a6cfc

Zamoca42 added 2 commits December 31, 2024 01:26

Reformat scripts/set-alias-page.py

14d4685

Merge branch 'main' into update-set-alias-page

5ef6671

sebastiaanspeck changed the title ~~scripts/set-alias-page.py: Fix status message in set-alias-page.py for existing files~~ scripts/set-alias-page.py: Fix status message for existing files Dec 31, 2024

sebastiaanspeck approved these changes Dec 31, 2024

View reviewed changes

sebastiaanspeck requested changes Dec 31, 2024

View reviewed changes

scripts/set-alias-page.py Show resolved Hide resolved

Zamoca42 added 4 commits December 31, 2024 14:33

Remove Korean alias pages

004a9a5

Reverting Korean alias pages template

34733d9

Restore regex for alias page parsing

35f8fc8

Merge branch 'main' into update-set-alias-page

1e8d78e

Zamoca42 removed the translation Translate pages from one language to another. label Dec 31, 2024

Zamoca42 removed request for IMHOJEONG and CodePsy-2001 December 31, 2024 05:47

sebastiaanspeck changed the title ~~scripts/set-alias-page.py: Fix status message for existing files~~ scripts/set-alias-page.py: fix status message for existing files Dec 31, 2024

sebastiaanspeck reviewed Dec 31, 2024

View reviewed changes

Zamoca42 added 5 commits January 2, 2025 19:03

Update parsing alias page command

08d0b39

- Seperate original command and documentation command - Update variable names

Merge branch 'main' into update-set-alias-page

7db9d2e

Update comment

424087f

Update command arguments to support separate original and documentati…

0f06818

…on commands

Add original_command arguments optional

672259c

sebastiaanspeck reviewed Jan 2, 2025

View reviewed changes

scripts/set-alias-page.py Outdated Show resolved Hide resolved

sebastiaanspeck and others added 3 commits January 2, 2025 17:08

Merge branch 'main' into update-set-alias-page

f5b9df6

Add command parsing test function

2da1472

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

scripts/set-alias-page.py: fix status message for existing files #15389

scripts/set-alias-page.py: fix status message for existing files #15389

Zamoca42 commented Dec 30, 2024 •

edited

Loading

tldr-bot commented Dec 30, 2024

tldr-bot commented Dec 30, 2024

sebastiaanspeck commented Dec 30, 2024

sebastiaanspeck left a comment

Zamoca42 commented Dec 31, 2024

sebastiaanspeck commented Dec 31, 2024

sebastiaanspeck Dec 31, 2024 •

edited

Loading

Zamoca42 Dec 31, 2024

Zamoca42 Jan 2, 2025

sebastiaanspeck Jan 2, 2025

Zamoca42 Jan 2, 2025

sebastiaanspeck Jan 2, 2025

sebastiaanspeck Jan 2, 2025

Zamoca42 Jan 2, 2025

scripts/set-alias-page.py: fix status message for existing files #15389

Are you sure you want to change the base?

scripts/set-alias-page.py: fix status message for existing files #15389

Conversation

Zamoca42 commented Dec 30, 2024 • edited Loading

Changes

Before

After

tldr-bot commented Dec 30, 2024

tldr-bot commented Dec 30, 2024

sebastiaanspeck commented Dec 30, 2024

sebastiaanspeck left a comment

Choose a reason for hiding this comment

Zamoca42 commented Dec 31, 2024

sebastiaanspeck commented Dec 31, 2024

sebastiaanspeck Dec 31, 2024 • edited Loading

Choose a reason for hiding this comment

Zamoca42 Dec 31, 2024

Choose a reason for hiding this comment

Zamoca42 Jan 2, 2025

Choose a reason for hiding this comment

sebastiaanspeck Jan 2, 2025

Choose a reason for hiding this comment

Zamoca42 Jan 2, 2025

Choose a reason for hiding this comment

sebastiaanspeck Jan 2, 2025

Choose a reason for hiding this comment

sebastiaanspeck Jan 2, 2025

Choose a reason for hiding this comment

Zamoca42 Jan 2, 2025

Choose a reason for hiding this comment

Zamoca42 commented Dec 30, 2024 •

edited

Loading

sebastiaanspeck Dec 31, 2024 •

edited

Loading