Skillshare 技能测试
- 作者仓库星标 194
- 作者仓库 skills
Implement a feature following TDD workflow. $ARGUMENTS is a spec file path (e.g., specs/my-feature.md) or a plain-text feature description.
Scope: This skill writes Go code and tests. It does NOT update website docs (use update-docs after) or CHANGELOG (use changelog after).
Workflow
Step 1: Understand Requirements
If $ARGUMENTS is a file path:
- Read the spec file
- Extract acceptance criteria and edge cases
- Identify affected packages
If $ARGUMENTS is a description:
- Search existing code for related functionality
- Identify the right package to extend
- Confirm scope with user before proceeding
Step 2: Identify Affected Files
List all files that will be created or modified:
# Typical pattern for a new command
cmd/skillshare/<command>.go # Command handler
cmd/skillshare/<command>_project.go # Project-mode handler (if dual-mode)
internal/<package>/<feature>.go # Core logic
tests/integration/<command>_test.go # Integration test
Display the file list and continue. If scope is unclear, ask the user.
Step 3: Write Failing Tests First (RED)
Write integration tests using testutil.Sandbox:
func TestFeature_BasicCase(t *testing.T) {
sb := testutil.NewSandbox(t)
defer sb.Cleanup()
// Setup
sb.CreateSkill("test-skill", map[string]string{
"SKILL.md": "---\nname: test-skill\n---\n# Content",
})
// Act
result := sb.RunCLI("command", "args...")
// Assert
result.AssertSuccess()
result.AssertOutputContains("expected output")
}
Verify tests fail:
make test-int
# or run specific test:
go test ./tests/integration -run TestFeature_BasicCase
Step 4: Implement (GREEN)
Write minimal code to make tests pass:
- Follow existing patterns in
cmd/skillshare/andinternal/ - Use
internal/uifor terminal output (colors, spinners, boxes) - Add oplog instrumentation for mutating commands:
start := time.Now() // ... do work ... e := oplog.NewEntry("command-name", statusFromErr(err), time.Since(start)) oplog.Write(configPath, oplog.OpsFile, e) - Register command in
main.gocommands map if new command
Verify tests pass:
make test-int
Step 5: Refactor and Verify
- Clean up code while keeping tests green
- Run full quality check:
make check # fmt-check + lint + test - Fix any formatting or lint issues
Project Patterns Reference
These patterns appear throughout the codebase. Follow them when implementing new features.
Handler Split Convention
Large commands are split by concern rather than kept in a single file. When a command handler grows beyond ~300 lines, split it:
| Suffix | Purpose | Example |
|---|---|---|
<cmd>.go |
Flag parsing + mode routing (dispatch) | install.go |
_handlers.go |
Core handler logic | install_handlers.go |
_render.go / _audit_render.go |
Output rendering | audit_render.go |
_prompt.go / _prompt_tui.go |
Decision/prompt logic | install_prompt.go |
_tui.go |
Full-screen TUI (bubbletea) | list_tui.go |
_batch.go |
Batch operation orchestration | update_batch.go |
_resolve.go |
Target/skill resolution | update_resolve.go |
_context.go |
Mode-specific context struct | install_context.go |
_format.go |
Output formatting helpers | log_format.go |
Principle: dispatch file does ONLY flag parsing + mode routing. Logic goes in sub-files.
Dual-Mode Command Pattern
Most commands support both global (-g) and project (-p) mode:
func handleMyCommand(args []string) error {
mode, rest, err := parseModeArgs(args)
if err != nil { return err }
switch mode {
case modeProject:
return handleMyCommandProject(rest)
default:
return handleMyCommandGlobal(rest)
}
}
Create <cmd>_project.go for project-mode handler. Use parseModeArgs() from mode.go.
TUI Components (bubbletea)
All interactive prompts use bubbletea (not survey). Key components:
checklist_tui.go— shared checklist/radio pickerlist_tui.go— filterable list with detail panelsearch_tui.go— multi-select checkbox list
Color palette: cyan Color("6"), gray Color("8"), yellow #D4D93C.
Dispatch order: JSON output → TUI (if TTY + items + !--no-tui) → empty check → plain text.
Web API Endpoint
If the feature needs a Web UI endpoint, add internal/server/handler_<name>.go:
func (s *Server) handle<Name>(w http.ResponseWriter, r *http.Request) {
// ...
writeJSON(w, result) // 200 OK with JSON
// writeError(w, 400, msg) // for errors
}
Register in server.go route setup. Branch on s.IsProjectMode() for mode-specific behavior.
Oplog Instrumentation
All mutating commands log to operations.log (JSONL):
start := time.Now()
// ... do work ...
e := oplog.NewEntry("command-name", statusFromErr(err), time.Since(start))
e.Args = map[string]any{"key": value}
oplog.Write(configPath, oplog.OpsFile, e)
Security scans write to oplog.AuditFile instead.
Step 6: E2E Runbook (Major Features Only)
If the feature meets any of these criteria, generate an E2E runbook:
- New command or subcommand
- Changes to install/uninstall/sync flow
- Security-related (audit, hash verification, rollback)
- Multi-step user workflow (init → install → sync → verify)
- Edge cases that integration tests alone can't cover (Docker, network, file permissions)
Generate ai_docs/tests/<slug>_runbook.md following the existing convention:
# CLI E2E Runbook: <Title>
<One-line summary of what this validates.>
**Origin**: <version> — <why this runbook exists>
## Scope
- <bullet list of behaviors being validated>
## Environment
Run inside devcontainer with `ssenv` isolation.
## Steps
### 1. Setup: <description>
\```bash
<commands>
\```
**Expected**: <what should happen>
### 2. <Action>: <description>
...
## Pass Criteria
- All steps marked PASS
- <additional criteria>
Key conventions:
- YAML-free, pure Markdown
- Each step has
bashblock +Expectedblock ss=skillshare,~= ssenv-isolated HOME- Runbook can be executed by the
cli-e2e-testskill
If the feature does not meet the criteria above, skip this step.
Step 7: Stage and Report
- List all created/modified files
- Confirm each acceptance criterion is met with test evidence
- Remind user to run
update-docsif the feature affects CLI flags or user-visible behavior
Rules
- Test-first — always write failing test before implementation
- Minimal code — only write what's needed to pass tests
- Follow patterns — match existing code style in each package
- 3-strike rule — if a test fails 3 times after fixes, stop and report what's blocking
- No docs — this skill writes code only; use
update-docsfor documentation - No changelog — use
changelogskill for release notes - Spec ambiguity — ask the user rather than guessing
- 流狐分类
- 工程开发
- 作者声明 Agent
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 作者 / 版本 / 许可
- @JetBrains · 未声明 license
- 流狐 Token 估算
- 低消耗
- 流狐接入估算
- 需手动接入
- 是否需要外部 API Key
- 未发现要求
- 检测到的系统要求
- Docker
- 底层运行要求
- Docker
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- Shell 执行
- 检测到的网络行为
- 允许外网请求
- 安装命令数
- 无(仅作为资料)
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
作者没有在当前 SKILL.md 中定义固定输出样例。 Workflow
If $ARGUMENTS is a file path: Read the spec file Extract acceptance criteria and edge cases
List all files that will be created or modified: Display the file list and continue. If scope is unclear, ask the user.
Write integration tests using testutil.Sandbox: Verify tests fail:
Write minimal code to make tests pass: Follow existing patterns in cmd/skillshare/ and internal/ Use internal/ui for terminal output (colors, spinners, boxes)
Clean up code while keeping tests green Run full quality check: Fix any formatting or lint issues
Implement a feature following TDD workflow. $ARGUMENTS is a spec file path (e.g., `specs/my-feature.md`) or a plain-text feature description.
**Scope**: This skill writes Go code and tests. It does NOT update website docs (use `update-docs` after) or CHANGELOG (use `changelog` after).
## Workflow
### Step 1: Understand Requirements
If $ARGUMENTS is a file path:
1. Read the spec file
2. Extract acceptance criteria and edge cases
3. Identify affected packages
If $ARGUMENTS is a description:
1. Search existing code for related functionality
2. Identify the right package to extend
3. Confirm scope with user before proceeding
### Step 2: Identify Affected Files
List all files that will be created or modified:
```bash
# Typical pattern for a new command
cmd/skillshare/<command>.go # Command handler
cmd/skillshare/<command>_project.go # Project-mode handler (if dual-mode)
internal/<package>/<feature>.go # Core logic
tests/integration/<command>_test.go # Integration test
```
Display the file list and continue. If scope is unclear, ask the user.
### Step 3: Write Failing Tests First (RED)
Write integration tests using `testutil.Sandbox`:
```go
func TestFeature_BasicCase(t *testing.T) {
sb := testutil.NewSandbox(t)
defer sb.Cleanup()
// Setup
sb.CreateSkill("test-skill", map[string]string{
"SKILL.md": "---\nname: test-skill\n---\n# Content",
})
// Act
result := sb.RunCLI("command", "args...")
// Assert
result.AssertSuccess()
result.AssertOutputContains("expected output")
}
```
Verify tests fail:
```bash
make test-int
# or run specific test:
go test ./tests/integration -run TestFeature_BasicCase
```
### Step 4: Implement (GREEN)
Write minimal code to make tests pass:
… 作者原文负责流程事实;流狐只索引当前章节、要点、文件与命令。
章节 -> Workflow → Step 1: Understand Requirements → Step 2: Identify Affected Files → Step 3: Write Failing Tests First (RED) → Step 4: Implement (GREEN) → Step 5: Refactor and Verify
要点 -> Scope · Principle · bubbletea · any · Origin · Expected · Test-first · Minimal code
文件/命令 -> specs/my-feature.md · update-docs · changelog · testutil.Sandbox · cmd/skillshare/ · internal/ · internal/ui · main.go
内容 SHA-256 -> 7c0c989ae9d7
方法与流程
适用与边界
原文中的明确线索
specs/my-feature.md、update-docs、changelog、testutil.Sandbox、cmd/skillshare/、internal/、internal/ui、main.go