vermink 0.1.0__tar.gz

vermink-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TSVMV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vermink-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: vermink
+Version: 0.1.0
+Summary: Zero-dependency terminal theme engine: compile text themes into Zsh/Bash/PowerShell prompts
+License-Expression: MIT
+Keywords: terminal,prompt,theme,zsh,bash,powershell
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# vermink
+
+零依赖终端美化引擎：把纯文本主题编译成 Zsh / Bash / PowerShell 的提示符与状态栏。
+
+## 安装
+
+```bash
+pip install vermink
+```
+
+## 快速开始
+
+```bash
+# 生成默认 dark 主题并安装到当前 shell
+vermink init
+
+# 预览主题效果（不修改任何文件）
+vermink preview dark
+
+# 列出所有主题
+vermink list
+```
+
+## 子命令
+
+| 命令 | 说明 |
+| --- | --- |
+| `vermink init [--shell zsh\|bash\|pwsh]` | 生成默认 dark 主题并安装 |
+| `vermink preview <主题名> [--plain]` | 终端预览渲染效果 |
+| `vermink install <主题名> --shell zsh\|bash\|pwsh` | 安装到 shell 启动文件（自动备份） |
+| `vermink uninstall --shell zsh\|bash\|pwsh` | 卸载并还原备份 |
+| `vermink list [--shell zsh\|bash\|pwsh]` | 列出主题与当前生效主题 |
+| `vermink show <主题名>` | 打印主题源配置 |
+
+## 主题文件
+
+主题文件使用 INI 格式，包含以下区块：
+
+```ini
+## vermink theme mytheme
+
+[palette]
+user = bright_green
+host = bright_cyan
+dir = bright_blue
+git = bright_magenta
+git_state = yellow
+venv = bright_green
+time = grey
+exit_code = red
+
+[prompt]
+user
+host
+dir
+git
+git_state
+
+[status]
+venv
+time
+exit_code
+
+[format]
+user = user
+host = host
+dir = dir
+git = git
+git_state = git_state
+venv = venv
+time = time
+exit_code = exit_code
+```
+
+### 区块说明
+
+- **[palette]**：定义颜色名称，支持命名色（如 `red`、`bright_green`）、256 色（如 `208`）、HEX 色（如 `#ff8800`）、修饰符（如 `bold`、`dim`）
+- **[prompt]**：左侧提示符显示的片段列表
+- **[status]**：状态栏显示的片段列表（Zsh 为 RPROMPT，Bash/Pwsh 合并到主提示符）
+- **[format]**：将片段映射到配色名，设为 `none` 表示不着色
+
+### 可用片段
+
+| 片段 | 说明 |
+| --- | --- |
+| `user` | 当前用户名 |
+| `host` | 主机名 |
+| `dir` | 当前目录（~ 缩写） |
+| `git` | Git 分支名 |
+| `git_state` | Git 状态（`*` 有修改，`+` 有未跟踪文件） |
+| `venv` | 虚拟环境名 |
+| `time` | 当前时间（HH:MM） |
+| `exit_code` | 上一条命令的退出码（非零时显示） |
+
+### 内置主题
+
+- **dark**：深色终端主题（默认）
+- **light**：浅色终端主题
+
+## 自定义主题
+
+```bash
+# 保存主题到配置目录
+vermink init --theme dark --name mytheme --no-install
+
+# 编辑主题
+vim ~/.config/vermink/themes/mytheme.conf
+
+# 安装自定义主题
+vermink install mytheme --shell zsh
+```
+
+## Shell 支持
+
+| Shell | 提示符 | 状态栏 |
+| --- | --- | --- |
+| Zsh | PS1 | RPROMPT（右侧） |
+| Bash | PS1（PROMPT_COMMAND） | 合并到主提示符 |
+| PowerShell | prompt 函数 | 合并到主提示符 |
+
+## 开发
+
+```bash
+# 安装开发依赖
+pip install -e ".[test]"
+
+# 运行测试
+pytest tests/
+
+# 代码检查
+ruff check .
+```
+
+## 许可证
+
+MIT

