check-prerequisites.sh
4.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#!/usr/bin/env bash
# 前置条件检查脚本（整合版）
#
# 本脚本为 Spec-Driven Development 工作流提供统一的前置条件检查，
# 用于替代此前分散在多个脚本中的同类功能。
#
# 用法：./check-prerequisites.sh [OPTIONS]
#
# OPTIONS：
# --json 以 JSON 格式输出
# --require-tasks 要求 tasks.md 必须存在（实现阶段使用）
# --include-tasks 在 AVAILABLE_DOCS 列表中包含 tasks.md
# --paths-only 仅输出路径变量（不做校验）
# --help, -h 显示帮助信息
#
# 输出：
# JSON 模式：{"FEATURE_DIR":"...", "AVAILABLE_DOCS":["..."]}
# 文本模式：FEATURE_DIR:... \n AVAILABLE_DOCS: \n ✓/✗ file.md
# 仅路径：REPO_ROOT: ... \n BRANCH: ... \n FEATURE_DIR: ... 等
set -e
# 解析命令行参数
JSON_MODE=false
REQUIRE_TASKS=false
INCLUDE_TASKS=false
PATHS_ONLY=false
for arg in "$@"; do
case "$arg" in
--json)
JSON_MODE=true
;;
--require-tasks)
REQUIRE_TASKS=true
;;
--include-tasks)
INCLUDE_TASKS=true
;;
--paths-only)
PATHS_ONLY=true
;;
--help|-h)
cat << 'EOF'
用法：check-prerequisites.sh [OPTIONS]
用于 Spec-Driven Development 工作流的前置条件检查（整合版）。
选项：
--json 以 JSON 格式输出
--require-tasks 要求 tasks.md 必须存在（实现阶段使用）
--include-tasks 在 AVAILABLE_DOCS 列表中包含 tasks.md
--paths-only 仅输出路径变量（不做前置条件校验）
--help, -h 显示帮助信息
示例：
# 检查任务前置条件（需要 plan.md）
./check-prerequisites.sh --json
# 检查实现前置条件（需要 plan.md + tasks.md）
./check-prerequisites.sh --json --require-tasks --include-tasks
# 仅获取功能路径（不做校验）
./check-prerequisites.sh --paths-only
EOF
exit 0
;;
*)
echo "错误：未知选项 '$arg'。使用 --help 查看用法。" >&2
exit 1
;;
esac
done
# 引入通用函数
SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
source "$SCRIPT_DIR/common.sh"
# 获取功能路径并校验分支
eval $(get_feature_paths)
check_feature_branch "$CURRENT_BRANCH" "$HAS_GIT" || exit 1
# 若为仅路径模式：输出路径后退出（支持 --json 与 --paths-only 组合）
if $PATHS_ONLY; then
if $JSON_MODE; then
# 最小 JSON 路径负载（不做校验）
printf '{"REPO_ROOT":"%s","BRANCH":"%s","FEATURE_DIR":"%s","FEATURE_SPEC":"%s","IMPL_PLAN":"%s","TASKS":"%s"}\n' \
"$REPO_ROOT" "$CURRENT_BRANCH" "$FEATURE_DIR" "$FEATURE_SPEC" "$IMPL_PLAN" "$TASKS"
else
echo "REPO_ROOT: $REPO_ROOT"
echo "BRANCH: $CURRENT_BRANCH"
echo "FEATURE_DIR: $FEATURE_DIR"
echo "FEATURE_SPEC: $FEATURE_SPEC"
echo "IMPL_PLAN: $IMPL_PLAN"
echo "TASKS: $TASKS"
fi
exit 0
fi
# 校验必要的目录与文件
if [[ ! -d "$FEATURE_DIR" ]]; then
echo "错误：未找到功能目录：$FEATURE_DIR" >&2
echo "请先运行 /speckit.specify 以创建功能目录结构。" >&2
exit 1
fi
if [[ ! -f "$IMPL_PLAN" ]]; then
echo "错误：在 $FEATURE_DIR 中未找到 plan.md" >&2
echo "请先运行 /speckit.plan 以创建实现计划。" >&2
exit 1
fi
# 如果需要则检查 tasks.md
if $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; then
echo "错误：在 $FEATURE_DIR 中未找到 tasks.md" >&2
echo "请先运行 /speckit.tasks 以创建任务清单。" >&2
exit 1
fi
# 构建可用文档列表
docs=()
# 固定检查这些可选文档
[[ -f "$RESEARCH" ]] && docs+=("research.md")
[[ -f "$DATA_MODEL" ]] && docs+=("data-model.md")
# 检查 contracts 目录（仅当存在且非空）
if [[ -d "$CONTRACTS_DIR" ]] && [[ -n "$(ls -A "$CONTRACTS_DIR" 2>/dev/null)" ]]; then
docs+=("contracts/")
fi
[[ -f "$QUICKSTART" ]] && docs+=("quickstart.md")
# 若要求包含 tasks.md，且文件存在，则加入列表
if $INCLUDE_TASKS && [[ -f "$TASKS" ]]; then
docs+=("tasks.md")
fi
# 输出结果
if $JSON_MODE; then
# 构建文档 JSON 数组
if [[ ${#docs[@]} -eq 0 ]]; then
json_docs="[]"
else
json_docs=$(printf '"%s",' "${docs[@]}")
json_docs="[${json_docs%,}]"
fi
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$FEATURE_DIR" "$json_docs"
else
# 文本输出
echo "FEATURE_DIR:$FEATURE_DIR"
echo "AVAILABLE_DOCS:"
# 展示各文档的存在状态
check_file "$RESEARCH" "research.md"
check_file "$DATA_MODEL" "data-model.md"
check_dir "$CONTRACTS_DIR" "contracts/"
check_file "$QUICKSTART" "quickstart.md"
if $INCLUDE_TASKS; then
check_file "$TASKS" "tasks.md"
fi
fi