precis-cli 0.1.3__py3-none-any.whl

app/cli/shell/commands/config/base.py

@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2026 Precis Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# backend/app/cli/shell/commands/config/base.py
+"""
+@fileoverview Config 命令共享工具模块
+
+功能概述:
+- 提供配置命令的共享模板常量
+- 内置 project、constraint、pattern 配置模板
+
+架构设计:
+- PROJECT_TEMPLATE/CONSTRAINT_TEMPLATE/PATTERNS_TEMPLATE: 字符串模板常量
+"""
+
+# 配置模板
+# 注意：模板中的 {project_name} 由 init.py 以字符串 replace 方式填充，
+# 不要使用 str.format（正则模板含 {2,} 等花括号字面量会被误当替换字段）。
+PROJECT_TEMPLATE = """# Precis 项目清单（V2 格式）
+# 项目基本信息：id 为项目标识符，name 为显示名称
+version: 2
+project:
+  id: "{project_name}"
+  name: "{project_name}"
+
+# Schema/约束/正则等资源按需登记在下列列表（path 相对项目根）：
+# schemas:
+#   - id: <uuid>
+#     path: schemas/<uuid>.schema.yaml
+# constraints: []
+# regex_nodes: []
+# transforms: []
+# manual_data: []
+"""
+
+CONSTRAINT_TEMPLATE = """# Precis 约束配置文件
+# 定义数据校验规则
+
+constraints:
+  - name: unique_id
+    type: unique
+    columns:
+      - id
+    message: "ID 必须唯一"
+
+  - name: not_null_name
+    type: not_null
+    columns:
+      - name
+    message: "名称不能为空"
+"""
+
+PATTERNS_TEMPLATE = """# Precis 正则模式配置文件
+# 定义可复用的正则表达式
+
+patterns:
+  - name: email
+    pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
+    description: "邮箱地址格式"
+
+  - name: phone
+    pattern: "^1[3-9]\\d{9}$"
+    description: "中国手机号码"
+
+  - name: id_card
+    pattern: "(^\\d{15}$)|(^\\d{18}$)|(^\\d{17}(\\d|X|x)$)"
+    description: "身份证号码"
+"""

app/cli/shell/commands/config/check.py

