pi-crew 0.2.3 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +57 -32
- package/CHANGELOG.md +466 -448
- package/LICENSE +21 -21
- package/NOTICE.md +16 -16
- package/README.md +323 -323
- package/docs/FEATURE_INTAKE.md +126 -0
- package/docs/HARNESS.md +86 -0
- package/docs/HARNESS_BACKLOG.md +41 -0
- package/docs/TEST_MATRIX.md +49 -0
- package/docs/actions-reference.md +595 -595
- package/docs/architecture.md +180 -180
- package/docs/code-review-2026-05-11.md +592 -592
- package/docs/commands-reference.md +347 -347
- package/docs/comparison-pi-subagents-vs-pi-crew.md +303 -0
- package/docs/decisions/0001-durable-state.md +41 -0
- package/docs/decisions/0002-child-process-for-async.md +42 -0
- package/docs/decisions/0003-depth-guard.md +36 -0
- package/docs/decisions/0004-execfile-over-exec.md +34 -0
- package/docs/decisions/0005-no-parameter-properties.md +49 -0
- package/docs/decisions/0006-publish-bundled-esm.md +63 -0
- package/docs/decisions/0007-active-run-binary-index.md +54 -0
- package/docs/decisions/0008-child-pi-warm-pool.md +61 -0
- package/docs/decisions/README.md +23 -0
- package/docs/followup-review-round4-2026-05-13.md +107 -0
- package/docs/implementation-plan-top3.md +333 -0
- package/docs/live-mailbox-runtime.md +36 -36
- package/docs/next-upgrade-roadmap.md +808 -808
- package/docs/oh-my-pi-research.md +509 -0
- package/docs/perf/baseline-2026-05.md +113 -0
- package/docs/perf/final-report-2026-05.md +206 -0
- package/docs/perf/sprint-1-report.md +71 -0
- package/docs/perf/sprint-2-report.md +81 -0
- package/docs/perf/sprint-2.5-report.md +53 -0
- package/docs/perf/sprint-3-report.md +36 -0
- package/docs/perf/sprint-4-report.md +47 -0
- package/docs/perf/sprint-5-report.md +51 -0
- package/docs/perf/sprint-6-report.md +94 -0
- package/docs/perf/sprint-7-report.md +74 -0
- package/docs/perf/upgrade-plan-2026-05.md +147 -0
- package/docs/pi-subagents3-deep-analysis.md +508 -0
- package/docs/product/README.md +31 -0
- package/docs/product/platform.md +27 -0
- package/docs/product/runtime-safety.md +37 -0
- package/docs/product/team-run.md +39 -0
- package/docs/product/team-tool.md +37 -0
- package/docs/publishing.md +65 -65
- package/docs/resource-formats.md +134 -134
- package/docs/runtime-analysis-child-vs-live.md +171 -0
- package/docs/runtime-flow.md +148 -148
- package/docs/runtime-migration-in-process-analysis.md +250 -0
- package/docs/stories/README.md +30 -0
- package/docs/stories/backlog.md +36 -0
- package/docs/templates/decision.md +27 -0
- package/docs/templates/story.md +44 -0
- package/docs/templates/validation-report.md +32 -0
- package/docs/usage.md +238 -238
- package/index.ts +7 -6
- package/install.mjs +65 -65
- package/package.json +107 -100
- package/schema.json +222 -222
- package/skills/child-pi-spawning/SKILL.md +213 -0
- package/skills/context-artifact-hygiene/SKILL.md +32 -0
- package/skills/event-log-tracing/SKILL.md +299 -0
- package/skills/git-master/SKILL.md +225 -24
- package/skills/live-agent-lifecycle/SKILL.md +192 -0
- package/skills/mailbox-interactive/SKILL.md +300 -19
- package/skills/model-routing-context/SKILL.md +94 -0
- package/skills/multi-perspective-review/SKILL.md +88 -0
- package/skills/read-only-explorer/SKILL.md +250 -26
- package/skills/safe-bash/SKILL.md +307 -21
- package/skills/verification-before-done/SKILL.md +11 -2
- package/skills/widget-rendering/SKILL.md +258 -0
- package/skills/workspace-isolation/SKILL.md +202 -0
- package/skills/worktree-isolation/SKILL.md +202 -18
- package/src/adapters/claude-adapter.ts +25 -25
- package/src/adapters/codex-adapter.ts +21 -21
- package/src/adapters/cursor-adapter.ts +17 -17
- package/src/adapters/export-util.ts +137 -137
- package/src/adapters/index.ts +15 -15
- package/src/adapters/registry.ts +18 -18
- package/src/adapters/types.ts +23 -23
- package/src/agents/agent-config.ts +38 -38
- package/src/agents/agent-serializer.ts +38 -38
- package/src/agents/discover-agents.ts +121 -118
- package/src/config/config.ts +740 -858
- package/src/config/defaults.ts +96 -96
- package/src/config/drift-detector.ts +211 -211
- package/src/config/markers.ts +327 -327
- package/src/config/resilient-parser.ts +109 -108
- package/src/config/suggestions.ts +74 -74
- package/src/config/types.ts +199 -0
- package/src/extension/async-notifier.ts +123 -89
- package/src/extension/autonomous-policy.ts +169 -169
- package/src/extension/cross-extension-rpc.ts +104 -104
- package/src/extension/help.ts +47 -47
- package/src/extension/import-index.ts +69 -69
- package/src/extension/management.ts +395 -382
- package/src/extension/notification-router.ts +116 -116
- package/src/extension/notification-sink.ts +51 -51
- package/src/extension/project-init.ts +168 -168
- package/src/extension/register.ts +859 -668
- package/src/extension/registration/artifact-cleanup.ts +15 -15
- package/src/extension/registration/command-utils.ts +54 -54
- package/src/extension/registration/commands.ts +559 -452
- package/src/extension/registration/compaction-guard.ts +125 -125
- package/src/extension/registration/subagent-helpers.ts +102 -102
- package/src/extension/registration/subagent-tools.ts +220 -159
- package/src/extension/registration/team-tool.ts +159 -99
- package/src/extension/registration/viewers.ts +29 -0
- package/src/extension/result-watcher.ts +128 -128
- package/src/extension/run-bundle-schema.ts +89 -89
- package/src/extension/run-export.ts +73 -73
- package/src/extension/run-import.ts +84 -84
- package/src/extension/run-index.ts +94 -94
- package/src/extension/run-maintenance.ts +142 -142
- package/src/extension/session-summary.ts +8 -8
- package/src/extension/team-manager-command.ts +96 -96
- package/src/extension/team-recommendation.ts +188 -188
- package/src/extension/team-tool/api.ts +5 -2
- package/src/extension/team-tool/cancel.ts +224 -209
- package/src/extension/team-tool/config-patch.ts +36 -36
- package/src/extension/team-tool/context.ts +60 -60
- package/src/extension/team-tool/doctor.ts +242 -242
- package/src/extension/team-tool/handle-settings.ts +421 -195
- package/src/extension/team-tool/inspect.ts +41 -41
- package/src/extension/team-tool/lifecycle-actions.ts +139 -139
- package/src/extension/team-tool/parallel-dispatch.ts +156 -156
- package/src/extension/team-tool/plan.ts +19 -19
- package/src/extension/team-tool/respond.ts +112 -111
- package/src/extension/team-tool/run.ts +246 -229
- package/src/extension/team-tool/status.ts +110 -110
- package/src/extension/team-tool-types.ts +13 -13
- package/src/extension/team-tool.ts +344 -344
- package/src/extension/tool-result.ts +16 -16
- package/src/extension/validate-resources.ts +77 -77
- package/src/hooks/registry.ts +61 -61
- package/src/hooks/types.ts +40 -40
- package/src/i18n.ts +184 -184
- package/src/observability/correlation.ts +35 -35
- package/src/observability/event-to-metric.ts +68 -68
- package/src/observability/exporters/adapter.ts +30 -30
- package/src/observability/exporters/otlp-exporter.ts +106 -92
- package/src/observability/exporters/prometheus-exporter.ts +54 -54
- package/src/observability/metric-registry.ts +87 -87
- package/src/observability/metric-retention.ts +54 -54
- package/src/observability/metric-sink.ts +81 -56
- package/src/observability/metrics-primitives.ts +167 -167
- package/src/prompt/prompt-runtime.ts +72 -72
- package/src/runtime/adaptive-plan.ts +338 -0
- package/src/runtime/agent-control.ts +169 -169
- package/src/runtime/agent-memory.ts +72 -72
- package/src/runtime/agent-observability.ts +114 -114
- package/src/runtime/async-marker.ts +26 -26
- package/src/runtime/async-runner.ts +153 -153
- package/src/runtime/attention-events.ts +28 -28
- package/src/runtime/auto-resume.ts +100 -100
- package/src/runtime/background-runner.ts +122 -89
- package/src/runtime/cancellation.ts +61 -61
- package/src/runtime/capability-inventory.ts +116 -116
- package/src/runtime/child-pi-pool.ts +68 -0
- package/src/runtime/child-pi.ts +541 -461
- package/src/runtime/code-summary.ts +247 -247
- package/src/runtime/compaction-summary.ts +271 -271
- package/src/runtime/concurrency.ts +58 -58
- package/src/runtime/crash-recovery.ts +317 -301
- package/src/runtime/crew-agent-records.ts +379 -281
- package/src/runtime/crew-agent-runtime.ts +60 -60
- package/src/runtime/cross-extension-rpc.ts +72 -0
- package/src/runtime/custom-tools/irc-tool.ts +201 -201
- package/src/runtime/custom-tools/submit-result-tool.ts +90 -90
- package/src/runtime/deadletter.ts +47 -47
- package/src/runtime/delivery-coordinator.ts +176 -176
- package/src/runtime/delta-conflict.ts +360 -360
- package/src/runtime/diagnostic-export.ts +102 -102
- package/src/runtime/direct-run.ts +35 -35
- package/src/runtime/effectiveness.ts +82 -81
- package/src/runtime/errors/crew-errors.ts +166 -0
- package/src/runtime/event-stream-bridge.ts +92 -92
- package/src/runtime/foreground-control.ts +82 -82
- package/src/runtime/green-contract.ts +46 -46
- package/src/runtime/group-join.ts +234 -106
- package/src/runtime/heartbeat-watcher.ts +145 -124
- package/src/runtime/iteration-hooks.ts +267 -267
- package/src/runtime/live-agent-control.ts +88 -88
- package/src/runtime/live-agent-manager.ts +377 -179
- package/src/runtime/live-control-realtime.ts +36 -36
- package/src/runtime/live-session-runtime.ts +676 -600
- package/src/runtime/loop-gates.ts +129 -129
- package/src/runtime/manifest-cache.ts +263 -263
- package/src/runtime/mcp-proxy.ts +113 -113
- package/src/runtime/metric-parser.ts +40 -40
- package/src/runtime/model-fallback.ts +282 -274
- package/src/runtime/model-resolver.ts +118 -0
- package/src/runtime/output-validator.ts +187 -187
- package/src/runtime/overflow-recovery.ts +175 -175
- package/src/runtime/parallel-research.ts +44 -44
- package/src/runtime/parallel-utils.ts +156 -156
- package/src/runtime/parent-guard.ts +80 -80
- package/src/runtime/phase-progress.ts +217 -217
- package/src/runtime/pi-args.ts +165 -165
- package/src/runtime/pi-json-output.ts +111 -111
- package/src/runtime/pi-spawn.ts +167 -167
- package/src/runtime/policy-engine.ts +79 -79
- package/src/runtime/post-checks.ts +125 -125
- package/src/runtime/post-exit-stdio-guard.ts +86 -86
- package/src/runtime/process-status.ts +97 -73
- package/src/runtime/progress-event-coalescer.ts +43 -43
- package/src/runtime/recovery-recipes.ts +74 -74
- package/src/runtime/retry-executor.ts +81 -81
- package/src/runtime/role-permission.ts +39 -39
- package/src/runtime/run-tracker.ts +99 -0
- package/src/runtime/runtime-policy.ts +21 -0
- package/src/runtime/runtime-resolver.ts +94 -91
- package/src/runtime/scheduler.ts +294 -0
- package/src/runtime/semaphore.ts +131 -131
- package/src/runtime/sensitive-paths.ts +92 -92
- package/src/runtime/session-usage.ts +79 -79
- package/src/runtime/settings-store.ts +103 -0
- package/src/runtime/sidechain-output.ts +29 -29
- package/src/runtime/skill-instructions.ts +222 -222
- package/src/runtime/stale-reconciler.ts +198 -189
- package/src/runtime/streaming-output.ts +47 -0
- package/src/runtime/subagent-manager.ts +404 -400
- package/src/runtime/subprocess-tool-registry.ts +67 -67
- package/src/runtime/task-display.ts +38 -38
- package/src/runtime/task-graph-scheduler.ts +122 -122
- package/src/runtime/task-graph.ts +207 -207
- package/src/runtime/task-output-context.ts +177 -177
- package/src/runtime/task-packet.ts +93 -93
- package/src/runtime/task-quality.ts +207 -207
- package/src/runtime/task-runner/capabilities.ts +78 -78
- package/src/runtime/task-runner/live-executor.ts +131 -113
- package/src/runtime/task-runner/progress.ts +119 -119
- package/src/runtime/task-runner/prompt-builder.ts +139 -139
- package/src/runtime/task-runner/prompt-pipeline.ts +64 -64
- package/src/runtime/task-runner/result-utils.ts +14 -14
- package/src/runtime/task-runner/run-projection.ts +103 -103
- package/src/runtime/task-runner/state-helpers.ts +22 -22
- package/src/runtime/task-runner.ts +469 -459
- package/src/runtime/team-runner.ts +693 -945
- package/src/runtime/usage-tracker.ts +71 -0
- package/src/runtime/worker-heartbeat.ts +21 -21
- package/src/runtime/worker-startup.ts +57 -57
- package/src/runtime/workflow-state.ts +187 -187
- package/src/runtime/yield-handler.ts +190 -190
- package/src/schema/config-schema.ts +172 -168
- package/src/schema/team-tool-schema.ts +126 -126
- package/src/schema/validation-types.ts +151 -148
- package/src/skills/discover-skills.ts +67 -67
- package/src/skills/skill-templates.ts +374 -374
- package/src/state/active-run-registry.ts +227 -191
- package/src/state/artifact-store.ts +130 -129
- package/src/state/atomic-write.ts +262 -195
- package/src/state/blob-store.ts +116 -116
- package/src/state/contracts.ts +111 -111
- package/src/state/event-log-rotation.ts +161 -158
- package/src/state/event-log.ts +383 -303
- package/src/state/event-reconstructor.ts +217 -217
- package/src/state/jsonl-writer.ts +82 -82
- package/src/state/locks.ts +146 -146
- package/src/state/mailbox.ts +446 -405
- package/src/state/state-store.ts +364 -351
- package/src/state/task-claims.ts +44 -44
- package/src/state/types.ts +285 -285
- package/src/state/usage.ts +29 -29
- package/src/subagents/async-entry.ts +1 -1
- package/src/subagents/index.ts +3 -3
- package/src/subagents/live/control.ts +1 -1
- package/src/subagents/live/manager.ts +1 -1
- package/src/subagents/live/realtime.ts +1 -1
- package/src/subagents/live/session-runtime.ts +1 -1
- package/src/subagents/manager.ts +1 -1
- package/src/subagents/spawn.ts +1 -1
- package/src/teams/discover-teams.ts +116 -116
- package/src/teams/team-config.ts +27 -27
- package/src/teams/team-serializer.ts +38 -38
- package/src/types/diff.d.ts +18 -18
- package/src/ui/agent-management-overlay.ts +144 -144
- package/src/ui/crew-widget.ts +487 -370
- package/src/ui/dashboard-panes/agents-pane.ts +109 -28
- package/src/ui/dashboard-panes/cancellation-pane.ts +42 -42
- package/src/ui/dashboard-panes/capability-pane.ts +59 -59
- package/src/ui/dashboard-panes/health-pane.ts +30 -30
- package/src/ui/dashboard-panes/mailbox-pane.ts +35 -35
- package/src/ui/dashboard-panes/progress-pane.ts +30 -30
- package/src/ui/dashboard-panes/transcript-pane.ts +10 -10
- package/src/ui/heartbeat-aggregator.ts +63 -63
- package/src/ui/keybinding-map.ts +97 -94
- package/src/ui/live-conversation-overlay.ts +152 -0
- package/src/ui/live-run-sidebar.ts +180 -180
- package/src/ui/mascot.ts +442 -442
- package/src/ui/overlays/agent-picker-overlay.ts +57 -57
- package/src/ui/overlays/confirm-overlay.ts +58 -58
- package/src/ui/overlays/mailbox-compose-overlay.ts +144 -144
- package/src/ui/overlays/mailbox-compose-preview.ts +63 -63
- package/src/ui/overlays/mailbox-detail-overlay.ts +122 -122
- package/src/ui/pi-ui-compat.ts +57 -57
- package/src/ui/powerbar-publisher.ts +221 -197
- package/src/ui/render-scheduler.ts +216 -143
- package/src/ui/run-action-dispatcher.ts +118 -118
- package/src/ui/run-dashboard.ts +526 -464
- package/src/ui/run-event-bus.ts +208 -208
- package/src/ui/run-snapshot-cache.ts +826 -777
- package/src/ui/settings-overlay.ts +721 -0
- package/src/ui/snapshot-types.ts +86 -70
- package/src/ui/theme-adapter.ts +190 -190
- package/src/ui/tool-progress-formatter.ts +89 -0
- package/src/ui/transcript-cache.ts +94 -94
- package/src/ui/transcript-viewer.ts +335 -335
- package/src/utils/conflict-detect.ts +662 -0
- package/src/utils/file-coalescer.ts +86 -86
- package/src/utils/frontmatter.ts +68 -68
- package/src/utils/fs-watch.ts +88 -31
- package/src/utils/gh-protocol.ts +479 -0
- package/src/utils/ids.ts +17 -17
- package/src/utils/incremental-reader.ts +104 -104
- package/src/utils/internal-error.ts +6 -6
- package/src/utils/names.ts +27 -27
- package/src/utils/paths.ts +102 -63
- package/src/utils/redaction.ts +44 -44
- package/src/utils/safe-paths.ts +47 -47
- package/src/utils/scan-cache.ts +136 -136
- package/src/utils/sse-parser.ts +134 -134
- package/src/utils/task-name-generator.ts +337 -337
- package/src/utils/timings.ts +33 -33
- package/src/utils/visual.ts +243 -198
- package/src/workflows/discover-workflows.ts +139 -139
- package/src/workflows/validate-workflow.ts +40 -40
- package/src/workflows/workflow-config.ts +26 -26
- package/src/workflows/workflow-serializer.ts +32 -32
- package/src/worktree/branch-freshness.ts +45 -45
- package/src/worktree/cleanup.ts +75 -75
- package/src/worktree/worktree-manager.ts +188 -188
- package/teams/default.team.md +12 -12
- package/teams/fast-fix.team.md +11 -11
- package/teams/implementation.team.md +18 -18
- package/teams/parallel-research.team.md +14 -14
- package/teams/research.team.md +11 -11
- package/teams/review.team.md +12 -12
- package/tsconfig.json +19 -19
- package/workflows/default.workflow.md +30 -30
- package/workflows/fast-fix.workflow.md +23 -23
- package/workflows/implementation.workflow.md +43 -43
- package/workflows/parallel-research.workflow.md +46 -46
- package/workflows/research.workflow.md +22 -22
- package/workflows/review.workflow.md +30 -30
- package/skills/task-packet/SKILL.md +0 -28
- package/skills/verify-evidence/SKILL.md +0 -27
|
@@ -1,374 +1,374 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Template-based skill initialization for pi-crew.
|
|
3
|
-
*
|
|
4
|
-
* Provides builtin skill templates that can be instantiated with project-specific
|
|
5
|
-
* variables to produce ready-to-use SKILL.md files.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
// ---------------------------------------------------------------------------
|
|
9
|
-
// Types
|
|
10
|
-
// ---------------------------------------------------------------------------
|
|
11
|
-
|
|
12
|
-
export interface SkillVariable {
|
|
13
|
-
/** Variable name used as placeholder key in the template body, e.g. "language". */
|
|
14
|
-
name: string;
|
|
15
|
-
/** Human-readable description of what this variable controls. */
|
|
16
|
-
description: string;
|
|
17
|
-
/** When true the caller must supply a value (no default available). */
|
|
18
|
-
required: boolean;
|
|
19
|
-
/** Default value used when the variable is optional and no value is supplied. */
|
|
20
|
-
defaultValue?: string;
|
|
21
|
-
/** If set, the supplied value must be one of these strings. */
|
|
22
|
-
options?: string[];
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
export interface SkillTemplate {
|
|
26
|
-
/** Unique template identifier, e.g. "code-review". */
|
|
27
|
-
id: string;
|
|
28
|
-
/** Human-readable name. */
|
|
29
|
-
name: string;
|
|
30
|
-
/** Short description of the skill this template produces. */
|
|
31
|
-
description: string;
|
|
32
|
-
/** Category for grouping (e.g. "quality", "testing", "documentation"). */
|
|
33
|
-
category: string;
|
|
34
|
-
/** Template variables referenced via {varName} in the body. */
|
|
35
|
-
variables: SkillVariable[];
|
|
36
|
-
/** Markdown template body with {variableName} placeholders. */
|
|
37
|
-
body: string;
|
|
38
|
-
/** Hard rules the instantiated skill must follow. */
|
|
39
|
-
guardrails: string[];
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
export interface InstantiatedSkill {
|
|
43
|
-
/** Suggested filename, e.g. "code-review.SKILL.md". */
|
|
44
|
-
filename: string;
|
|
45
|
-
/** Fully rendered markdown content. */
|
|
46
|
-
content: string;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
// ---------------------------------------------------------------------------
|
|
50
|
-
// Builtin templates
|
|
51
|
-
// ---------------------------------------------------------------------------
|
|
52
|
-
|
|
53
|
-
const CODE_REVIEW_TEMPLATE: SkillTemplate = {
|
|
54
|
-
id: "code-review",
|
|
55
|
-
name: "Code Review",
|
|
56
|
-
description: "Systematic code review skill with configurable language and focus areas.",
|
|
57
|
-
category: "quality",
|
|
58
|
-
variables: [
|
|
59
|
-
{ name: "language", description: "Primary programming language of the codebase", required: true, options: ["TypeScript", "JavaScript", "Python", "Rust", "Go", "Java", "C#", "Other"] },
|
|
60
|
-
{ name: "focusAreas", description: "Comma-separated list of review focus areas", required: false, defaultValue: "correctness, readability, performance" },
|
|
61
|
-
{ name: "severityThreshold", description: "Minimum severity level to report", required: false, defaultValue: "warning", options: ["info", "warning", "error", "critical"] },
|
|
62
|
-
],
|
|
63
|
-
body: [
|
|
64
|
-
"---",
|
|
65
|
-
"description: Automated code review for {language} projects",
|
|
66
|
-
"---",
|
|
67
|
-
"",
|
|
68
|
-
"# Code Review Skill",
|
|
69
|
-
"",
|
|
70
|
-
"You are a code reviewer specializing in **{language}**.",
|
|
71
|
-
"",
|
|
72
|
-
"## Focus Areas",
|
|
73
|
-
"",
|
|
74
|
-
"Prioritize the following aspects (in order):",
|
|
75
|
-
"",
|
|
76
|
-
"{focusAreas}",
|
|
77
|
-
"",
|
|
78
|
-
"## Severity Threshold",
|
|
79
|
-
"",
|
|
80
|
-
"Only surface issues at or above **{severityThreshold}** severity.",
|
|
81
|
-
"",
|
|
82
|
-
"## Process",
|
|
83
|
-
"",
|
|
84
|
-
"1. Read the full diff / files before commenting.",
|
|
85
|
-
"2. Classify each finding by severity.",
|
|
86
|
-
"3. Provide actionable suggestions with code examples where helpful.",
|
|
87
|
-
"4. Summarize overall quality and risk assessment.",
|
|
88
|
-
].join("\n"),
|
|
89
|
-
guardrails: [
|
|
90
|
-
"Do not approve code you have not fully read.",
|
|
91
|
-
"Do not comment on style issues that are already handled by a linter.",
|
|
92
|
-
"Do not suggest changes without explaining the reasoning.",
|
|
93
|
-
],
|
|
94
|
-
};
|
|
95
|
-
|
|
96
|
-
const TESTING_TEMPLATE: SkillTemplate = {
|
|
97
|
-
id: "testing",
|
|
98
|
-
name: "Testing",
|
|
99
|
-
description: "Test writing skill with configurable framework and coverage targets.",
|
|
100
|
-
category: "testing",
|
|
101
|
-
variables: [
|
|
102
|
-
{ name: "framework", description: "Testing framework to use", required: true, options: ["vitest", "jest", "mocha", "pytest", "go-test", "cargo-test", "Other"] },
|
|
103
|
-
{ name: "coverageTarget", description: "Target coverage percentage", required: false, defaultValue: "80" },
|
|
104
|
-
{ name: "testType", description: "Primary type of tests to write", required: false, defaultValue: "unit", options: ["unit", "integration", "e2e", "all"] },
|
|
105
|
-
],
|
|
106
|
-
body: [
|
|
107
|
-
"---",
|
|
108
|
-
"description: Write tests using {framework} with {coverageTarget}% coverage target",
|
|
109
|
-
"---",
|
|
110
|
-
"",
|
|
111
|
-
"# Testing Skill",
|
|
112
|
-
"",
|
|
113
|
-
"You are a test engineer writing **{testType}** tests using **{framework}**.",
|
|
114
|
-
"",
|
|
115
|
-
"## Coverage Target",
|
|
116
|
-
"",
|
|
117
|
-
"Aim for at least **{coverageTarget}%** code coverage.",
|
|
118
|
-
"",
|
|
119
|
-
"## Guidelines",
|
|
120
|
-
"",
|
|
121
|
-
"1. Write descriptive test names that explain the expected behavior.",
|
|
122
|
-
"2. Follow the Arrange-Act-Assert pattern.",
|
|
123
|
-
"3. Test edge cases and error paths, not just the happy path.",
|
|
124
|
-
"4. Keep tests independent — no shared mutable state between tests.",
|
|
125
|
-
"5. Mock external dependencies; do not hit real network services.",
|
|
126
|
-
].join("\n"),
|
|
127
|
-
guardrails: [
|
|
128
|
-
"Do not skip testing error paths.",
|
|
129
|
-
"Do not write tests that depend on execution order.",
|
|
130
|
-
"Do not mock the system under test.",
|
|
131
|
-
],
|
|
132
|
-
};
|
|
133
|
-
|
|
134
|
-
const SECURITY_AUDIT_TEMPLATE: SkillTemplate = {
|
|
135
|
-
id: "security-audit",
|
|
136
|
-
name: "Security Audit",
|
|
137
|
-
description: "Security review skill with configurable scope and severity thresholds.",
|
|
138
|
-
category: "security",
|
|
139
|
-
variables: [
|
|
140
|
-
{ name: "scope", description: "Audit scope: what parts of the codebase to examine", required: true, options: ["full-codebase", "dependencies", "api-surface", "auth-flows", "input-handling"] },
|
|
141
|
-
{ name: "severityThreshold", description: "Minimum severity to report", required: false, defaultValue: "medium", options: ["low", "medium", "high", "critical"] },
|
|
142
|
-
{ name: "complianceFramework", description: "Compliance framework to check against (if applicable)", required: false, defaultValue: "OWASP Top 10" },
|
|
143
|
-
],
|
|
144
|
-
body: [
|
|
145
|
-
"---",
|
|
146
|
-
"description: Security audit focusing on {scope} (threshold: {severityThreshold})",
|
|
147
|
-
"---",
|
|
148
|
-
"",
|
|
149
|
-
"# Security Audit Skill",
|
|
150
|
-
"",
|
|
151
|
-
"You are a security auditor performing a **{scope}** review.",
|
|
152
|
-
"",
|
|
153
|
-
"## Severity Threshold",
|
|
154
|
-
"",
|
|
155
|
-
"Report all findings at or above **{severityThreshold}** severity.",
|
|
156
|
-
"",
|
|
157
|
-
"## Compliance Framework",
|
|
158
|
-
"",
|
|
159
|
-
"Check against: **{complianceFramework}**.",
|
|
160
|
-
"",
|
|
161
|
-
"## Methodology",
|
|
162
|
-
"",
|
|
163
|
-
"1. Identify the attack surface relevant to the chosen scope.",
|
|
164
|
-
"2. Trace data flows from untrusted inputs.",
|
|
165
|
-
"3. Check for common vulnerability classes (injection, auth bypass, etc.).",
|
|
166
|
-
"4. Verify that secrets/credentials are handled safely.",
|
|
167
|
-
"5. Document each finding with severity, description, and remediation.",
|
|
168
|
-
].join("\n"),
|
|
169
|
-
guardrails: [
|
|
170
|
-
"Do not ignore low-severity findings that could chain into higher-severity exploits.",
|
|
171
|
-
"Do not report theoretical issues without evidence in the code.",
|
|
172
|
-
"Do not store or log real secrets/credentials during the audit.",
|
|
173
|
-
],
|
|
174
|
-
};
|
|
175
|
-
|
|
176
|
-
const REFACTOR_TEMPLATE: SkillTemplate = {
|
|
177
|
-
id: "refactor",
|
|
178
|
-
name: "Refactor",
|
|
179
|
-
description: "Refactoring skill with configurable scope and constraints.",
|
|
180
|
-
category: "maintenance",
|
|
181
|
-
variables: [
|
|
182
|
-
{ name: "scope", description: "What to refactor: file, module, or architectural pattern", required: true },
|
|
183
|
-
{ name: "constraints", description: "Constraints to respect during refactoring", required: false, defaultValue: "preserve public API, maintain backward compatibility" },
|
|
184
|
-
{ name: "goal", description: "Primary refactoring goal", required: false, defaultValue: "improve readability and reduce complexity", options: ["improve readability and reduce complexity", "improve performance", "reduce coupling", "enable extensibility", "simplify testability"] },
|
|
185
|
-
],
|
|
186
|
-
body: [
|
|
187
|
-
"---",
|
|
188
|
-
"description: Refactoring skill targeting {scope}",
|
|
189
|
-
"---",
|
|
190
|
-
"",
|
|
191
|
-
"# Refactor Skill",
|
|
192
|
-
"",
|
|
193
|
-
"You are a refactoring specialist working on **{scope}**.",
|
|
194
|
-
"",
|
|
195
|
-
"## Goal",
|
|
196
|
-
"",
|
|
197
|
-
"Primary objective: **{goal}**.",
|
|
198
|
-
"",
|
|
199
|
-
"## Constraints",
|
|
200
|
-
"",
|
|
201
|
-
"The following constraints must be respected:",
|
|
202
|
-
"",
|
|
203
|
-
"- {constraints}",
|
|
204
|
-
"",
|
|
205
|
-
"## Approach",
|
|
206
|
-
"",
|
|
207
|
-
"1. Understand the current code structure and all usages.",
|
|
208
|
-
"2. Plan the refactoring in small, reviewable steps.",
|
|
209
|
-
"3. Run existing tests after each step to verify correctness.",
|
|
210
|
-
"4. Add new tests if the refactoring introduces new behavior.",
|
|
211
|
-
"5. Document any architectural decisions made during the refactor.",
|
|
212
|
-
].join("\n"),
|
|
213
|
-
guardrails: [
|
|
214
|
-
"Do not change public API signatures without explicit approval.",
|
|
215
|
-
"Do not mix refactoring with feature changes.",
|
|
216
|
-
"Do not skip running tests between steps.",
|
|
217
|
-
],
|
|
218
|
-
};
|
|
219
|
-
|
|
220
|
-
const DOCUMENTATION_TEMPLATE: SkillTemplate = {
|
|
221
|
-
id: "documentation",
|
|
222
|
-
name: "Documentation",
|
|
223
|
-
description: "Documentation writing skill with configurable format and audience.",
|
|
224
|
-
category: "documentation",
|
|
225
|
-
variables: [
|
|
226
|
-
{ name: "format", description: "Documentation format to produce", required: true, options: ["markdown", "jsdoc", "rustdoc", "godoc", "pydoc", "openapi"] },
|
|
227
|
-
{ name: "audience", description: "Target audience for the documentation", required: false, defaultValue: "developers", options: ["developers", "operators", "end-users", "contributors", "architects"] },
|
|
228
|
-
{ name: "detailLevel", description: "Level of detail", required: false, defaultValue: "standard", options: ["brief", "standard", "comprehensive"] },
|
|
229
|
-
],
|
|
230
|
-
body: [
|
|
231
|
-
"---",
|
|
232
|
-
"description: Write {format} documentation for {audience}",
|
|
233
|
-
"---",
|
|
234
|
-
"",
|
|
235
|
-
"# Documentation Skill",
|
|
236
|
-
"",
|
|
237
|
-
"You are a technical writer producing **{format}** documentation",
|
|
238
|
-
"for **{audience}**.",
|
|
239
|
-
"",
|
|
240
|
-
"## Detail Level",
|
|
241
|
-
"",
|
|
242
|
-
"Detail level: **{detailLevel}**.",
|
|
243
|
-
"",
|
|
244
|
-
"## Guidelines",
|
|
245
|
-
"",
|
|
246
|
-
"1. Start with a brief summary of what the module/function does.",
|
|
247
|
-
"2. Document all public APIs with parameter descriptions and return types.",
|
|
248
|
-
"3. Include usage examples for non-trivial functionality.",
|
|
249
|
-
"4. Keep language clear and avoid unnecessary jargon.",
|
|
250
|
-
"5. Cross-reference related modules where applicable.",
|
|
251
|
-
].join("\n"),
|
|
252
|
-
guardrails: [
|
|
253
|
-
"Do not document private/internal APIs unless specifically requested.",
|
|
254
|
-
"Do not generate placeholder content — every section must be meaningful.",
|
|
255
|
-
"Do not duplicate information already present in existing docs.",
|
|
256
|
-
],
|
|
257
|
-
};
|
|
258
|
-
|
|
259
|
-
const BUILTIN_TEMPLATES: SkillTemplate[] = [
|
|
260
|
-
CODE_REVIEW_TEMPLATE,
|
|
261
|
-
TESTING_TEMPLATE,
|
|
262
|
-
SECURITY_AUDIT_TEMPLATE,
|
|
263
|
-
REFACTOR_TEMPLATE,
|
|
264
|
-
DOCUMENTATION_TEMPLATE,
|
|
265
|
-
];
|
|
266
|
-
|
|
267
|
-
// ---------------------------------------------------------------------------
|
|
268
|
-
// Public API
|
|
269
|
-
// ---------------------------------------------------------------------------
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* Return all builtin skill templates.
|
|
273
|
-
*/
|
|
274
|
-
export function getBuiltinTemplates(): SkillTemplate[] {
|
|
275
|
-
return BUILTIN_TEMPLATES;
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
* Look up a builtin template by its id or name (case-insensitive).
|
|
280
|
-
*/
|
|
281
|
-
export function findTemplate(idOrName: string): SkillTemplate | undefined {
|
|
282
|
-
const lower = idOrName.toLowerCase();
|
|
283
|
-
return BUILTIN_TEMPLATES.find(
|
|
284
|
-
(t) => t.id.toLowerCase() === lower || t.name.toLowerCase() === lower,
|
|
285
|
-
);
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
/**
|
|
289
|
-
* Instantiate a skill template by filling in its variables.
|
|
290
|
-
*
|
|
291
|
-
* - Required variables that are missing throw an error.
|
|
292
|
-
* - Optional variables fall back to their `defaultValue` if not supplied.
|
|
293
|
-
* - Variables with `options` constrain the allowed values.
|
|
294
|
-
*
|
|
295
|
-
* @param template The template to instantiate.
|
|
296
|
-
* @param variables User-supplied variable values.
|
|
297
|
-
* @returns An object with the suggested filename and rendered content.
|
|
298
|
-
*/
|
|
299
|
-
export function instantiateTemplate(
|
|
300
|
-
template: SkillTemplate,
|
|
301
|
-
variables: Record<string, string>,
|
|
302
|
-
): InstantiatedSkill {
|
|
303
|
-
// Validate and resolve all variable values
|
|
304
|
-
const resolved: Record<string, string> = {};
|
|
305
|
-
|
|
306
|
-
for (const variable of template.variables) {
|
|
307
|
-
const value = variables[variable.name];
|
|
308
|
-
|
|
309
|
-
if (value === undefined || value === "") {
|
|
310
|
-
if (variable.required) {
|
|
311
|
-
throw new Error(
|
|
312
|
-
`Missing required variable "${variable.name}" for template "${template.id}" (${variable.description}).`,
|
|
313
|
-
);
|
|
314
|
-
}
|
|
315
|
-
resolved[variable.name] = variable.defaultValue ?? "";
|
|
316
|
-
continue;
|
|
317
|
-
}
|
|
318
|
-
|
|
319
|
-
// Validate options constraint
|
|
320
|
-
if (variable.options !== undefined && !variable.options.includes(value)) {
|
|
321
|
-
throw new Error(
|
|
322
|
-
`Invalid value "${value}" for variable "${variable.name}" in template "${template.id}". ` +
|
|
323
|
-
`Allowed values: ${variable.options.join(", ")}.`,
|
|
324
|
-
);
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
resolved[variable.name] = value;
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
// Render the template body by replacing all {varName} placeholders
|
|
331
|
-
let content = template.body;
|
|
332
|
-
for (const [key, value] of Object.entries(resolved)) {
|
|
333
|
-
// Use a global regex to replace all occurrences of {key}
|
|
334
|
-
const placeholderRegex = new RegExp(`\\{${escapeRegExp(key)}\\}`, "g");
|
|
335
|
-
content = content.replace(placeholderRegex, value);
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
// Build filename from template id
|
|
339
|
-
const filename = `${template.id}.SKILL.md`;
|
|
340
|
-
|
|
341
|
-
return { filename, content };
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
* Return a simplified list of available templates suitable for display.
|
|
346
|
-
* Each entry contains id, name, description, category, and variable names.
|
|
347
|
-
*/
|
|
348
|
-
export function listTemplates(): Array<{
|
|
349
|
-
id: string;
|
|
350
|
-
name: string;
|
|
351
|
-
description: string;
|
|
352
|
-
category: string;
|
|
353
|
-
variables: Array<{ name: string; required: boolean }>;
|
|
354
|
-
}> {
|
|
355
|
-
return BUILTIN_TEMPLATES.map((t) => ({
|
|
356
|
-
id: t.id,
|
|
357
|
-
name: t.name,
|
|
358
|
-
description: t.description,
|
|
359
|
-
category: t.category,
|
|
360
|
-
variables: t.variables.map((v) => ({ name: v.name, required: v.required })),
|
|
361
|
-
}));
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
// ---------------------------------------------------------------------------
|
|
365
|
-
// Internal helpers
|
|
366
|
-
// ---------------------------------------------------------------------------
|
|
367
|
-
|
|
368
|
-
/**
|
|
369
|
-
* Escape special regex characters in a string so it can be used inside a
|
|
370
|
-
* RegExp constructor.
|
|
371
|
-
*/
|
|
372
|
-
function escapeRegExp(input: string): string {
|
|
373
|
-
return input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
374
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Template-based skill initialization for pi-crew.
|
|
3
|
+
*
|
|
4
|
+
* Provides builtin skill templates that can be instantiated with project-specific
|
|
5
|
+
* variables to produce ready-to-use SKILL.md files.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
// ---------------------------------------------------------------------------
|
|
9
|
+
// Types
|
|
10
|
+
// ---------------------------------------------------------------------------
|
|
11
|
+
|
|
12
|
+
export interface SkillVariable {
|
|
13
|
+
/** Variable name used as placeholder key in the template body, e.g. "language". */
|
|
14
|
+
name: string;
|
|
15
|
+
/** Human-readable description of what this variable controls. */
|
|
16
|
+
description: string;
|
|
17
|
+
/** When true the caller must supply a value (no default available). */
|
|
18
|
+
required: boolean;
|
|
19
|
+
/** Default value used when the variable is optional and no value is supplied. */
|
|
20
|
+
defaultValue?: string;
|
|
21
|
+
/** If set, the supplied value must be one of these strings. */
|
|
22
|
+
options?: string[];
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export interface SkillTemplate {
|
|
26
|
+
/** Unique template identifier, e.g. "code-review". */
|
|
27
|
+
id: string;
|
|
28
|
+
/** Human-readable name. */
|
|
29
|
+
name: string;
|
|
30
|
+
/** Short description of the skill this template produces. */
|
|
31
|
+
description: string;
|
|
32
|
+
/** Category for grouping (e.g. "quality", "testing", "documentation"). */
|
|
33
|
+
category: string;
|
|
34
|
+
/** Template variables referenced via {varName} in the body. */
|
|
35
|
+
variables: SkillVariable[];
|
|
36
|
+
/** Markdown template body with {variableName} placeholders. */
|
|
37
|
+
body: string;
|
|
38
|
+
/** Hard rules the instantiated skill must follow. */
|
|
39
|
+
guardrails: string[];
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface InstantiatedSkill {
|
|
43
|
+
/** Suggested filename, e.g. "code-review.SKILL.md". */
|
|
44
|
+
filename: string;
|
|
45
|
+
/** Fully rendered markdown content. */
|
|
46
|
+
content: string;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// ---------------------------------------------------------------------------
|
|
50
|
+
// Builtin templates
|
|
51
|
+
// ---------------------------------------------------------------------------
|
|
52
|
+
|
|
53
|
+
const CODE_REVIEW_TEMPLATE: SkillTemplate = {
|
|
54
|
+
id: "code-review",
|
|
55
|
+
name: "Code Review",
|
|
56
|
+
description: "Systematic code review skill with configurable language and focus areas.",
|
|
57
|
+
category: "quality",
|
|
58
|
+
variables: [
|
|
59
|
+
{ name: "language", description: "Primary programming language of the codebase", required: true, options: ["TypeScript", "JavaScript", "Python", "Rust", "Go", "Java", "C#", "Other"] },
|
|
60
|
+
{ name: "focusAreas", description: "Comma-separated list of review focus areas", required: false, defaultValue: "correctness, readability, performance" },
|
|
61
|
+
{ name: "severityThreshold", description: "Minimum severity level to report", required: false, defaultValue: "warning", options: ["info", "warning", "error", "critical"] },
|
|
62
|
+
],
|
|
63
|
+
body: [
|
|
64
|
+
"---",
|
|
65
|
+
"description: Automated code review for {language} projects",
|
|
66
|
+
"---",
|
|
67
|
+
"",
|
|
68
|
+
"# Code Review Skill",
|
|
69
|
+
"",
|
|
70
|
+
"You are a code reviewer specializing in **{language}**.",
|
|
71
|
+
"",
|
|
72
|
+
"## Focus Areas",
|
|
73
|
+
"",
|
|
74
|
+
"Prioritize the following aspects (in order):",
|
|
75
|
+
"",
|
|
76
|
+
"{focusAreas}",
|
|
77
|
+
"",
|
|
78
|
+
"## Severity Threshold",
|
|
79
|
+
"",
|
|
80
|
+
"Only surface issues at or above **{severityThreshold}** severity.",
|
|
81
|
+
"",
|
|
82
|
+
"## Process",
|
|
83
|
+
"",
|
|
84
|
+
"1. Read the full diff / files before commenting.",
|
|
85
|
+
"2. Classify each finding by severity.",
|
|
86
|
+
"3. Provide actionable suggestions with code examples where helpful.",
|
|
87
|
+
"4. Summarize overall quality and risk assessment.",
|
|
88
|
+
].join("\n"),
|
|
89
|
+
guardrails: [
|
|
90
|
+
"Do not approve code you have not fully read.",
|
|
91
|
+
"Do not comment on style issues that are already handled by a linter.",
|
|
92
|
+
"Do not suggest changes without explaining the reasoning.",
|
|
93
|
+
],
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
const TESTING_TEMPLATE: SkillTemplate = {
|
|
97
|
+
id: "testing",
|
|
98
|
+
name: "Testing",
|
|
99
|
+
description: "Test writing skill with configurable framework and coverage targets.",
|
|
100
|
+
category: "testing",
|
|
101
|
+
variables: [
|
|
102
|
+
{ name: "framework", description: "Testing framework to use", required: true, options: ["vitest", "jest", "mocha", "pytest", "go-test", "cargo-test", "Other"] },
|
|
103
|
+
{ name: "coverageTarget", description: "Target coverage percentage", required: false, defaultValue: "80" },
|
|
104
|
+
{ name: "testType", description: "Primary type of tests to write", required: false, defaultValue: "unit", options: ["unit", "integration", "e2e", "all"] },
|
|
105
|
+
],
|
|
106
|
+
body: [
|
|
107
|
+
"---",
|
|
108
|
+
"description: Write tests using {framework} with {coverageTarget}% coverage target",
|
|
109
|
+
"---",
|
|
110
|
+
"",
|
|
111
|
+
"# Testing Skill",
|
|
112
|
+
"",
|
|
113
|
+
"You are a test engineer writing **{testType}** tests using **{framework}**.",
|
|
114
|
+
"",
|
|
115
|
+
"## Coverage Target",
|
|
116
|
+
"",
|
|
117
|
+
"Aim for at least **{coverageTarget}%** code coverage.",
|
|
118
|
+
"",
|
|
119
|
+
"## Guidelines",
|
|
120
|
+
"",
|
|
121
|
+
"1. Write descriptive test names that explain the expected behavior.",
|
|
122
|
+
"2. Follow the Arrange-Act-Assert pattern.",
|
|
123
|
+
"3. Test edge cases and error paths, not just the happy path.",
|
|
124
|
+
"4. Keep tests independent — no shared mutable state between tests.",
|
|
125
|
+
"5. Mock external dependencies; do not hit real network services.",
|
|
126
|
+
].join("\n"),
|
|
127
|
+
guardrails: [
|
|
128
|
+
"Do not skip testing error paths.",
|
|
129
|
+
"Do not write tests that depend on execution order.",
|
|
130
|
+
"Do not mock the system under test.",
|
|
131
|
+
],
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
const SECURITY_AUDIT_TEMPLATE: SkillTemplate = {
|
|
135
|
+
id: "security-audit",
|
|
136
|
+
name: "Security Audit",
|
|
137
|
+
description: "Security review skill with configurable scope and severity thresholds.",
|
|
138
|
+
category: "security",
|
|
139
|
+
variables: [
|
|
140
|
+
{ name: "scope", description: "Audit scope: what parts of the codebase to examine", required: true, options: ["full-codebase", "dependencies", "api-surface", "auth-flows", "input-handling"] },
|
|
141
|
+
{ name: "severityThreshold", description: "Minimum severity to report", required: false, defaultValue: "medium", options: ["low", "medium", "high", "critical"] },
|
|
142
|
+
{ name: "complianceFramework", description: "Compliance framework to check against (if applicable)", required: false, defaultValue: "OWASP Top 10" },
|
|
143
|
+
],
|
|
144
|
+
body: [
|
|
145
|
+
"---",
|
|
146
|
+
"description: Security audit focusing on {scope} (threshold: {severityThreshold})",
|
|
147
|
+
"---",
|
|
148
|
+
"",
|
|
149
|
+
"# Security Audit Skill",
|
|
150
|
+
"",
|
|
151
|
+
"You are a security auditor performing a **{scope}** review.",
|
|
152
|
+
"",
|
|
153
|
+
"## Severity Threshold",
|
|
154
|
+
"",
|
|
155
|
+
"Report all findings at or above **{severityThreshold}** severity.",
|
|
156
|
+
"",
|
|
157
|
+
"## Compliance Framework",
|
|
158
|
+
"",
|
|
159
|
+
"Check against: **{complianceFramework}**.",
|
|
160
|
+
"",
|
|
161
|
+
"## Methodology",
|
|
162
|
+
"",
|
|
163
|
+
"1. Identify the attack surface relevant to the chosen scope.",
|
|
164
|
+
"2. Trace data flows from untrusted inputs.",
|
|
165
|
+
"3. Check for common vulnerability classes (injection, auth bypass, etc.).",
|
|
166
|
+
"4. Verify that secrets/credentials are handled safely.",
|
|
167
|
+
"5. Document each finding with severity, description, and remediation.",
|
|
168
|
+
].join("\n"),
|
|
169
|
+
guardrails: [
|
|
170
|
+
"Do not ignore low-severity findings that could chain into higher-severity exploits.",
|
|
171
|
+
"Do not report theoretical issues without evidence in the code.",
|
|
172
|
+
"Do not store or log real secrets/credentials during the audit.",
|
|
173
|
+
],
|
|
174
|
+
};
|
|
175
|
+
|
|
176
|
+
const REFACTOR_TEMPLATE: SkillTemplate = {
|
|
177
|
+
id: "refactor",
|
|
178
|
+
name: "Refactor",
|
|
179
|
+
description: "Refactoring skill with configurable scope and constraints.",
|
|
180
|
+
category: "maintenance",
|
|
181
|
+
variables: [
|
|
182
|
+
{ name: "scope", description: "What to refactor: file, module, or architectural pattern", required: true },
|
|
183
|
+
{ name: "constraints", description: "Constraints to respect during refactoring", required: false, defaultValue: "preserve public API, maintain backward compatibility" },
|
|
184
|
+
{ name: "goal", description: "Primary refactoring goal", required: false, defaultValue: "improve readability and reduce complexity", options: ["improve readability and reduce complexity", "improve performance", "reduce coupling", "enable extensibility", "simplify testability"] },
|
|
185
|
+
],
|
|
186
|
+
body: [
|
|
187
|
+
"---",
|
|
188
|
+
"description: Refactoring skill targeting {scope}",
|
|
189
|
+
"---",
|
|
190
|
+
"",
|
|
191
|
+
"# Refactor Skill",
|
|
192
|
+
"",
|
|
193
|
+
"You are a refactoring specialist working on **{scope}**.",
|
|
194
|
+
"",
|
|
195
|
+
"## Goal",
|
|
196
|
+
"",
|
|
197
|
+
"Primary objective: **{goal}**.",
|
|
198
|
+
"",
|
|
199
|
+
"## Constraints",
|
|
200
|
+
"",
|
|
201
|
+
"The following constraints must be respected:",
|
|
202
|
+
"",
|
|
203
|
+
"- {constraints}",
|
|
204
|
+
"",
|
|
205
|
+
"## Approach",
|
|
206
|
+
"",
|
|
207
|
+
"1. Understand the current code structure and all usages.",
|
|
208
|
+
"2. Plan the refactoring in small, reviewable steps.",
|
|
209
|
+
"3. Run existing tests after each step to verify correctness.",
|
|
210
|
+
"4. Add new tests if the refactoring introduces new behavior.",
|
|
211
|
+
"5. Document any architectural decisions made during the refactor.",
|
|
212
|
+
].join("\n"),
|
|
213
|
+
guardrails: [
|
|
214
|
+
"Do not change public API signatures without explicit approval.",
|
|
215
|
+
"Do not mix refactoring with feature changes.",
|
|
216
|
+
"Do not skip running tests between steps.",
|
|
217
|
+
],
|
|
218
|
+
};
|
|
219
|
+
|
|
220
|
+
const DOCUMENTATION_TEMPLATE: SkillTemplate = {
|
|
221
|
+
id: "documentation",
|
|
222
|
+
name: "Documentation",
|
|
223
|
+
description: "Documentation writing skill with configurable format and audience.",
|
|
224
|
+
category: "documentation",
|
|
225
|
+
variables: [
|
|
226
|
+
{ name: "format", description: "Documentation format to produce", required: true, options: ["markdown", "jsdoc", "rustdoc", "godoc", "pydoc", "openapi"] },
|
|
227
|
+
{ name: "audience", description: "Target audience for the documentation", required: false, defaultValue: "developers", options: ["developers", "operators", "end-users", "contributors", "architects"] },
|
|
228
|
+
{ name: "detailLevel", description: "Level of detail", required: false, defaultValue: "standard", options: ["brief", "standard", "comprehensive"] },
|
|
229
|
+
],
|
|
230
|
+
body: [
|
|
231
|
+
"---",
|
|
232
|
+
"description: Write {format} documentation for {audience}",
|
|
233
|
+
"---",
|
|
234
|
+
"",
|
|
235
|
+
"# Documentation Skill",
|
|
236
|
+
"",
|
|
237
|
+
"You are a technical writer producing **{format}** documentation",
|
|
238
|
+
"for **{audience}**.",
|
|
239
|
+
"",
|
|
240
|
+
"## Detail Level",
|
|
241
|
+
"",
|
|
242
|
+
"Detail level: **{detailLevel}**.",
|
|
243
|
+
"",
|
|
244
|
+
"## Guidelines",
|
|
245
|
+
"",
|
|
246
|
+
"1. Start with a brief summary of what the module/function does.",
|
|
247
|
+
"2. Document all public APIs with parameter descriptions and return types.",
|
|
248
|
+
"3. Include usage examples for non-trivial functionality.",
|
|
249
|
+
"4. Keep language clear and avoid unnecessary jargon.",
|
|
250
|
+
"5. Cross-reference related modules where applicable.",
|
|
251
|
+
].join("\n"),
|
|
252
|
+
guardrails: [
|
|
253
|
+
"Do not document private/internal APIs unless specifically requested.",
|
|
254
|
+
"Do not generate placeholder content — every section must be meaningful.",
|
|
255
|
+
"Do not duplicate information already present in existing docs.",
|
|
256
|
+
],
|
|
257
|
+
};
|
|
258
|
+
|
|
259
|
+
const BUILTIN_TEMPLATES: SkillTemplate[] = [
|
|
260
|
+
CODE_REVIEW_TEMPLATE,
|
|
261
|
+
TESTING_TEMPLATE,
|
|
262
|
+
SECURITY_AUDIT_TEMPLATE,
|
|
263
|
+
REFACTOR_TEMPLATE,
|
|
264
|
+
DOCUMENTATION_TEMPLATE,
|
|
265
|
+
];
|
|
266
|
+
|
|
267
|
+
// ---------------------------------------------------------------------------
|
|
268
|
+
// Public API
|
|
269
|
+
// ---------------------------------------------------------------------------
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* Return all builtin skill templates.
|
|
273
|
+
*/
|
|
274
|
+
export function getBuiltinTemplates(): SkillTemplate[] {
|
|
275
|
+
return BUILTIN_TEMPLATES;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Look up a builtin template by its id or name (case-insensitive).
|
|
280
|
+
*/
|
|
281
|
+
export function findTemplate(idOrName: string): SkillTemplate | undefined {
|
|
282
|
+
const lower = idOrName.toLowerCase();
|
|
283
|
+
return BUILTIN_TEMPLATES.find(
|
|
284
|
+
(t) => t.id.toLowerCase() === lower || t.name.toLowerCase() === lower,
|
|
285
|
+
);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Instantiate a skill template by filling in its variables.
|
|
290
|
+
*
|
|
291
|
+
* - Required variables that are missing throw an error.
|
|
292
|
+
* - Optional variables fall back to their `defaultValue` if not supplied.
|
|
293
|
+
* - Variables with `options` constrain the allowed values.
|
|
294
|
+
*
|
|
295
|
+
* @param template The template to instantiate.
|
|
296
|
+
* @param variables User-supplied variable values.
|
|
297
|
+
* @returns An object with the suggested filename and rendered content.
|
|
298
|
+
*/
|
|
299
|
+
export function instantiateTemplate(
|
|
300
|
+
template: SkillTemplate,
|
|
301
|
+
variables: Record<string, string>,
|
|
302
|
+
): InstantiatedSkill {
|
|
303
|
+
// Validate and resolve all variable values
|
|
304
|
+
const resolved: Record<string, string> = {};
|
|
305
|
+
|
|
306
|
+
for (const variable of template.variables) {
|
|
307
|
+
const value = variables[variable.name];
|
|
308
|
+
|
|
309
|
+
if (value === undefined || value === "") {
|
|
310
|
+
if (variable.required) {
|
|
311
|
+
throw new Error(
|
|
312
|
+
`Missing required variable "${variable.name}" for template "${template.id}" (${variable.description}).`,
|
|
313
|
+
);
|
|
314
|
+
}
|
|
315
|
+
resolved[variable.name] = variable.defaultValue ?? "";
|
|
316
|
+
continue;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
// Validate options constraint
|
|
320
|
+
if (variable.options !== undefined && !variable.options.includes(value)) {
|
|
321
|
+
throw new Error(
|
|
322
|
+
`Invalid value "${value}" for variable "${variable.name}" in template "${template.id}". ` +
|
|
323
|
+
`Allowed values: ${variable.options.join(", ")}.`,
|
|
324
|
+
);
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
resolved[variable.name] = value;
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
// Render the template body by replacing all {varName} placeholders
|
|
331
|
+
let content = template.body;
|
|
332
|
+
for (const [key, value] of Object.entries(resolved)) {
|
|
333
|
+
// Use a global regex to replace all occurrences of {key}
|
|
334
|
+
const placeholderRegex = new RegExp(`\\{${escapeRegExp(key)}\\}`, "g");
|
|
335
|
+
content = content.replace(placeholderRegex, value);
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
// Build filename from template id
|
|
339
|
+
const filename = `${template.id}.SKILL.md`;
|
|
340
|
+
|
|
341
|
+
return { filename, content };
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
/**
|
|
345
|
+
* Return a simplified list of available templates suitable for display.
|
|
346
|
+
* Each entry contains id, name, description, category, and variable names.
|
|
347
|
+
*/
|
|
348
|
+
export function listTemplates(): Array<{
|
|
349
|
+
id: string;
|
|
350
|
+
name: string;
|
|
351
|
+
description: string;
|
|
352
|
+
category: string;
|
|
353
|
+
variables: Array<{ name: string; required: boolean }>;
|
|
354
|
+
}> {
|
|
355
|
+
return BUILTIN_TEMPLATES.map((t) => ({
|
|
356
|
+
id: t.id,
|
|
357
|
+
name: t.name,
|
|
358
|
+
description: t.description,
|
|
359
|
+
category: t.category,
|
|
360
|
+
variables: t.variables.map((v) => ({ name: v.name, required: v.required })),
|
|
361
|
+
}));
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
// ---------------------------------------------------------------------------
|
|
365
|
+
// Internal helpers
|
|
366
|
+
// ---------------------------------------------------------------------------
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Escape special regex characters in a string so it can be used inside a
|
|
370
|
+
* RegExp constructor.
|
|
371
|
+
*/
|
|
372
|
+
function escapeRegExp(input: string): string {
|
|
373
|
+
return input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
374
|
+
}
|