feat(workflow): dry-run preview — resolve tokens and show the step plan without executing hooks

未关闭
#114 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
python, yaml

调研方向

Start with src/profiles/core/environment/workflow.py and read _substitute_variables to understand the existing token resolution, then check the workflow exports in src/profiles/core/__init__.py. The proposal also involves the preview route in src/profiles/server/routes/workflow.py, WorkflowRunnerModal.tsx, and both hooks guides. Done means a resolved, read-only preview reports condition outcomes without executing hooks; the issue names no tests to run.

由索引模型根据 Issue 内容生成。

描述

enhancement

Problem

Authoring workflow hooks today means editing the .profiles YAML, saving, launching a real file, and watching the commands actually run. Every iteration has side effects: files get moved/archived, commands execute, launches happen. A user tweaking a phase: post archive step, or checking whether {{file}}/{{output}} resolve as expected in an ask: prompt, has no way to see the resolved plan without performing the launch. This makes hook authoring the highest-friction part of the workflow feature — debugging requires real files and real executions.

Evidence

  • Token substitution is a private helper with no resolve-only entry point on the core surface: _substitute_variables at src/profiles/core/environment/workflow.py:660. src/profiles/core/__init__.py exports run_hooks_for_file/parse_hook_entries but nothing that renders a step without executing it.
  • Server workflow routes are execution-only: start/get/respond/abort (src/profiles/server/routes/workflow.py:397-643). No preview/dry-run route.
  • The web runner (src/profiles/web/src/components/WorkflowRunnerModal.tsx) can only show steps as they actually execute.
  • docs/hooks-guide.en.md / hooks-guide.fr.md document the token grammar but offer no way to check a substitution result before a real launch.

Proposed approach

  • Core (pure, UI-free): a preview_workflow(steps, context) -> list[PreviewedStep] function in profiles.core.environment.workflow next to _substitute_variables, reusing the same substitution logic (including the quote-aware command path). {{output}} renders as a labelled placeholder since nothing executes; if: conditions are evaluated and reported as true/false/skip. Export from profiles.core.
  • Server: POST /api/workflow/preview taking a file path, with an optional inline steps override so the YAML config editor (issue #95) can preview a draft before saving it.
  • Web: a read-only "Preview" view — either a tab in WorkflowRunnerModal or a standalone modal listing each step with phase, resolved command/message, and condition outcome. No run button.
  • Docs: hooks-guide (en + fr) section.
  • Scope M. No breaking change — pure addition.

Alternatives considered

  1. Cancel before the first command in a real run — still spawns processes, races the user, and can't preview an unsaved draft; doesn't help authoring.
  2. CLI-only profiles --preview-hooks <file> — useful but misses the web-first audience; the core function proposed above can back a CLI flag later at near-zero cost.

Proposed during automated enhancement scan 2026-11-04

主要语言
Python
星标
1
派生
1
平均合并
4 小时 46 分钟
30 天内合并 PR
55

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

falbany/ProFiles 的其他 Issue

查看 falbany/ProFiles 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。