ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tldr/scripts
History
Vitor Henrique 561a364e0d
tooling: add update-command script (#11974) 
* tooling: add update-command script

* update-command: add os import

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* update-command: remove sync argument and small refactor

* update-command: add shebang and license

* update-command: remove unused function

* update-command: add dry-run option

* update-command: add docs in header

* update-command: fix old_common_part var name

* update-command: require command without .md

* update-command: fix command name in description

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>

* update-command: remove ".md" suffix in description

* update-command: enclosing positional parameters with angle brackets

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* update-command: enclose paremeters with double angle brackets

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* update-command: refine wording

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* update-command: remove unused functions

* update-command: detect tldr root from any subdir

* update-command: call place_placeholders directly

* update-command: add summary and compatibility to scripts/README.md

* scripts/update-command.py: remove unused method

* scripts/update-command.py: use logger.info instead of print

* scripts/update-command.py: rename command to cmd_example

* scripts/README.md: use command example instead of command

* scripts/update-command.py: remove nonexistent optional argument

* scripts/update-command.py: improve interactive example

* scripts/update-command.py: run black

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
 		2024-01-27 23:10:42 +08:00
..
pdf cleanup: update PDF README 2023-12-24 10:55:30 +05:30
README.md tooling: add update-command script (#11974) 2024-01-27 23:10:42 +08:00
build-index.js build(deps): bump glob from 7.2.0 to 10.2.7 (#10377) 2023-07-06 08:47:20 -07:00
build.sh cleanup: revert back don't build scripts archive step (#11838) 2023-12-26 00:09:17 +05:30
check-pr.sh check-pr: fix typo (#12038) 2024-01-08 20:38:24 +01:00
deploy.sh deploy: use single-quoted argument (#11951) 2023-12-31 13:20:51 +01:00
send-to-bot.py send-to-bot: remove once, let the tldr-bot always comment (#11547) 2023-11-20 21:06:02 +01:00
set-alias-page.py scripts: add option to dry-run (#11883) 2024-01-02 06:53:39 +01:00
set-more-info-link.py scripts: add option to dry-run (#11883) 2024-01-02 06:53:39 +01:00
test.sh test: skip symlinked English folder and optimise the script (#11537) 2023-11-18 11:48:52 +01:00
update-command.py tooling: add update-command script (#11974) 2024-01-27 23:10:42 +08:00
wrong-filename.sh wrong-filename.sh: update output filename 2023-12-24 10:55:30 +05:30

README.md

Scripts

The current directory contains useful scripts used/to use with tldr pages.

Summary

This section contains a summary of the scripts available in this directory. For more information about each script, please refer to the header of each script.

  • pdf directory contains the render.py and build-pdf.sh script and related resources to generate a PDF document of tldr-pages for a specific language or platform (or both).
  • build.sh script builds the ZIP archives of the pages directory.
  • build-index.sh script builds the index of available pages.
  • check-pr.sh script checks the pages syntax and performs various checks on the PR.
  • deploy.sh script deploys the ZIP and PDF archives to the static website repository.
  • send-to-bot.py is a Python script that send the build or tests output to tldr-bot.
  • set-alias-page.py is a Python script to generate or update alias pages.
  • set-more-info-link.py is a Python script to generate or update more information links across pages.
  • test.sh script runs some basic tests on every PR/commit to make sure that the pages are valid and that the code is formatted correctly.
  • wrong-filename.sh script checks the consistency between the filenames and the page title.
  • update-command.py is a Python script to update the common contents of a command example across all languages.

Compatibility

The below table shows the compatibility of user-executable scripts with different platforms.

Script Linux macOS (osx) Windows
render.py ✅ ✅ ✅
build-pdf.sh ✅ ✅ ❌
build.sh ✅ ✅ ❌
set-alias-pages.py ✅ ✅ ✅
set-more-info-link.py ✅ ✅ ✅
wrong-filename.sh ✅ ❌ ❌
update-command.py ✅ ✅ ✅