@@ -0,0 +1,246 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2026 Precis Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# backend/app/cli/shell/commands/config/check.py
+"""
+@fileoverview 配置检查命令模块
+
+功能概述:
+- 提供 config check 子命令检查项目 YAML 配置文件语法
+- 支持单文件检查与全项目扫描
+- 格式化 YAML 语法错误为友好提示（显示行号、代码片段、建议）
+
+架构设计:
+- ConfigCheckCommand 继承 Command 基类
+- execute() 根据参数决定单文件检查或全项目扫描
+- _check_file(): 使用 yaml.safe_load 验证文件，返回 (是否有效, 错误信息)
+- _format_yaml_error(): 将 YAML 解析错误转换为友好的中文提示
+
+输入示例:
+    config check
+    config check project.precis.yaml
+    config check --all
+
+输出示例:
+    CommandResult.ok("✓ 所有 5 个配置文件格式正确")
+    CommandResult.error("发现 2 个配置文件格式错误: ...")
+"""
+
+import os
+
+from rich.console import Console
+from rich.syntax import Syntax
+
+from app.cli.shared_services.config_ops import YamlCheckResult, check_yaml_syntax, find_config_file
+from app.cli.shell.commands.base import Command, CommandResult, ProjectContext
+from app.cli.shell.formatter import _supports_unicode
+
+_CHECK_MARK = "\u2713" if _supports_unicode() else "[OK]"
+_CROSS_MARK = "\u2717" if _supports_unicode() else "[FAIL]"
+
+_console = Console()
+
+
+class ConfigCheckCommand(Command):
+    """检查配置命令。
+
+    验证项目中的 YAML 配置文件语法是否正确。
+    """
+
+    def __init__(self) -> None:
+        super().__init__("check")
+
+    @property
+    def description(self) -> str:
+        return "检查配置文件的语法格式"
+
+    @property
+    def usage(self) -> str:
+        return "config check [config_file] [--all]"
+
+    def execute(self, args: list[str], context: ProjectContext) -> CommandResult:
+        """执行配置检查命令。
+
+        Args:
+            args: 命令参数列表，可能包含文件名或 --all 标志
+            context: 项目上下文
+
+        Returns:
+            检查结果，成功表示所有文件格式正确
+        """
+        project_path = context.project_path
+        if project_path is None:
+            return CommandResult.error("未打开项目，请先使用 'open <path>' 命令打开项目")
+
+        # 解析参数
+        show_all = "--all" in args
+        if show_all:
+            args = [a for a in args if a != "--all"]
+
+        # 如果指定了文件，只验证该文件
+        if args:
+            config_file = args[0]
+            config_path = find_config_file(project_path, config_file)
+
+            if not config_path:
+                return CommandResult.error(f"配置文件不存在: {config_file}")
+
+            # 显示相对路径
+            rel_path = os.path.relpath(config_path, project_path)
+            return self._check_single_file(config_path, rel_path)
+
+        # 否则验证所有 YAML 文件
+        all_files = []
+        for root, _, files in os.walk(project_path):
+            # 跳过隐藏目录
+            if any(part.startswith(".") for part in root.split(os.sep)):
+                continue
+            for f in files:
+                if f.endswith((".yaml", ".yml")):
+                    rel_path = os.path.relpath(os.path.join(root, f), project_path)
+                    all_files.append(rel_path)
+
+        results = []
+        valid_count = 0
+        invalid_count = 0
+
+        for config_file in sorted(all_files):
+            config_path = os.path.join(project_path, config_file)
+            result, error_msg = self._check_file(config_path)
+            if result:
+                valid_count += 1
+                if show_all:
+                    results.append(f"✓ {config_file}")
+            else:
+                invalid_count += 1
+                results.append(f"✗ {config_file}")
+                if error_msg:
+                    # 显示简化的错误信息（位置和问题）
+                    error_lines = error_msg.split("\n")
+                    # 提取位置行、代码片段、问题行
+                    for line in error_lines:
+                        if line.startswith("位置:") or line.startswith("问题:") or line.startswith("提示:"):
+                            results.append(f"    {line}")
+                        # 显示代码片段的指示行（包含 >>> 的那一行）
+                        elif ">>>" in line:
+                            results.append(f"    {line}")
+                            # 也显示下一行（箭头）
+                            idx = error_lines.index(line)
+                            if idx + 1 < len(error_lines) and "^" in error_lines[idx + 1]:
+                                results.append(f"    {error_lines[idx + 1]}")
+
+        if invalid_count == 0:
+            return CommandResult.ok(f"✓ 所有 {valid_count} 个配置文件格式正确")
+
+        # 有错误时只显示错误文件（除非指定 --all）
+        output_lines = [f"[bold]\n发现 {invalid_count} 个配置文件格式错误:[/bold]"]
+        output_lines.extend(results)
+        if show_all:
+            output_lines.append(f"\n总计: {valid_count} 个有效, {invalid_count} 个无效")
+        else:
+            output_lines.append(f"\n（共检查 {valid_count + invalid_count} 个文件，使用 --all 查看全部）")
+
+        return CommandResult.error("\n".join(output_lines))
+
+    def _check_single_file(self, config_path: str, config_file: str) -> CommandResult:
+        result, error_msg = self._check_file(config_path)
+        if result:
+            return CommandResult.ok(f"{_CHECK_MARK} {config_file} 格式正确")
+        else:
+            output = f"{_CROSS_MARK} {config_file} 格式错误"
+            if error_msg:
+                output += f"\n\n错误详情:\n{error_msg}"
+            return CommandResult.error(output)
+
+    def _check_file(self, config_path: str) -> tuple[bool, str | None]:
+        """检查文件，返回 (是否有效, 错误信息)。
+
+        语法检查与错误收集委托 shared_services.check_yaml_syntax（纯逻辑），
+        rich.Syntax 高亮等渲染留在本类 _render_yaml_error。
+
+        Args:
+            config_path: 文件的完整路径
+
+        Returns:
+            tuple: (bool, str|None) - 是否有效，错误信息（如果无效）
+        """
+        filename = os.path.basename(config_path)
+
+        try:
+            with open(config_path, encoding="utf-8") as f:
+                content = f.read()
+        except Exception as e:
+            return False, f"读取文件失败: {e}"
+
+        # 语法检查 + 错误收集委托 shared_services（CLI/TUI 同源）
+        result = check_yaml_syntax(content, filename)
+        if result.valid:
+            return True, None
+        # 渲染部分留在 CLI 层（rich.Syntax 高亮是 CLI 专属 UI）
+        return False, self._render_yaml_error(result, content)
+
+    def _render_yaml_error(self, result: YamlCheckResult, content: str) -> str:
+        """渲染 YAML 检查结果为友好提示（CLI 专属 UI）。
+
+        纯逻辑（错误位置/问题/建议收集）已由 shared_services.check_yaml_syntax 完成，
+        本方法只负责 rich.Syntax 高亮与文本拼接。
+
+        Args:
+            result: check_yaml_syntax 返回的纯逻辑结果
+            content: 文件原始内容（用于 rich.Syntax 高亮取行）
+
+        Returns:
+            格式化的错误提示字符串
+        """
+        lines: list[str] = []
+        content_lines = content.split("\n")
+
+        # 位置
+        if result.line_no is not None:
+            lines.append(f"位置: 第 {result.line_no} 行")
+
+            # 使用 rich.syntax 高亮代码片段（行号 0-based 用于 highlight_lines）
+            error_line_no = result.line_no - 1  # 转回 0-based
+            context_start = max(0, error_line_no - 2)
+            context_end = min(len(content_lines), error_line_no + 3)
+            snippet = "\n".join(content_lines[context_start:context_end])
+            start_line = context_start + 1
+
+            lines.append("")
+            lines.append("代码片段:")
+            syntax = Syntax(
+                snippet,
+                "yaml",
+                start_line=start_line,
+                line_numbers=True,
+                highlight_lines={error_line_no + 1},
+                theme="monokai",
+            )
+            with _console.capture() as capture:
+                _console.print(syntax)
+            lines.append(capture.get())
+        else:
+            lines.append("位置: 未知")
+
+        # 问题（已由 check_yaml_syntax 简化，可能含上下文）
+        if result.problem:
+            lines.append(f"问题: {result.problem}")
+
+        # 修复建议
+        if result.hint:
+            lines.append("")
+            lines.append(f"提示: {result.hint}")
+
+        return "\n".join(lines)