vermink-0.1.0/README.md

@@ -0,0 +1,136 @@
+# vermink
+
+零依赖终端美化引擎：把纯文本主题编译成 Zsh / Bash / PowerShell 的提示符与状态栏。
+
+## 安装
+
+```bash
+pip install vermink
+```
+
+## 快速开始
+
+```bash
+# 生成默认 dark 主题并安装到当前 shell
+vermink init
+
+# 预览主题效果（不修改任何文件）
+vermink preview dark
+
+# 列出所有主题
+vermink list
+```
+
+## 子命令
+
+| 命令 | 说明 |
+| --- | --- |
+| `vermink init [--shell zsh\|bash\|pwsh]` | 生成默认 dark 主题并安装 |
+| `vermink preview <主题名> [--plain]` | 终端预览渲染效果 |
+| `vermink install <主题名> --shell zsh\|bash\|pwsh` | 安装到 shell 启动文件（自动备份） |
+| `vermink uninstall --shell zsh\|bash\|pwsh` | 卸载并还原备份 |
+| `vermink list [--shell zsh\|bash\|pwsh]` | 列出主题与当前生效主题 |
+| `vermink show <主题名>` | 打印主题源配置 |
+
+## 主题文件
+
+主题文件使用 INI 格式，包含以下区块：
+
+```ini
+## vermink theme mytheme
+
+[palette]
+user = bright_green
+host = bright_cyan
+dir = bright_blue
+git = bright_magenta
+git_state = yellow
+venv = bright_green
+time = grey
+exit_code = red
+
+[prompt]
+user
+host
+dir
+git
+git_state
+
+[status]
+venv
+time
+exit_code
+
+[format]
+user = user
+host = host
+dir = dir
+git = git
+git_state = git_state
+venv = venv
+time = time
+exit_code = exit_code
+```
+
+### 区块说明
+
+- **[palette]**：定义颜色名称，支持命名色（如 `red`、`bright_green`）、256 色（如 `208`）、HEX 色（如 `#ff8800`）、修饰符（如 `bold`、`dim`）
+- **[prompt]**：左侧提示符显示的片段列表
+- **[status]**：状态栏显示的片段列表（Zsh 为 RPROMPT，Bash/Pwsh 合并到主提示符）
+- **[format]**：将片段映射到配色名，设为 `none` 表示不着色
+
+### 可用片段
+
+| 片段 | 说明 |
+| --- | --- |
+| `user` | 当前用户名 |
+| `host` | 主机名 |
+| `dir` | 当前目录（~ 缩写） |
+| `git` | Git 分支名 |
+| `git_state` | Git 状态（`*` 有修改，`+` 有未跟踪文件） |
+| `venv` | 虚拟环境名 |
+| `time` | 当前时间（HH:MM） |
+| `exit_code` | 上一条命令的退出码（非零时显示） |
+
+### 内置主题
+
+- **dark**：深色终端主题（默认）
+- **light**：浅色终端主题
+
+## 自定义主题
+
+```bash
+# 保存主题到配置目录
+vermink init --theme dark --name mytheme --no-install
+
+# 编辑主题
+vim ~/.config/vermink/themes/mytheme.conf
+
+# 安装自定义主题
+vermink install mytheme --shell zsh
+```
+
+## Shell 支持
+
+| Shell | 提示符 | 状态栏 |
+| --- | --- | --- |
+| Zsh | PS1 | RPROMPT（右侧） |
+| Bash | PS1（PROMPT_COMMAND） | 合并到主提示符 |
+| PowerShell | prompt 函数 | 合并到主提示符 |
+
+## 开发
+
+```bash
+# 安装开发依赖
+pip install -e ".[test]"
+
+# 运行测试
+pytest tests/
+
+# 代码检查
+ruff check .
+```
+
+## 许可证
+
+MIT

