feat(cli): CLI usage example

Author: kabeep

bin/cli.ts

@@ -5,6 +5,7 @@ import readline from 'node:readline';
 import { hideBin } from 'yargs/helpers';
 import yargs from 'yargs/yargs';
 import pipeline, { type ArgumentVector, locale } from '../src';
+import { yellow } from '../src/utils';
 
 if (process.platform === 'win32') {
     const rl = readline.createInterface({
@@ -89,6 +90,30 @@ pipeline(
             boolean: true,
             default: false,
         })
+        .example([
+            [yellow('translate Hello World!'), locale.CMD_USAGE_EG],
+            [yellow('translate Hello World! --to=es'), locale.CMD_USAGE_EG_TO],
+            [yellow('translate --show-phonetics --show-source --show-detail Hello World!'), locale.CMD_USAGE_EG_SHOW],
+            [yellow('translate -psd Hello World!'), locale.CMD_USAGE_EG_ABBR],
+            [yellow('cat ./README.md | translate'), locale.CMD_USAGE_EG_FILE],
+            [
+                yellow(
+                    'curl https://raw.githubusercontent.com/rust-lang/book/master/src/ch01-00-getting-started.md | translate',
+                ),
+                locale.CMD_USAGE_EG_STDIN,
+            ],
+            [yellow('npm --help | translate > npm-help.txt'), locale.CMD_USAGE_EG_HELP],
+            [
+                yellow(
+                    'curl example.com --stdin-timeout=5000 | translate',
+                ),
+                locale.CMD_USAGE_EG_SLOW,
+            ],
+            [yellow('translate --engine microsoft Hello World!'), locale.CMD_USAGE_EG_ENGINE],
+            [yellow('export NODE_TRANSLATE_CLI_ENGINE=microsoft && translate Hello World!'), locale.CMD_USAGE_EG_ENV],
+            [yellow('translate --timeout 3000 --retry 3 Hello World!'), locale.CMD_USAGE_EG_TIMEOUT],
+            [yellow('translate --show-languages'), locale.CMD_USAGE_EG_LANGS],
+        ])
         .alias({
             v: 'version',
             h: 'help',

src/locale/en-US.ts

@@ -16,6 +16,25 @@ export default {
     CMD_DES_SHOW_DETAIL: 'Show translated detail information',
     CMD_DES_SHOW_LANGUAGES: 'Show supported languages',
 
+    CMD_USAGE_EG: 'Translate "Hello World!" into your language',
+    CMD_USAGE_EG_TO: 'Translate "Hello World!" into Spanish',
+    CMD_USAGE_EG_SHOW:
+        'Output more information (Lang Name, Synonym, Polysemy, Sentence, ...)',
+    CMD_USAGE_EG_ABBR: 'Make CLI simple with argument abbreviations',
+    CMD_USAGE_EG_FILE: 'Translate file "./README.md" into your language',
+    CMD_USAGE_EG_STDIN:
+        'Translate "Rust-lang Book chapter 01" into your language',
+    CMD_USAGE_EG_HELP:
+        'Translate output of "npm --help" into your language, and save it to a file',
+    CMD_USAGE_EG_SLOW:
+        'If you have a time-consuming task, use `--stdin-timeout` to protect the CLI',
+    CMD_USAGE_EG_ENGINE: 'Use "microsoft" as translation engine',
+    CMD_USAGE_EG_ENV:
+        'Specify the translation engine through env variable "NODE_TRANSLATE_CLI_ENGINE"',
+    CMD_USAGE_EG_TIMEOUT:
+        'If you are concerned about your network status, use  `--timeout` to protect the CLI',
+    CMD_USAGE_EG_LANGS: 'Show supported languages list',
+
     CMD_SPIN_STDIN: 'Loading stdin...',
     CMD_SPIN_TRANSLATE: 'Waiting translate API...',
 
@@ -24,7 +43,6 @@ export default {
     CMD_TYPO_SYNONYM: 'Synonym',
     CMD_TYPO_POLYSEMY: 'Polysemy',
     CMD_TYPO_SENTENCE: 'Sentence',
-    CMD_TYPO_LANGUAGE: 'Language List',
 
     CMD_ERR_MISSING_ARGUMENT:
         'Please enter the content that needs to be translated',

src/locale/zh-CN.ts

@@ -11,6 +11,23 @@ export default {
     CMD_DES_SHOW_DETAIL: '查看翻译后的详细信息',
     CMD_DES_SHOW_LANGUAGES: '显示支持的语言列表',
 
+    CMD_USAGE_EG: '将 "Hello World!" 翻译到你的语言',
+    CMD_USAGE_EG_TO: '将 "Hello World!" 翻译成你的西班牙语',
+    CMD_USAGE_EG_SHOW:
+        '输出更多信息 (语言名称, 发音, 同近义词, 词性, 更多释义, 例句, ...)',
+    CMD_USAGE_EG_ABBR: '用参数缩写让命令行变得简单',
+    CMD_USAGE_EG_FILE: '将 "./README.md" 翻译成你的语言',
+    CMD_USAGE_EG_STDIN: '将 "Rust 语言书第一章节" 翻译成你的语言',
+    CMD_USAGE_EG_HELP:
+        '将 "npm --help" 的输出翻译成你的语言, 并将结果保存成文件',
+    CMD_USAGE_EG_SLOW:
+        '如果有一个很耗时的任务, 使用 `--stdin-timeout` 参数保护命令行',
+    CMD_USAGE_EG_ENGINE: '指定 "microsoft" 作为翻译引擎',
+    CMD_USAGE_EG_ENV: '通过环境变量 "NODE_TRANSLATE_CLI_ENGINE" 指定翻译引擎',
+    CMD_USAGE_EG_TIMEOUT:
+        '如果你担忧自己的网络状况, 使用 `--timeout` 参数保护命令行',
+    CMD_USAGE_EG_LANGS: '显示支持的语言',
+
     CMD_SPIN_STDIN: '加载标准输入流...',
     CMD_SPIN_TRANSLATE: '等待翻译API...',
 
@@ -19,7 +36,6 @@ export default {
     CMD_TYPO_SYNONYM: '同近义词',
     CMD_TYPO_POLYSEMY: '多义词',
     CMD_TYPO_SENTENCE: '例句',
-    CMD_TYPO_LANGUAGE: '语言列表',
 
     CMD_ERR_MISSING_ARGUMENT: '请输入需要翻译的内容',
     CMD_ERR_STDIN_TIMEOUT: '标准输入流监听超时',