xb-init 2.2.4__tar.gz → 2.5.1__tar.gz

xb_init-2.5.1/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [release_v0, main, master]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Sync dependencies
+        run: uv sync --extra dev
+
+      - name: Lint (ruff)
+        run: uv run ruff check xb tests
+
+      - name: Test (pytest)
+        run: uv run pytest -q

{xb_init-2.2.4 → xb_init-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: xb-init
-Version: 2.2.4
+Version: 2.5.1
 Summary: Project management tool for UV + FastAPI + Vue3 + Electron desktop applications
 Project-URL: Homepage, https://github.com/xuebli/xb
 Project-URL: Documentation, https://github.com/xuebli/xb#readme
@@ -77,7 +77,6 @@ xb init demo
 
 # 带 sudo 免密配置
 xb init demo --sudoers
-
 # 带内置终端
 xb init demo --terminal
 
@@ -91,7 +90,6 @@ xb init demo --update
 xb init demo --icon ~/icons/app.png
 
 cd demo
-
 # 启动开发环境
 xb dev
 
@@ -102,6 +100,29 @@ xb dev status
 xb dev stop
 ```
 
+### 交互式配置表单
+
+`xb init` 会在创建前显示一个单屏配置表单，回车即按当前值创建：
+
+```
+  xb init demo — 应用配置
+  ↑↓ 移动 · 空格 勾选/取消 · 选中后直接输入 · 回车 开始创建
+  ────────────────────────────────────────────────────────
+❯ [ ] 应用显示名 : Demo
+  [ ] 端口（后端/前端） : 8000 / 8001
+  [ ] sudo 免密  ✘  (Linux 应用内更新需要)
+  [ ] 内置终端  ✘  (Web 终端组件)
+  [ ] 应用内更新  ✘  (自动附带 sudo 免密)
+  [ ] 应用图标 : 使用默认
+  [ ] 跳过依赖安装  ✘  (离线环境可跳过)
+```
+
+- `--name/--port/--sudoers/--terminal/--update/--icon/--skip-install` 传了的参数
+  直接预填进表单并勾上，回车即确认，老用法不受影响
+- 勾选"应用内更新"会自动勾上"sudo 免密"，且后者此时不可单独取消
+- 文本行（显示名/端口/图标）勾选时若仍是默认值则自动清空，直接输入即可
+- stdin 非终端时（脚本/CI 管道调用）自动跳过表单，沿用 CLI 参数
+
 Windows PowerShell 也可以直接运行生成项目脚本：
 
 ```powershell
@@ -121,6 +142,7 @@ Electron 二进制镜像通过 `ELECTRON_MIRROR` 环境变量注入。
 
 > **`xb init` 自动行为**：
 > - 执行 `npm install`（frontend + electron），生成 `package-lock.json`
+>   离线环境可加 `--skip-install` 跳过，稍后手动安装
 >   - 生成的项目用 [nrm](https://github.com/Pana/nrm) 管理 npm 源：`xb init`
 >     安装依赖前与 `build.py` 构建前都会自动 `nrm test` 测速所有内置源并切换
 >     到最快的（未安装 nrm 时自动全局安装）；项目不放 `.npmrc`，npm 源完全由
@@ -138,7 +160,7 @@ Electron 二进制镜像通过 `ELECTRON_MIRROR` 环境变量注入。
 
 | 命令 | 说明 |
 |------|------|
-| `xb init <name> [--sudoers] [--terminal] [--update] [--icon PATH]` | 初始化项目 |
+| `xb init <name> [--name 显示名] [--port 9000] [--sudoers] [--terminal] [--update] [--icon PATH] [--skip-install]` | 初始化项目 |
 | `xb dev [start\|stop\|status]` | 启动/停止/查看开发环境 |
 | `xb build [all\|frontend\|backend\|electron]` | 构建项目 |
 | `xb build -f / -b / -e / -a` | 构建快捷 flag |
@@ -163,7 +185,7 @@ xb init demo --icon ./my-icon.png
 > **[xb/templates/root/docs/自动更新说明.md](xb/templates/root/docs/自动更新说明.md)**
 > （生成的项目会自带 `docs/自动更新说明.md` 与配图）。
 
-`xb init demo --update` 会让生成的项目内置与 [leo_stm32_board_test](../leo_stm32_board_test) 同源的自动更新能力，
+`xb init demo --update` 会让生成的项目内置自动更新能力，
 以飞书云盘的一个文件夹作为发布"货架"：
 
 **生成内容：**
@@ -201,6 +223,7 @@ demo/
 ├── pyproject.toml          # Python 依赖（uv 管理）
 ├── AGENTS.md               # AI 编码助手协作约定
 ├── README.md               # 项目说明（含三种启动方式详解）
+├── LICENSE                 # MIT 许可证
 ├── .gitignore
 ├── backend/                # FastAPI 后端
 │   ├── main.py             # FastAPI 入口（lifespan / CORS / SPA 兜底）

{xb_init-2.2.4 → xb_init-2.5.1}/README.md

@@ -48,7 +48,6 @@ xb init demo
 
 # 带 sudo 免密配置
 xb init demo --sudoers
-
 # 带内置终端
 xb init demo --terminal
 
@@ -62,7 +61,6 @@ xb init demo --update
 xb init demo --icon ~/icons/app.png
 
 cd demo
-
 # 启动开发环境
 xb dev
 
@@ -73,6 +71,29 @@ xb dev status
 xb dev stop
 ```
 
+### 交互式配置表单
+
+`xb init` 会在创建前显示一个单屏配置表单，回车即按当前值创建：
+
+```
+  xb init demo — 应用配置
+  ↑↓ 移动 · 空格 勾选/取消 · 选中后直接输入 · 回车 开始创建
+  ────────────────────────────────────────────────────────
+❯ [ ] 应用显示名 : Demo
+  [ ] 端口（后端/前端） : 8000 / 8001
+  [ ] sudo 免密  ✘  (Linux 应用内更新需要)
+  [ ] 内置终端  ✘  (Web 终端组件)
+  [ ] 应用内更新  ✘  (自动附带 sudo 免密)
+  [ ] 应用图标 : 使用默认
+  [ ] 跳过依赖安装  ✘  (离线环境可跳过)
+```
+
+- `--name/--port/--sudoers/--terminal/--update/--icon/--skip-install` 传了的参数
+  直接预填进表单并勾上，回车即确认，老用法不受影响
+- 勾选"应用内更新"会自动勾上"sudo 免密"，且后者此时不可单独取消
+- 文本行（显示名/端口/图标）勾选时若仍是默认值则自动清空，直接输入即可
+- stdin 非终端时（脚本/CI 管道调用）自动跳过表单，沿用 CLI 参数
+
 Windows PowerShell 也可以直接运行生成项目脚本：
 
 ```powershell
@@ -92,6 +113,7 @@ Electron 二进制镜像通过 `ELECTRON_MIRROR` 环境变量注入。
 
 > **`xb init` 自动行为**：
 > - 执行 `npm install`（frontend + electron），生成 `package-lock.json`
+>   离线环境可加 `--skip-install` 跳过，稍后手动安装
 >   - 生成的项目用 [nrm](https://github.com/Pana/nrm) 管理 npm 源：`xb init`
 >     安装依赖前与 `build.py` 构建前都会自动 `nrm test` 测速所有内置源并切换
 >     到最快的（未安装 nrm 时自动全局安装）；项目不放 `.npmrc`，npm 源完全由
@@ -109,7 +131,7 @@ Electron 二进制镜像通过 `ELECTRON_MIRROR` 环境变量注入。
 
 | 命令 | 说明 |
 |------|------|
-| `xb init <name> [--sudoers] [--terminal] [--update] [--icon PATH]` | 初始化项目 |
+| `xb init <name> [--name 显示名] [--port 9000] [--sudoers] [--terminal] [--update] [--icon PATH] [--skip-install]` | 初始化项目 |
 | `xb dev [start\|stop\|status]` | 启动/停止/查看开发环境 |
 | `xb build [all\|frontend\|backend\|electron]` | 构建项目 |
 | `xb build -f / -b / -e / -a` | 构建快捷 flag |
@@ -134,7 +156,7 @@ xb init demo --icon ./my-icon.png
 > **[xb/templates/root/docs/自动更新说明.md](xb/templates/root/docs/自动更新说明.md)**
 > （生成的项目会自带 `docs/自动更新说明.md` 与配图）。
 
-`xb init demo --update` 会让生成的项目内置与 [leo_stm32_board_test](../leo_stm32_board_test) 同源的自动更新能力，
+`xb init demo --update` 会让生成的项目内置自动更新能力，
 以飞书云盘的一个文件夹作为发布"货架"：
 
 **生成内容：**
@@ -172,6 +194,7 @@ demo/
 ├── pyproject.toml          # Python 依赖（uv 管理）
 ├── AGENTS.md               # AI 编码助手协作约定
 ├── README.md               # 项目说明（含三种启动方式详解）
+├── LICENSE                 # MIT 许可证
 ├── .gitignore
 ├── backend/                # FastAPI 后端
 │   ├── main.py             # FastAPI 入口（lifespan / CORS / SPA 兜底）

{xb_init-2.2.4 → xb_init-2.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "xb-init"
-version = "2.2.4"
+version = "2.5.1"
 description = "Project management tool for UV + FastAPI + Vue3 + Electron desktop applications"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -51,11 +51,11 @@ packages = ["xb"]
 
 [tool.black]
 line-length = 100
-target-version = ['py310']
+target-version = ['py312']
 
 [tool.ruff]
 line-length = 100
-target-version = "py310"
+target-version = "py312"
 
 [tool.ruff.lint]
 select = ["E", "F", "I", "N", "W", "B"]

{xb_init-2.2.4 → xb_init-2.5.1}/tests/test_cli.py

@@ -35,12 +35,11 @@ def _invoke_init(monkeypatch, tmp_path, args, password):
 
 
 def test_update_implies_sudoers(monkeypatch, tmp_path):
-    captured, output = _invoke_init(monkeypatch, tmp_path, ["--update"], "pw123")
+    captured, _output = _invoke_init(monkeypatch, tmp_path, ["--update"], "pw123")
 
     assert captured["enable_update"] is True
     assert captured["enable_sudo"] is True
     assert captured["sudo_password"] == "pw123"
-    assert "自动附带 --sudoers" in output
 
 
 def test_sudoers_alone_still_prompts(monkeypatch, tmp_path):
@@ -60,6 +59,42 @@ def test_plain_init_has_no_sudo(monkeypatch, tmp_path):
     assert captured["sudo_password"] == ""
 
 
+def test_display_name_passed_through(monkeypatch, tmp_path):
+    captured, _ = _invoke_init(
+        monkeypatch, tmp_path, ["--name", "我的应用"], ""
+    )
+
+    assert captured["display_name"] == "我的应用"
+
+
+def test_display_name_defaults_to_none(monkeypatch, tmp_path):
+    captured, _ = _invoke_init(monkeypatch, tmp_path, [], "")
+
+    assert captured["display_name"] is None
+
+
+def test_port_passed_through(monkeypatch, tmp_path):
+    captured, _output = _invoke_init(monkeypatch, tmp_path, ["--port", "9100"], "")
+
+    assert captured["backend_port"] == 9100
+
+
+def test_port_defaults_to_none(monkeypatch, tmp_path):
+    captured, _ = _invoke_init(monkeypatch, tmp_path, [], "")
+
+    assert captured["backend_port"] is None
+
+
+def test_port_out_of_range_rejected(monkeypatch, tmp_path):
+    monkeypatch.setattr(init_module, "get_latest_if_newer", lambda _v: None)
+
+    result = CliRunner().invoke(
+        cli.main, ["init", str(tmp_path / "demo"), "--port", "70000"], input="\n"
+    )
+
+    assert result.exit_code != 0
+
+
 def test_pick_fastest_from_nrm_output():
     output = """  npm ---------- 807 ms
   yarn --------- 795 ms

xb_init-2.5.1/tests/test_config_form.py

@@ -0,0 +1,133 @@
+"""配置表单（ConfigForm）交互逻辑测试：不进键盘循环，直接驱动方法。"""
+
+from xb.utils.config_form import ConfigForm, run_config_form
+
+
+def make_form(cli=None):
+    form = ConfigForm("demo", cli)
+    return form
+
+
+def _cursor_key(form, key):
+    form.cursor = next(
+        i for i, r in enumerate(form.rows) if r["key"] == key)
+
+
+def test_update_checks_sudoers_and_blocks_unchecking():
+    form = make_form()
+    _cursor_key(form, "update")
+    form.toggle()
+    assert form._row("update")["checked"] is True
+    assert form._row("sudoers")["checked"] is True
+
+    # update 勾着时 sudoers 无法单独取消
+    _cursor_key(form, "sudoers")
+    form.toggle()
+    assert form._row("sudoers")["checked"] is True
+    assert form.message  # 有提示
+
+
+def test_sudoers_toggle_without_update():
+    form = make_form()
+    _cursor_key(form, "sudoers")
+    form.toggle()
+    assert form._row("sudoers")["checked"] is True
+    form.toggle()
+    assert form._row("sudoers")["checked"] is False
+    assert not form.message
+
+
+def test_text_row_clears_default_on_first_check():
+    form = make_form()
+    _cursor_key(form, "port")
+    assert form._row("port")["value"] == "8000"
+    form.toggle()
+    assert form._row("port")["checked"] is True
+    assert form._row("port")["value"] == ""  # 默认值清空等待输入
+
+    for ch in "9100":
+        form.feed_char(ch)
+    assert form._row("port")["value"] == "9100"
+
+
+def test_text_row_keeps_custom_value_when_rechecked():
+    form = make_form({"display_name": "机器人"})
+    _cursor_key(form, "display_name")
+    # CLI 预填的值直接勾上
+    assert form._row("display_name")["checked"] is True
+    assert form._row("display_name")["value"] == "机器人"
+
+    form.toggle()  # 取消
+    form.toggle()  # 再勾上，自定义值不被清掉
+    assert form._row("display_name")["value"] == "机器人"
+
+
+def test_collect_unchecked_items_are_none():
+    form = make_form()
+    result = form.collect()
+    assert result["display_name"] is None
+    assert result["port"] is None
+    assert result["sudoers"] is False
+    assert result["terminal"] is False
+    assert result["update"] is False
+    assert result["icon"] is None
+    assert result["skip_install"] is False
+
+
+def test_collect_valid_port():
+    form = make_form()
+    _cursor_key(form, "port")
+    form.toggle()
+    for ch in "9200":
+        form.feed_char(ch)
+    result = form.collect()
+    assert result["port"] == 9200
+    assert result["sudoers"] is False
+
+
+def test_collect_invalid_port_falls_back_to_none():
+    form = make_form()
+    _cursor_key(form, "port")
+    form.toggle()
+    for ch in "99999":
+        form.feed_char(ch)
+    result = form.collect()
+    assert result["port"] is None
+    assert form._row("port")["checked"] is False
+
+
+def test_sudoers_row_hidden_on_windows():
+    import unittest.mock as mock
+
+    with mock.patch("xb.utils.config_form.os.name", "nt"):
+        form = make_form()
+    assert not form._has("sudoers")
+    result = form.collect()
+    assert result["sudoers"] is False
+
+
+def test_backspace_only_on_checked_text_row():
+    form = make_form({"display_name": "abc"})
+    _cursor_key(form, "display_name")
+    form.backspace()
+    assert form._row("display_name")["value"] == "ab"
+
+    _cursor_key(form, "terminal")
+    form.backspace()  # 开关行：无值可删，不报错即可
+
+
+def test_run_config_form_skipped_when_not_tty():
+    result = run_config_form("demo", {
+        "display_name": None,
+        "port": 9100,
+        "sudoers": False,
+        "terminal": True,
+        "update": True,
+        "icon": None,
+        "skip_install": False,
+    })
+    # 非 tty 环境跳过表单，CLI 值原样透传且 update 联动 sudoers
+    assert result["port"] == 9100
+    assert result["sudoers"] is True
+    assert result["terminal"] is True
+    assert result["display_name"] is None

xb_init-2.5.1/tests/test_template_render.py

@@ -0,0 +1,150 @@
+"""模板渲染矩阵测试：sudoers x terminal x update 全组合。
+
+渲染到临时目录，校验：
+- 条件文件按开关出现/缺席（防止模板改坏条件渲染）
+- 所有生成的 .py 能通过 compile() 语法检查（防止模板产出非法 Python）
+- secrets.yaml 权限收紧为 0600（POSIX）
+"""
+
+import itertools
+import json
+import os
+
+import pytest
+
+from xb.utils.template_engine import TemplateEngine
+
+COMBOS = list(itertools.product([False, True], repeat=3))
+
+
+def _render(
+    tmp_path, enable_sudo, enable_terminal, enable_update, display_name=None,
+    backend_port=None,
+):
+    target = tmp_path / "demo"
+    TemplateEngine().render_project(
+        target_dir=target,
+        package_name="demo",
+        display_name=display_name,
+        backend_port=backend_port,
+        enable_sudo=enable_sudo,
+        enable_terminal=enable_terminal,
+        enable_update=enable_update,
+        sudo_password="pw123" if enable_sudo else "",
+    )
+    return target
+
+
+@pytest.mark.parametrize(("enable_sudo", "enable_terminal", "enable_update"), COMBOS)
+def test_render_project_matrix(tmp_path, enable_sudo, enable_terminal, enable_update):
+    target = _render(tmp_path, enable_sudo, enable_terminal, enable_update)
+
+    # 基础骨架始终存在
+    for rel in (
+        "pyproject.toml",
+        "dev.py",
+        "build.py",
+        "README.md",
+        "LICENSE",
+        "AGENTS.md",
+        "backend/main.py",
+        "backend/managers/path_manager.py",
+        "frontend/src/App.vue",
+        "electron/main.js",
+        "configs/global_config.yaml",
+        "version/scripts/version_manager.py",
+    ):
+        assert (target / rel).exists(), f"缺少基础文件 {rel}"
+
+    # 条件文件按开关出现/缺席
+    conditional = {
+        "backend/api/terminal/routes.py": enable_terminal,
+        "frontend/src/components/TerminalPanel.vue": enable_terminal,
+        "frontend/src/composables/useTerminalSessions.js": enable_terminal,
+        "backend/managers/sudoers_manager.py": enable_sudo or enable_update,
+        "backend/api/update/__init__.py": enable_update,
+        "backend/services/updater.py": enable_update,
+        "backend/managers/secret_obfuscator.py": enable_update,
+        "scripts/feishu_upload.py": enable_update,
+        "frontend/src/composables/useUpdate.js": enable_update,
+    }
+    for rel, should_exist in conditional.items():
+        assert (target / rel).exists() is should_exist, f"{rel} 存在性与开关不符"
+
+    # secrets.yaml 仅在 sudo + 提供密码时生成
+    secrets = target / "configs" / "secrets.yaml"
+    assert secrets.exists() is (enable_sudo and bool("pw123"))
+    if secrets.exists() and os.name != "nt":
+        assert secrets.stat().st_mode & 0o777 == 0o600, "secrets.yaml 应为 0600 权限"
+
+    # 生成的所有 Python 文件必须是合法语法（含带 jinja 条件的模板产物）
+    for py in target.rglob("*.py"):
+        source = py.read_text(encoding="utf-8")
+        compile(source, str(py), "exec")
+
+
+def test_render_project_main_py_switches(tmp_path):
+    """main.py 的路由注册随开关变化。"""
+    plain = _render(tmp_path / "a", False, False, False)
+    main_plain = (plain / "backend" / "main.py").read_text(encoding="utf-8")
+    assert "terminal_router" not in main_plain
+    assert "update_router" not in main_plain
+    assert "sudoers_manager" not in main_plain
+
+    full = _render(tmp_path / "b", True, True, True)
+    main_full = (full / "backend" / "main.py").read_text(encoding="utf-8")
+    assert "terminal_router" in main_full
+    assert "update_router" in main_full
+    assert "sudoers_manager" in main_full
+
+
+def test_display_name_defaults_to_capitalized_package(tmp_path):
+    target = _render(tmp_path, False, False, False)
+    assert "<title>Demo</title>" in (target / "frontend" / "index.html").read_text(
+        encoding="utf-8"
+    )
+
+
+def test_ports_written_to_global_config(tmp_path):
+    """--port 指定后端端口时，前端端口自动 +1；不传时用默认值。"""
+    target = _render(tmp_path, False, False, False, backend_port=9100)
+    config = (target / "configs" / "global_config.yaml").read_text(encoding="utf-8")
+    assert "backend: 9100" in config
+    assert "frontend: 9101" in config
+
+    default = _render(tmp_path / "d", False, False, False)
+    default_config = (default / "configs" / "global_config.yaml").read_text(
+        encoding="utf-8"
+    )
+    assert "backend: 8000" in default_config
+    assert "frontend: 5173" in default_config
+
+
+def test_display_name_with_quotes_and_chinese(tmp_path):
+    """显示名含引号/中文/空格时，各产物文件必须仍然合法。"""
+    display_name = '我的 "Cool" App'
+    target = _render(tmp_path, True, False, True, display_name=display_name)
+
+    # HTML 文案直接使用显示名
+    assert f"<title>{display_name}</title>" in (
+        target / "frontend" / "index.html"
+    ).read_text(encoding="utf-8")
+
+    # electron/package.json 必须是合法 JSON 且 description 正确
+    pkg = json.loads((target / "electron" / "package.json").read_text(encoding="utf-8"))
+    assert pkg["description"] == display_name
+    # 技术标识不被显示名污染
+    assert pkg["name"] == "demo"
+    assert pkg["build"]["productName"] == "Demo"
+
+    # Python 产物可编译且标题正确（tojson 转义后的字面量）
+    main_py = (target / "backend" / "main.py").read_text(encoding="utf-8")
+    compile(main_py, "main.py", "exec")
+    assert f"title={json.dumps(display_name, ensure_ascii=False)}" in main_py
+
+    # pyproject 的 TOML description 合法（TOML basic string 与 JSON 转义兼容）
+    pyproject = (target / "pyproject.toml").read_text(encoding="utf-8")
+    assert 'description = "我的 \\"Cool\\" App' in pyproject
+
+    # README 标题使用显示名
+    assert f"# {display_name}" in (target / "README.md").read_text(encoding="utf-8")