app/cli/shell/commands/config/edit.py

@@ -0,0 +1,148 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2026 Precis Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# backend/app/cli/shell/commands/config/edit.py
+"""
+@fileoverview 配置编辑命令模块
+
+功能概述:
+- 提供 config edit 子命令调用系统编辑器修改配置文件
+- 自动检测 EDITOR/VISUAL 环境变量，支持跨平台编辑器
+- 未指定文件时默认编辑 project.precis.yaml
+
+架构设计:
+- ConfigEditCommand 继承 Command 基类
+- _get_editor(): 按优先级查找合适的编辑器
+- 使用 subprocess.run 启动编辑器进程，等待用户关闭
+
+输入示例:
+    config edit
+    config edit constraints.yaml
+
+输出示例:
+    CommandResult.ok("已保存配置文件: project.precis.yaml")
+    CommandResult.error("未找到编辑器: notepad")
+"""
+
+import os
+import subprocess
+import sys
+
+from app.cli.shared_services.config_ops import find_config_file
+from app.cli.shell.commands.base import Command, CommandResult, ProjectContext
+from app.cli.shell.exceptions import EditorError
+
+
+class ConfigEditCommand(Command):
+    """编辑配置命令。
+
+    调用系统默认编辑器打开项目配置文件。
+    """
+
+    def __init__(self) -> None:
+        super().__init__("edit")
+
+    @property
+    def description(self) -> str:
+        return "使用编辑器编辑项目的配置文件"
+
+    @property
+    def usage(self) -> str:
+        return "config edit [config_file]"
+
+    def execute(self, args: list[str], context: ProjectContext) -> CommandResult:
+        """执行编辑命令。
+
+        Args:
+            args: 命令参数列表，可能包含要编辑的文件名
+            context: 项目上下文
+
+        Returns:
+            编辑成功或失败的结果
+
+        Raises:
+            EditorError: 当编辑器发生异常时抛出
+        """
+        project_path = context.project_path
+        if project_path is None:
+            return CommandResult.error("未打开项目，请先使用 'open <path>' 命令打开项目")
+
+        config_file = args[0] if args else "project.precis.yaml"
+        config_path = find_config_file(project_path, config_file)
+
+        if not config_path:
+            # 列出可用的配置文件
+            available = []
+            for root, _, files in os.walk(project_path):
+                # 跳过隐藏目录
+                if any(part.startswith(".") for part in root.split(os.sep)):
+                    continue
+                for f in files:
+                    if f.endswith((".yaml", ".yml")):
+                        rel_path = os.path.relpath(os.path.join(root, f), project_path)
+                        available.append(rel_path)
+
+            return CommandResult.error(
+                f"配置文件不存在: {config_file}\n"
+                f"可用配置文件: {', '.join(available[:10]) if available else '无'}"
+                f"{'...' if len(available) > 10 else ''}"
+            )
+
+        editor = self._get_editor()
+
+        try:
+            result = subprocess.run(
+                [editor, config_path],
+                cwd=project_path,
+            )
+
+            if result.returncode != 0:
+                return CommandResult.error(f"编辑器退出码: {result.returncode}")
+
+            return CommandResult.ok(f"已保存配置文件: {config_file}")
+
+        except FileNotFoundError:
+            return CommandResult.error(f"未找到编辑器: {editor}")
+        except Exception as e:
+            raise EditorError(str(e))
+
+    def _get_editor(self) -> str:
+        """获取编辑器路径。
+
+        按以下优先级查找：
+        1. EDITOR 环境变量
+        2. VISUAL 环境变量
+        3. Windows: notepad
+        4. Linux/macOS: vim, nano, vi
+
+        Returns:
+            编辑器可执行文件路径或名称
+        """
+        for env_var in ["EDITOR", "VISUAL"]:
+            editor = os.environ.get(env_var)
+            if editor:
+                return editor
+
+        if sys.platform == "win32":
+            return "notepad"
+
+        for editor in ["vim", "nano", "vi"]:
+            try:
+                subprocess.run(["which", editor], capture_output=True, check=True)
+                return editor
+            except subprocess.CalledProcessError:
+                continue
+
+        return "vim"

