#!/usr/bin/env python3 # SPDX-License-Identifier: MIT """ A Python script to add or update the "More information" link for all translations of a page. Note: If the current directory or one of its parents is called "tldr", the script will assume it is the tldr root, i.e., the directory that contains a clone of https://github.com/tldr-pages/tldr If you aren't, the script will use TLDR_ROOT as the tldr root. Also, ensure 'git' is available. Usage: python3 scripts/set-more-info-link.py [-p PAGE] [-S] [-s] [-n] [LINK] Options: -p, --page PAGE Specify the alias page in the format "platform/alias_command.md". This option allows setting the link for a specific page. -S, --sync Synchronize each translation's more information link (if exists) with that of the English page. -s, --stage Stage modified pages (requires 'git' on $PATH and TLDR_ROOT to be a Git repository). -n, --dry-run Show what changes would be made without actually modifying the page. Positional Argument: LINK The link to be set as the "More information" link. Examples: 1. Set the link for a specific page: python3 scripts/set-more-info-link.py -p common/tar.md https://example.com python3 scripts/set-more-info-link.py --page common/tar.md https://example.com 2. Read English pages and synchronize more information links across translations: python3 scripts/set-more-info-link.py -S python3 scripts/set-more-info-link.py --sync 3. Read English pages, synchronize more information links across translations and stage modified pages for commit: python3 scripts/set-more-info-link.py -Ss python3 scripts/set-more-info-link.py --sync --stage 4. Show what changes would be made across translations: python3 scripts/set-more-info-link.py -Sn python3 scripts/set-more-info-link.py --sync --dry-run """ import argparse import os import re import subprocess from pathlib import Path labels = { "en": "More information:", "ar": "لمزيد من التفاصيل:", "bn": "আরও তথ্য পাবেন:", "bs": "Više informacija:", "cs": "Více informací:", "ca": "Més informació:", "da": "Mere information:", "de": "Weitere Informationen:", "es": "Más información:", "fa": "اطلاعات بیشتر:", "fi": "Lisätietoja:", "fr": "Plus d'informations :", "sh": "Više informacija:", "hi": "अधिक जानकारी:", "id": "Informasi lebih lanjut:", "it": "Maggiori informazioni:", "ja": "詳しくはこちら:", "ko": "더 많은 정보:", "lo": "ຂໍ້ມູນເພີ່ມເຕີມ:", "ml": "കൂടുതൽ വിവരങ്ങൾ:", "ne": "थप जानकारी:", "nl": "Meer informatie:", "no": "Mer informasjon:", "pl": "Więcej informacji:", "pt_BR": "Mais informações:", "pt_PT": "Mais informações:", "ro": "Mai multe informații:", "ru": "Больше информации:", "sr": "Više informacija na:", "sv": "Mer information:", "ta": "மேலும் விவரத்திற்கு:", "th": "ข้อมูลเพิ่มเติม:", "tr": "Daha fazla bilgi için:", "uk": "Більше інформації:", "uz": "Ko'proq malumot:", "zh_TW": "更多資訊：", "zh": "更多信息：", } IGNORE_FILES = (".DS_Store",) def get_tldr_root(): """ Get the path of local tldr repository for environment variable TLDR_ROOT. """ # If this script is running from tldr/scripts, the parent's parent is the root f = Path(__file__).resolve() if ( tldr_root := next((path for path in f.parents if path.name == "tldr"), None) ) is not None: return tldr_root elif "TLDR_ROOT" in os.environ: return Path(os.environ["TLDR_ROOT"]) raise SystemExit( "\x1b[31mPlease set TLDR_ROOT to the location of a clone of https://github.com/tldr-pages/tldr." ) def set_link(path: Path, link: str, dry_run=False) -> str: with path.open(encoding="utf-8") as f: lines = f.readlines() desc_start = 0 desc_end = 0 # find start and end of description for i, line in enumerate(lines): if line.startswith(">") and desc_start == 0: desc_start = i if not lines[i + 1].startswith(">") and desc_start != 0: desc_end = i break # compute locale pages_dirname = path.parents[1].name if "." in pages_dirname: _, locale = pages_dirname.split(".") else: locale = "en" # build new line if locale in ["bn", "hi", "ne"]: new_line = f"> {labels[locale]} <{link}>।\n" elif locale in ["ja", "th"]: new_line = f"> {labels[locale]} <{link}>\n" elif locale in ["zh", "zh_TW"]: new_line = f"> {labels[locale]}<{link}>.\n" else: new_line = f"> {labels[locale]} <{link}>.\n" if lines[desc_end] == new_line: # return empty status to indicate that no changes were made return "" status_prefix = "\x1b[36m" # Color code for pages if re.search(r"^>.*<.+>", lines[desc_end]): # overwrite last line lines[desc_end] = new_line status_prefix = "\x1b[34m" action = "updated" else: # add new line lines.insert(desc_end + 1, new_line) status_prefix = "\x1b[36m" action = "added" if dry_run: status = f"link would be {action}" else: status = f"link {action}" status = f"{status_prefix}{status}\x1b[0m" if not dry_run: with path.open("w", encoding="utf-8") as f: f.writelines(lines) return status def get_link(path: Path) -> str: with path.open(encoding="utf-8") as f: lines = f.readlines() desc_start = 0 desc_end = 0 # find start and end of description for i, line in enumerate(lines): if line.startswith(">") and desc_start == 0: desc_start = i if not lines[i + 1].startswith(">") and desc_start != 0: desc_end = i break # match link if re.search(r"^>.*<.+>", lines[desc_end]): return re.search("<(.+)>", lines[desc_end]).group(1) else: return "" def sync( root: Path, pages_dirs: list[str], command: str, link: str, dry_run=False ) -> list[str]: paths = [] for page_dir in pages_dirs: path = root / page_dir / command if path.exists(): rel_path = "/".join(path.parts[-3:]) status = set_link(path, link, dry_run) if status != "": paths.append(path) print(f"\x1b[32m{rel_path} {status}\x1b[0m") return paths def main(): parser = argparse.ArgumentParser( description='Sets the "More information" link for all translations of a page' ) parser.add_argument( "-p", "--page", type=str, required=False, default="", help='page name in the format "platform/command.md"', ) parser.add_argument( "-S", "--sync", action="store_true", default=False, help="synchronize each translation's more information link (if exists) with that of English page", ) parser.add_argument( "-s", "--stage", action="store_true", default=False, help="stage modified pages (requires `git` to be on $PATH and TLDR_ROOT to be a Git repository)", ) parser.add_argument( "-n", "--dry-run", action="store_true", default=False, help="show what changes would be made without actually modifying the pages", ) parser.add_argument("link", type=str, nargs="?", default="") args = parser.parse_args() root = get_tldr_root() pages_dirs = [d for d in root.iterdir() if d.name.startswith("pages")] target_paths = [] # Use '--page' option if args.page != "": if not args.page.lower().endswith(".md"): args.page = f"{args.page}.md" arg_platform, arg_page = args.page.split("/") for pages_dir in pages_dirs: page_path = pages_dir / arg_platform / arg_page if not page_path.exists(): continue target_paths.append(page_path) target_paths.sort() for path in target_paths: rel_path = "/".join(path.parts[-3:]) status = set_link(path, args.link) if status != "": print(f"\x1b[32m{rel_path} {status}\x1b[0m") # Use '--sync' option elif args.sync: pages_dirs.remove(root / "pages") en_path = root / "pages" platforms = [i.name for i in en_path.iterdir() if i.name not in IGNORE_FILES] for platform in platforms: platform_path = en_path / platform commands = [ f"{platform}/{page.name}" for page in platform_path.iterdir() if page not in IGNORE_FILES ] for command in commands: link = get_link(root / "pages" / command) if link != "": target_paths += sync(root, pages_dirs, command, link, args.dry_run) if args.stage and not args.dry_run and len(target_paths) > 0: subprocess.call(["git", "add", *target_paths], cwd=root) if __name__ == "__main__": main()