From 17e7b28f162b3ed75683948144237ee17f81f7a5 Mon Sep 17 00:00:00 2001 From: 魏曹先生 <1992414357@qq.com> Date: Sat, 14 Mar 2026 18:33:20 +0800 Subject: Add converter module and update documentation --- resources/helpdoc/Welcome_To_JVCS.en.md | 45 ---------------------- resources/helpdoc/Welcome_To_JVCS.zh-CN.md | 45 ---------------------- resources/helpdoc/commands.en.md | 45 ++++++++++++++++++++++ resources/helpdoc/commands.zh-CN.md | 45 ++++++++++++++++++++++ resources/helpdoc/commands/helpdoc.en.md | 5 +++ resources/helpdoc/commands/helpdoc.zh-CN.md | 5 +++ resources/helpdoc/commands/sheetedit.zh-CN.md | 2 +- resources/helpdoc/commands/workspace.en.md | 14 +++++++ resources/helpdoc/commands/workspace.zh-CN.md | 14 +++++++ resources/helpdoc/commands/workspace/create.en.md | 4 ++ .../helpdoc/commands/workspace/create.zh-CN.md | 4 ++ resources/helpdoc/commands/workspace/init.en.md | 4 ++ resources/helpdoc/commands/workspace/init.zh-CN.md | 4 ++ resources/locales/jvn/en.yml | 1 + resources/locales/jvn/helpdoc_viewer/en.yml | 4 ++ resources/locales/jvn/helpdoc_viewer/zh-CN.yml | 4 ++ resources/locales/jvn/zh-CN.yml | 1 + 17 files changed, 155 insertions(+), 91 deletions(-) delete mode 100644 resources/helpdoc/Welcome_To_JVCS.en.md delete mode 100644 resources/helpdoc/Welcome_To_JVCS.zh-CN.md create mode 100644 resources/helpdoc/commands.en.md create mode 100644 resources/helpdoc/commands.zh-CN.md create mode 100644 resources/helpdoc/commands/helpdoc.en.md create mode 100644 resources/helpdoc/commands/helpdoc.zh-CN.md create mode 100644 resources/helpdoc/commands/workspace.en.md create mode 100644 resources/helpdoc/commands/workspace.zh-CN.md create mode 100644 resources/helpdoc/commands/workspace/create.en.md create mode 100644 resources/helpdoc/commands/workspace/create.zh-CN.md create mode 100644 resources/helpdoc/commands/workspace/init.en.md create mode 100644 resources/helpdoc/commands/workspace/init.zh-CN.md (limited to 'resources') diff --git a/resources/helpdoc/Welcome_To_JVCS.en.md b/resources/helpdoc/Welcome_To_JVCS.en.md deleted file mode 100644 index 3a7cf06..0000000 --- a/resources/helpdoc/Welcome_To_JVCS.en.md +++ /dev/null @@ -1,45 +0,0 @@ -> Welcome to the `JustEnoughVCS` CLI! - -## Basic Usage -jvn - -## Global Flags -Global flags for command debugging. - -### Language -**Flag**: `--lang ` -Set program language. -Options: en / zh-CN - -### Confirm -**Flag**: `--confirm` or `-C` -Skip confirmation prompts. - -### Help -**Flag**: `--help` or `-h` -Show command help. -> Or use `jvn helpdoc ` -> for full docs. - -### Renderer Override -**Flag**: `--renderer ` -Override output format. -Options: json / json-pretty / -__ ron / ron-pretty / -__ yaml / toml - -### No Error Output -**Flag**: `--no-error-logs` -Suppress error output. - -### No Progress Bar -**Flag**: `--no-progress` -Disable progress bar. - -### Quiet Output -**Flag**: `--quiet` or `-q` -Suppress all output for scripts. - -### Log Output -**Flag**: `--verbose` or `-V` -Enable full output for debugging. diff --git a/resources/helpdoc/Welcome_To_JVCS.zh-CN.md b/resources/helpdoc/Welcome_To_JVCS.zh-CN.md deleted file mode 100644 index fc734cf..0000000 --- a/resources/helpdoc/Welcome_To_JVCS.zh-CN.md +++ /dev/null @@ -1,45 +0,0 @@ -> 欢迎使用 `JustEnoughVCS` 命令行程序！ - -## 基本用法 -jvn <子命令> <参数: ?> <标识符: ?> - -## 通用标识符 -`jvn` 提供若干全局标识符，用于命令调试 - -### 语言（Language） -**符号**：`--lang <语言>` -指定程序使用的语言 -可选：en / zh-CN - -### 确认 -**符号**：`--confirm` 或 `-C` -部分命令需要显式确定，该符号将会跳过确认环节 - -### 帮助 -**符号**：`--help` 或 `-h` -打开帮助页面，以查询命令如何使用 -> 当然，您也可以用 `jvn helpdoc <文档>` -> 来打开帮助文档页面 - -### 渲染器覆盖 -**符号**：`--renderer <渲染器>` -指定覆盖渲染器，将结果以指定格式输出 -可选：json / json-pretty / -__ ron / ron-pretty -__ yaml / toml / - -### 无错误输出 -**符号**：`--no-error-logs` -当程序出现问题时，不会输出任何内容 - -### 无进度条 -**符号**：`--no-progress` -关闭进度条显示 - -### 安静输出 -**符号**：`--quiet` 或 `-q` -关闭所有输出，保持终端页面干净，用于自动化脚本 - -### 日志输出 -**符号**：`--verbose` 或 `-V` -启用所有输出，用于追溯程序错误 diff --git a/resources/helpdoc/commands.en.md b/resources/helpdoc/commands.en.md new file mode 100644 index 0000000..3a7cf06 --- /dev/null +++ b/resources/helpdoc/commands.en.md @@ -0,0 +1,45 @@ +> Welcome to the `JustEnoughVCS` CLI! + +## Basic Usage +jvn + +## Global Flags +Global flags for command debugging. + +### Language +**Flag**: `--lang ` +Set program language. +Options: en / zh-CN + +### Confirm +**Flag**: `--confirm` or `-C` +Skip confirmation prompts. + +### Help +**Flag**: `--help` or `-h` +Show command help. +> Or use `jvn helpdoc ` +> for full docs. + +### Renderer Override +**Flag**: `--renderer ` +Override output format. +Options: json / json-pretty / +__ ron / ron-pretty / +__ yaml / toml + +### No Error Output +**Flag**: `--no-error-logs` +Suppress error output. + +### No Progress Bar +**Flag**: `--no-progress` +Disable progress bar. + +### Quiet Output +**Flag**: `--quiet` or `-q` +Suppress all output for scripts. + +### Log Output +**Flag**: `--verbose` or `-V` +Enable full output for debugging. diff --git a/resources/helpdoc/commands.zh-CN.md b/resources/helpdoc/commands.zh-CN.md new file mode 100644 index 0000000..fc734cf --- /dev/null +++ b/resources/helpdoc/commands.zh-CN.md @@ -0,0 +1,45 @@ +> 欢迎使用 `JustEnoughVCS` 命令行程序！ + +## 基本用法 +jvn <子命令> <参数: ?> <标识符: ?> + +## 通用标识符 +`jvn` 提供若干全局标识符，用于命令调试 + +### 语言（Language） +**符号**：`--lang <语言>` +指定程序使用的语言 +可选：en / zh-CN + +### 确认 +**符号**：`--confirm` 或 `-C` +部分命令需要显式确定，该符号将会跳过确认环节 + +### 帮助 +**符号**：`--help` 或 `-h` +打开帮助页面，以查询命令如何使用 +> 当然，您也可以用 `jvn helpdoc <文档>` +> 来打开帮助文档页面 + +### 渲染器覆盖 +**符号**：`--renderer <渲染器>` +指定覆盖渲染器，将结果以指定格式输出 +可选：json / json-pretty / +__ ron / ron-pretty +__ yaml / toml / + +### 无错误输出 +**符号**：`--no-error-logs` +当程序出现问题时，不会输出任何内容 + +### 无进度条 +**符号**：`--no-progress` +关闭进度条显示 + +### 安静输出 +**符号**：`--quiet` 或 `-q` +关闭所有输出，保持终端页面干净，用于自动化脚本 + +### 日志输出 +**符号**：`--verbose` 或 `-V` +启用所有输出，用于追溯程序错误 diff --git a/resources/helpdoc/commands/helpdoc.en.md b/resources/helpdoc/commands/helpdoc.en.md new file mode 100644 index 0000000..05fe5e8 --- /dev/null +++ b/resources/helpdoc/commands/helpdoc.en.md @@ -0,0 +1,5 @@ +> Open Help View + +## Usage +jvn helpdoc # Open a specific article +jvn helpdoc list # List all articles diff --git a/resources/helpdoc/commands/helpdoc.zh-CN.md b/resources/helpdoc/commands/helpdoc.zh-CN.md new file mode 100644 index 0000000..70871a1 --- /dev/null +++ b/resources/helpdoc/commands/helpdoc.zh-CN.md @@ -0,0 +1,5 @@ +> 打开帮助视图 + +## 使用 +jvn helpdoc <文章> # 打开指定文章 +jvn helpdoc list # 列出所有文章 diff --git a/resources/helpdoc/commands/sheetedit.zh-CN.md b/resources/helpdoc/commands/sheetedit.zh-CN.md index d45224b..f897bc9 100644 --- a/resources/helpdoc/commands/sheetedit.zh-CN.md +++ b/resources/helpdoc/commands/sheetedit.zh-CN.md @@ -4,7 +4,7 @@ jvn sheetedit <文件> ## 注意 -它读取按照以下优先级寻找命令行编辑器程序： +它按照以下优先级寻找命令行编辑器程序： 1. JV\_TEXT\_EDITOR 2. EDITOR 3. 若都不存在，使用 `jvii` 回退 diff --git a/resources/helpdoc/commands/workspace.en.md b/resources/helpdoc/commands/workspace.en.md new file mode 100644 index 0000000..000943d --- /dev/null +++ b/resources/helpdoc/commands/workspace.en.md @@ -0,0 +1,14 @@ +> Workspace Management Commands + +## Usage +jvn workspace + +## Subcommands + +### Initialize +Initialize a workspace in the _current directory_ +jvn workspace init + +### Create +Initialize a workspace in a _specified directory_ +jvn workspace create diff --git a/resources/helpdoc/commands/workspace.zh-CN.md b/resources/helpdoc/commands/workspace.zh-CN.md new file mode 100644 index 0000000..3d877fe --- /dev/null +++ b/resources/helpdoc/commands/workspace.zh-CN.md @@ -0,0 +1,14 @@ +> 工作区管理命令 + +## 使用 +jvn workspace <子命令> <参数: ?> + +## 子命令 + +### 初始化工作区 +在_当前目录_初始化一个工作区 +jvn workspace init + +### 创建工作区 +在_指定目录_初始化一个工作区 +jvn workspace create <目录> diff --git a/resources/helpdoc/commands/workspace/create.en.md b/resources/helpdoc/commands/workspace/create.en.md new file mode 100644 index 0000000..bbc201b --- /dev/null +++ b/resources/helpdoc/commands/workspace/create.en.md @@ -0,0 +1,4 @@ +> Initialize a workspace in the _specified directory_ + +## Usage +jvn workspace create diff --git a/resources/helpdoc/commands/workspace/create.zh-CN.md b/resources/helpdoc/commands/workspace/create.zh-CN.md new file mode 100644 index 0000000..d48c100 --- /dev/null +++ b/resources/helpdoc/commands/workspace/create.zh-CN.md @@ -0,0 +1,4 @@ +> 在_指定目录_初始化一个工作区 + +## 使用 +jvn workspace create <目录> diff --git a/resources/helpdoc/commands/workspace/init.en.md b/resources/helpdoc/commands/workspace/init.en.md new file mode 100644 index 0000000..75476dc --- /dev/null +++ b/resources/helpdoc/commands/workspace/init.en.md @@ -0,0 +1,4 @@ +> Initialize a workspace in the _current directory_ + +## Usage +jvn workspace init diff --git a/resources/helpdoc/commands/workspace/init.zh-CN.md b/resources/helpdoc/commands/workspace/init.zh-CN.md new file mode 100644 index 0000000..101c9cf --- /dev/null +++ b/resources/helpdoc/commands/workspace/init.zh-CN.md @@ -0,0 +1,4 @@ +> 在_当前目录_初始化一个工作区 + +## 使用 +jvn workspace init diff --git a/resources/locales/jvn/en.yml b/resources/locales/jvn/en.yml index 7df57fd..ef3b273 100644 --- a/resources/locales/jvn/en.yml +++ b/resources/locales/jvn/en.yml @@ -320,6 +320,7 @@ logger: verbose: setup_progress: Progress bar initialized setup_verbose: Starting `Verbose` mode + disable_helpdoc: Helpdoc Viewer disabled setup_i18n: Setting language to `%{lang}` setup_renderer: Setting renderer to `%{renderer}` no_error_logs: Disabling error output diff --git a/resources/locales/jvn/helpdoc_viewer/en.yml b/resources/locales/jvn/helpdoc_viewer/en.yml index 78acae4..501e946 100644 --- a/resources/locales/jvn/helpdoc_viewer/en.yml +++ b/resources/locales/jvn/helpdoc_viewer/en.yml @@ -4,3 +4,7 @@ helpdoc_viewer: _List_ | ↑↓: Page | ←→/Space: Switch view | Q: Quit content_area_hint: | _Read_ | ↑↓: Page | ←→/Space: Switch view | Q: Quit + + verbose: + no_helpdoc_output: will directly render the output document `%{doc}` + helpdoc_output: will use the help document viewer to view the document `%{doc}` diff --git a/resources/locales/jvn/helpdoc_viewer/zh-CN.yml b/resources/locales/jvn/helpdoc_viewer/zh-CN.yml index 1c169c9..a502483 100644 --- a/resources/locales/jvn/helpdoc_viewer/zh-CN.yml +++ b/resources/locales/jvn/helpdoc_viewer/zh-CN.yml @@ -4,3 +4,7 @@ helpdoc_viewer: _列表_ | ↑↓: 翻页 | ←→/Space: 切换视图 | Q: 退出 content_area_hint: | _阅读_ | ↑↓: 浏览 | ←→/Space: 切换视图 | Q: 退出 + + verbose: + no_helpdoc_output: 将直接渲染输出文章 `%{doc}` + helpdoc_output: 将使用帮助文档查看器查看文章 `%{doc}` diff --git a/resources/locales/jvn/zh-CN.yml b/resources/locales/jvn/zh-CN.yml index ff1b67a..ca8a52e 100644 --- a/resources/locales/jvn/zh-CN.yml +++ b/resources/locales/jvn/zh-CN.yml @@ -318,6 +318,7 @@ logger: verbose: setup_progress: 已初始化进度条 setup_verbose: 启动 `Verbose` 模式 + disable_helpdoc: 帮助文档查看器已禁用 setup_i18n: 设置语言为 `%{lang}` setup_renderer: 设置渲染器为 `%{renderer}` no_error_logs: 禁用错误输出 -- cgit