app/cli/shell/commands/config/get.py

@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2026 Precis Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# backend/app/cli/shell/commands/config/get.py
+"""
+@fileoverview 配置获取命令模块
+
+功能概述:
+- 提供 config get 子命令按点号路径获取配置项值
+- 支持字典与列表的 YAML 格式化输出
+- 使用点号路径访问嵌套配置，如 project.name
+
+架构设计:
+- ConfigGetCommand 继承 Command 基类
+- 按点号分割路径，逐级访问字典，遇到不存在的键则报错
+
+输入示例:
+    config get project.precis.yaml project.name
+
+输出示例:
+    CommandResult.ok("project.name = My Project")
+    CommandResult.error("配置项不存在: project.unknown")
+"""
+
+import os
+
+import yaml
+
+from app.cli.shared_services.config_ops import get_by_dotpath
+from app.cli.shell.commands.base import Command, CommandResult, ProjectContext
+
+
+class ConfigGetCommand(Command):
+    """获取配置项命令。
+
+    按点号路径从 YAML 配置文件中读取指定项的值。
+    """
+
+    def __init__(self) -> None:
+        super().__init__("get")
+
+    @property
+    def description(self) -> str:
+        return "获取配置项的值（支持点号路径）"
+
+    @property
+    def usage(self) -> str:
+        return "config get <config_file> <key_path>"
+
+    def execute(self, args: list[str], context: ProjectContext) -> CommandResult:
+        """执行获取配置项命令。
+
+        Args:
+            args: 命令参数列表，需要包含配置文件名和点号路径
+            context: 项目上下文
+
+        Returns:
+            配置项值或错误提示
+        """
+        project_path = context.project_path
+        if project_path is None:
+            return CommandResult.error("未打开项目，请先使用 'open <path>' 命令打开项目")
+
+        if len(args) < 2:
+            return CommandResult.error(
+                "用法: config get <config_file> <key_path>\n示例: config get project.precis.yaml project.name"
+            )
+
+        config_file = args[0]
+        key_path = args[1]
+        config_path = os.path.join(project_path, config_file)
+
+        if not os.path.isfile(config_path):
+            return CommandResult.error(f"配置文件不存在: {config_file}")
+
+        try:
+            with open(config_path, encoding="utf-8") as f:
+                data = yaml.safe_load(f)
+
+            if data is None:
+                return CommandResult.error("配置文件为空")
+
+            # 按点号路径查找值（委托 shared_services 纯逻辑，CLI/TUI 同源）
+            found, value = get_by_dotpath(data, key_path)
+            if not found:
+                return CommandResult.error(f"配置项不存在: {key_path}")
+
+            # 格式化输出
+            if isinstance(value, (dict, list)):
+                formatted = yaml.dump(value, allow_unicode=True, default_flow_style=False)
+            else:
+                formatted = str(value)
+
+            return CommandResult.ok(f"{key_path} = {formatted}")
+
+        except yaml.YAMLError as e:
+            return CommandResult.error(f"YAML 解析失败: {e}")
+        except Exception as e:
+            return CommandResult.error(f"读取失败: {e}")