vermink-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vermink"
+version = "0.1.0"
+description = "Zero-dependency terminal theme engine: compile text themes into Zsh/Bash/PowerShell prompts"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+keywords = ["terminal", "prompt", "theme", "zsh", "bash", "powershell"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+
+[project.scripts]
+vermink = "vermink.cli:main"
+
+[project.optional-dependencies]
+test = ["pytest"]
+
+[tool.setuptools.packages.find]
+include = ["vermink*"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+ignore = ["B905"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["E501"]

vermink-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vermink-0.1.0/tests/test_backends.py

@@ -0,0 +1,155 @@
+"""Tests for vermink.backends module."""
+
+import pytest
+
+from vermink.backends import bash, preview, pwsh, zsh
+from vermink.config import parse
+from vermink.themes import BUILT_INS
+
+
+@pytest.fixture
+def dark():
+    return parse(BUILT_INS["dark"], name="dark")
+
+
+@pytest.fixture
+def light():
+    return parse(BUILT_INS["light"], name="light")
+
+
+@pytest.fixture
+def minimal():
+    return parse("[palette]\nuser = green\n[prompt]\nuser\n", name="minimal")
+
+
+class TestZsh:
+    def test_name(self):
+        assert zsh.name == "zsh"
+
+    def test_render_contains_ps1(self, dark):
+        text = zsh.render(dark)
+        assert "PS1=" in text
+
+    def test_render_contains_rprompt(self, dark):
+        text = zsh.render(dark)
+        assert "RPROMPT=" in text
+
+    def test_render_has_precmd(self, dark):
+        text = zsh.render(dark)
+        assert "_j_precmd" in text
+        assert "add-zsh-hook" in text
+
+    def test_render_has_functions(self, dark):
+        text = zsh.render(dark)
+        assert "__j_git_state" in text
+        assert "__j_venv" in text
+        assert "__j_exit_code" in text
+
+    def test_render_minimal(self, minimal):
+        text = zsh.render(minimal)
+        assert "PS1=" in text
+        assert "RPROMPT=" not in text
+
+    def test_no_status_no_rprompt(self, minimal):
+        text = zsh.render(minimal)
+        assert "RPROMPT" not in text
+
+
+class TestBash:
+    def test_name(self):
+        assert bash.name == "bash"
+
+    def test_render_contains_ps1(self, dark):
+        text = bash.render(dark)
+        assert "PS1=" in text
+
+    def test_render_contains_prompt_command(self, dark):
+        text = bash.render(dark)
+        assert "PROMPT_COMMAND=" in text
+
+    def test_render_has_functions(self, dark):
+        text = bash.render(dark)
+        assert "__j_git_branch" in text
+        assert "__j_git_state" in text
+        assert "__j_update_ps1" in text
+
+    def test_render_has_exit_code_capture(self, dark):
+        text = bash.render(dark)
+        assert "_J_EXIT=$?" in text
+
+
+class TestPwsh:
+    def test_name(self):
+        assert pwsh.name == "pwsh"
+
+    def test_render_has_prompt_function(self, dark):
+        text = pwsh.render(dark)
+        assert "function prompt" in text
+
+    def test_render_has_default_color(self, dark):
+        text = pwsh.render(dark)
+        assert "$__j_default_color" in text
+
+    def test_render_has_psreadline(self, dark):
+        text = pwsh.render(dark)
+        assert "Set-PSReadLineOption" in text
+
+    def test_render_has_exit_capture(self, dark):
+        text = pwsh.render(dark)
+        assert "$__j_last_exit = $LASTEXITCODE" in text
+
+    def test_render_uses_consolecolor(self, dark):
+        text = pwsh.render(dark)
+        assert "[ConsoleColor]::" in text
+
+    def test_render_has_functions(self, dark):
+        text = pwsh.render(dark)
+        assert "__j_set_color" in text
+        assert "__j_seg" in text
+        assert "__j_sep" in text
+
+
+class TestPreview:
+    def test_plain_output(self, dark):
+        text = preview.render(dark, plain=True)
+        assert "预览渲染" in text
+        assert "\x1b[" not in text
+
+    def test_contains_sample_data(self, dark):
+        text = preview.render(dark, plain=True)
+        assert "main" in text
+        assert "demo" in text
+
+    def test_contains_status_info(self, dark):
+        text = preview.render(dark, plain=True)
+        assert "x1" in text
+
+    def test_color_disabled_in_pipe(self, dark):
+        assert preview.color_enabled() is False
+
+    def test_note_present(self, dark):
+        text = preview.render(dark, plain=True)
+        assert "未修改任何文件" in text
+
+    def test_status_alignment_note(self, dark):
+        text = preview.render(dark, plain=True)
+        assert "RPROMPT" in text or "状态栏" in text
+
+
+class TestBackendConsistency:
+    def test_all_backends_render_same_segments(self, dark):
+        for backend in (zsh, bash, pwsh):
+            text = backend.render(dark)
+            assert len(text) > 0
+
+    def test_all_backends_handle_empty_status(self, minimal):
+        for backend in (zsh, bash, pwsh):
+            text = backend.render(minimal)
+            assert len(text) > 0
+
+    def test_all_builtins_render(self):
+        for name, source_text in BUILT_INS.items():
+            theme = parse(source_text, name=name)
+            for backend in (zsh, bash, pwsh):
+                text = backend.render(theme)
+                assert len(text) > 0, f"{backend.name} failed for {name}"

vermink-0.1.0/tests/test_cli.py

@@ -0,0 +1,98 @@
+"""Tests for vermink.cli module."""
+
+import pytest
+
+from vermink.cli import main
+
+
+class TestVersion:
+    def test_version(self, capsys):
+        with pytest.raises(SystemExit) as exc:
+            main(["--version"])
+        assert exc.value.code == 0
+        assert "0.1.0" in capsys.readouterr().out
+
+
+class TestList:
+    def test_list_includes_builtins(self, capsys):
+        main(["list", "--shell", "zsh"])
+        out = capsys.readouterr().out
+        assert "dark" in out
+        assert "light" in out
+        assert "内置" in out
+
+    def test_list_no_rc(self, capsys, tmp_path):
+        main(["list", "--shell", "zsh", "--rc", str(tmp_path / ".zshrc")])
+        out = capsys.readouterr().out
+        assert "未安装" in out
+
+
+class TestShow:
+    def test_show_builtin(self, capsys):
+        main(["show", "dark"])
+        out = capsys.readouterr().out
+        assert "[palette]" in out
+        assert "bright_green" in out
+
+    def test_show_unknown(self, capsys):
+        result = main(["show", "nonexistent"])
+        assert result == 1
+        assert "找不到" in capsys.readouterr().err
+
+
+class TestPreview:
+    def test_preview_plain(self, capsys):
+        main(["preview", "dark", "--plain"])
+        out = capsys.readouterr().out
+        assert "预览渲染" in out
+        assert "main" in out
+
+
+class TestInit:
+    def test_init_no_install(self, capsys, tmp_path):
+        theme_dir = tmp_path / "themes"
+        theme_dir.mkdir()
+        result = main(["init", "--theme", "dark", "--no-install", "--dir", str(theme_dir)])
+        assert result == 0
+        out = capsys.readouterr().out
+        assert "已保存" in out
+
+    def test_init_with_install(self, capsys, tmp_path):
+        rc = tmp_path / ".zshrc"
+        result = main(["init", "--theme", "dark", "--shell", "zsh", "--rc", str(rc)])
+        assert result == 0
+        assert rc.exists()
+        out = capsys.readouterr().out
+        assert "已安装" in out
+
+
+class TestInstall:
+    def test_install_theme(self, capsys, tmp_path):
+        rc = tmp_path / ".zshrc"
+        result = main(["install", "dark", "--shell", "zsh", "--rc", str(rc)])
+        assert result == 0
+        assert rc.exists()
+        out = capsys.readouterr().out
+        assert "已安装" in out
+
+
+class TestUninstall:
+    def test_uninstall(self, capsys, tmp_path):
+        rc = tmp_path / ".zshrc"
+        rc.write_text("# >>> vermink theme theme=dark\ncontent\n# <<< vermink theme\n")
+        result = main(["uninstall", "--shell", "zsh", "--rc", str(rc)])
+        assert result == 0
+        out = capsys.readouterr().out
+        assert "已卸载" in out
+
+
+class TestErrorHandling:
+    def test_unknown_command(self, capsys):
+        with pytest.raises(SystemExit) as exc:
+            main(["badcmd"])
+        assert exc.value.code == 2
+
+    def test_missing_theme_arg(self, capsys):
+        with pytest.raises(SystemExit) as exc:
+            main(["show"])
+        assert exc.value.code == 2

vermink-0.1.0/tests/test_colors.py

@@ -0,0 +1,100 @@
+"""Tests for vermink.colors module."""
+
+import pytest
+
+from vermink.colors import (
+    COLORS,
+    MODIFIERS,
+    POWERSHELL_COLORS,
+    name_for_sgr,
+    powershell_color,
+    resolve,
+)
+
+
+class TestResolve:
+    def test_named_color(self):
+        assert resolve("red") == "31"
+
+    def test_bright_color(self):
+        assert resolve("bright_green") == "92"
+
+    def test_modifier(self):
+        assert resolve("bold") == "1"
+
+    def test_256_color(self):
+        assert resolve("208") == "38;5;208"
+
+    def test_hex_color(self):
+        assert resolve("#ff8800") == "38;2;255;136;0"
+
+    def test_composite(self):
+        assert resolve("bright_blue,bold") == "94;1"
+
+    def test_empty(self):
+        assert resolve("") == ""
+
+    def test_none_keyword(self):
+        assert resolve("none") == ""
+
+    def test_case_insensitive(self):
+        assert resolve("RED") == "31"
+        assert resolve("Bright_Green") == "92"
+
+    def test_unknown_color_raises(self):
+        with pytest.raises(Exception, match="未知颜色"):
+            resolve("not_a_color")
+
+    def test_invalid_hex_raises(self):
+        with pytest.raises(Exception, match="未知颜色"):
+            resolve("#gg0000")
+
+    def test_context_in_error(self):
+        with pytest.raises(Exception, match="配色 foo"):
+            resolve("bad", context="配色 foo")
+
+    def test_path_and_line_in_error(self):
+        with pytest.raises(Exception, match="theme.conf:42"):
+            resolve("bad", path="theme.conf", line=42)
+
+
+class TestPowershellColor:
+    def test_named_color(self):
+        assert powershell_color("red") == "DarkRed"
+
+    def test_bright_color(self):
+        assert powershell_color("bright_green") == "Green"
+
+    def test_alias(self):
+        assert powershell_color("grey") == "Gray"
+
+    def test_unknown_returns_empty(self):
+        assert powershell_color("208") == ""
+
+    def test_hex_returns_empty(self):
+        assert powershell_color("#ff0000") == ""
+
+    def test_composite_returns_first(self):
+        assert powershell_color("bright_blue,bold") == "Blue"
+
+
+class TestNameForSgr:
+    def test_basic_colors(self):
+        assert name_for_sgr("31") == "red"
+        assert name_for_sgr("92") == "bright_green"
+
+    def test_unknown_returns_empty(self):
+        assert name_for_sgr("999") == ""
+
+    def test_composite_returns_empty(self):
+        assert name_for_sgr("94;1") == ""
+
+
+class TestConstants:
+    def test_colors_is_subset_of_powershell(self):
+        for name in COLORS:
+            assert name in POWERSHELL_COLORS, f"{name} missing from POWERSHELL_COLORS"
+
+    def test_modifiers_not_in_colors(self):
+        for name in MODIFIERS:
+            assert name not in COLORS