Skip to content

Commit e9eed2e

Browse files
committed
fix(skills): safely serialize skill frontmatter
1 parent 3a4006a commit e9eed2e

11 files changed

Lines changed: 273 additions & 37 deletions

File tree

‎packages/types/src/skills.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ export interface SkillMetadata {
2020
modeSlugs?: string[]
2121
}
2222

23+
/** A user-actionable problem found while loading a SKILL.md file. */
24+
export interface SkillDiagnostic {
25+
path: string
26+
source: "global" | "project"
27+
message: string
28+
line?: number
29+
column?: number
30+
}
31+
2332
/**
2433
* Skill name validation constants per agentskills.io specification:
2534
* https://agentskills.io/specification

‎packages/types/src/vscode-extension-host.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import type { GitCommit } from "./git.js"
1414
import type { McpServer } from "./mcp.js"
1515
import type { ModelRecord, RouterModels } from "./model.js"
1616
import type { OpenAiCodexRateLimitInfo } from "./providers/openai-codex-rate-limits.js"
17-
import type { SkillMetadata } from "./skills.js"
17+
import type { SkillDiagnostic, SkillMetadata } from "./skills.js"
1818
import type { RuleMetadata } from "./rules.js"
1919
import type { TelemetrySetting } from "./telemetry.js"
2020
import type { WorktreeIncludeStatus } from "./worktree.js"
@@ -180,6 +180,7 @@ export interface ExtensionMessage {
180180
list?: string[] // For dismissedUpsells
181181
tools?: SerializedCustomToolDefinition[] // For customToolsResult
182182
skills?: SkillMetadata[] // For skills response
183+
skillDiagnostics?: SkillDiagnostic[] // For malformed skills omitted from the skills response
183184
rules?: RuleMetadata[] // For rules response
184185
modes?: { slug: string; name: string }[] // For modes response
185186
rooHistoryImportProgress?: {

‎src/core/webview/__tests__/skillsMessageHandler.spec.ts‎

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ describe("skillsMessageHandler", () => {
4747
const mockLog = vi.fn()
4848
const mockPostMessageToWebview = vi.fn()
4949
const mockGetSkillsMetadata = vi.fn()
50+
const mockGetSkillDiagnostics = vi.fn()
5051
const mockCreateSkill = vi.fn()
5152
const mockDeleteSkill = vi.fn()
5253
const mockMoveSkill = vi.fn()
@@ -57,6 +58,7 @@ describe("skillsMessageHandler", () => {
5758
const skillsManager = hasSkillsManager
5859
? {
5960
getSkillsMetadata: mockGetSkillsMetadata,
61+
getSkillDiagnostics: mockGetSkillDiagnostics,
6062
createSkill: mockCreateSkill,
6163
deleteSkill: mockDeleteSkill,
6264
moveSkill: mockMoveSkill,
@@ -90,6 +92,7 @@ describe("skillsMessageHandler", () => {
9092

9193
beforeEach(() => {
9294
vi.clearAllMocks()
95+
mockGetSkillDiagnostics.mockReturnValue([])
9396
})
9497

9598
describe("handleRequestSkills", () => {
@@ -100,7 +103,34 @@ describe("skillsMessageHandler", () => {
100103
const result = await handleRequestSkills(provider)
101104

102105
expect(result).toEqual(mockSkills)
103-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: mockSkills })
106+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
107+
type: "skills",
108+
skills: mockSkills,
109+
skillDiagnostics: [],
110+
})
111+
})
112+
113+
it("sends structured malformed-skill diagnostics without hiding valid skills", async () => {
114+
const provider = createMockProvider(true)
115+
const diagnostics = [
116+
{
117+
path: "/workspace/.roo/skills/broken/SKILL.md",
118+
source: "project" as const,
119+
message: "bad indentation of a mapping entry",
120+
line: 3,
121+
column: 20,
122+
},
123+
]
124+
mockGetSkillsMetadata.mockReturnValue(mockSkills)
125+
mockGetSkillDiagnostics.mockReturnValue(diagnostics)
126+
127+
await handleRequestSkills(provider)
128+
129+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
130+
type: "skills",
131+
skills: mockSkills,
132+
skillDiagnostics: diagnostics,
133+
})
104134
})
105135

106136
it("returns empty skills when skills manager is not available", async () => {
@@ -109,7 +139,11 @@ describe("skillsMessageHandler", () => {
109139
const result = await handleRequestSkills(provider)
110140

111141
expect(result).toEqual([])
112-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: [] })
142+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
143+
type: "skills",
144+
skills: [],
145+
skillDiagnostics: [],
146+
})
113147
})
114148

115149
it("handles errors and returns empty skills", async () => {
@@ -122,7 +156,11 @@ describe("skillsMessageHandler", () => {
122156

123157
expect(result).toEqual([])
124158
expect(mockLog).toHaveBeenCalled()
125-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: [] })
159+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
160+
type: "skills",
161+
skills: [],
162+
skillDiagnostics: [],
163+
})
126164
})
127165
})
128166

@@ -142,7 +180,11 @@ describe("skillsMessageHandler", () => {
142180
expect(result).toEqual(mockSkills)
143181
expect(mockCreateSkill).toHaveBeenCalledWith("new-skill", "global", "New skill description", undefined)
144182
expect(openFile).toHaveBeenCalledWith("/path/to/new-skill/SKILL.md")
145-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: mockSkills })
183+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
184+
type: "skills",
185+
skills: mockSkills,
186+
skillDiagnostics: [],
187+
})
146188
})
147189

148190
it("creates a skill with mode restriction", async () => {
@@ -212,7 +254,11 @@ describe("skillsMessageHandler", () => {
212254

213255
expect(result).toEqual([mockSkills[1]])
214256
expect(mockDeleteSkill).toHaveBeenCalledWith("test-skill", "global", undefined)
215-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: [mockSkills[1]] })
257+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
258+
type: "skills",
259+
skills: [mockSkills[1]],
260+
skillDiagnostics: [],
261+
})
216262
})
217263

218264
it("deletes a skill with mode restriction", async () => {
@@ -280,7 +326,11 @@ describe("skillsMessageHandler", () => {
280326

281327
expect(result).toEqual([mockSkills[0]])
282328
expect(mockMoveSkill).toHaveBeenCalledWith("test-skill", "global", undefined, "code")
283-
expect(mockPostMessageToWebview).toHaveBeenCalledWith({ type: "skills", skills: [mockSkills[0]] })
329+
expect(mockPostMessageToWebview).toHaveBeenCalledWith({
330+
type: "skills",
331+
skills: [mockSkills[0]],
332+
skillDiagnostics: [],
333+
})
284334
})
285335

286336
it("moves a skill from one mode to another", async () => {

‎src/core/webview/skillsMessageHandler.ts‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ export async function handleRequestSkills(provider: ClineProvider): Promise<Skil
1616
const skillsManager = provider.getSkillsManager()
1717
if (skillsManager) {
1818
const skills = skillsManager.getSkillsMetadata()
19-
await provider.postMessageToWebview({ type: "skills", skills })
19+
const skillDiagnostics = skillsManager.getSkillDiagnostics()
20+
await provider.postMessageToWebview({ type: "skills", skills, skillDiagnostics })
2021
return skills
2122
} else {
22-
await provider.postMessageToWebview({ type: "skills", skills: [] })
23+
await provider.postMessageToWebview({ type: "skills", skills: [], skillDiagnostics: [] })
2324
return []
2425
}
2526
} catch (error) {
2627
provider.log(`Error fetching skills: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`)
27-
await provider.postMessageToWebview({ type: "skills", skills: [] })
28+
await provider.postMessageToWebview({ type: "skills", skills: [], skillDiagnostics: [] })
2829
return []
2930
}
3031
}
@@ -59,7 +60,8 @@ export async function handleCreateSkill(
5960

6061
// Send updated skills list
6162
const skills = skillsManager.getSkillsMetadata()
62-
await provider.postMessageToWebview({ type: "skills", skills })
63+
const skillDiagnostics = skillsManager.getSkillDiagnostics()
64+
await provider.postMessageToWebview({ type: "skills", skills, skillDiagnostics })
6365
return skills
6466
} catch (error) {
6567
const errorMessage = error instanceof Error ? error.message : String(error)
@@ -95,7 +97,8 @@ export async function handleDeleteSkill(
9597

9698
// Send updated skills list
9799
const skills = skillsManager.getSkillsMetadata()
98-
await provider.postMessageToWebview({ type: "skills", skills })
100+
const skillDiagnostics = skillsManager.getSkillDiagnostics()
101+
await provider.postMessageToWebview({ type: "skills", skills, skillDiagnostics })
99102
return skills
100103
} catch (error) {
101104
const errorMessage = error instanceof Error ? error.message : String(error)
@@ -131,7 +134,8 @@ export async function handleMoveSkill(
131134

132135
// Send updated skills list
133136
const skills = skillsManager.getSkillsMetadata()
134-
await provider.postMessageToWebview({ type: "skills", skills })
137+
const skillDiagnostics = skillsManager.getSkillDiagnostics()
138+
await provider.postMessageToWebview({ type: "skills", skills, skillDiagnostics })
135139
return skills
136140
} catch (error) {
137141
const errorMessage = error instanceof Error ? error.message : String(error)
@@ -166,7 +170,8 @@ export async function handleUpdateSkillModes(
166170

167171
// Send updated skills list
168172
const skills = skillsManager.getSkillsMetadata()
169-
await provider.postMessageToWebview({ type: "skills", skills })
173+
const skillDiagnostics = skillsManager.getSkillDiagnostics()
174+
await provider.postMessageToWebview({ type: "skills", skills, skillDiagnostics })
170175
return skills
171176
} catch (error) {
172177
const errorMessage = error instanceof Error ? error.message : String(error)

‎src/services/skills/SkillsManager.ts‎

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import matter from "gray-matter"
66
import type { ClineProvider } from "../../core/webview/ClineProvider"
77
import { getGlobalRooDirectory, getGlobalAgentsDirectory, getProjectAgentsDirectoryForCwd } from "../roo-config"
88
import { directoryExists, fileExists } from "../roo-config"
9-
import { SkillMetadata, SkillContent } from "../../shared/skills"
9+
import { SkillMetadata, SkillContent, SkillDiagnostic } from "../../shared/skills"
1010
import { modes, getAllModes } from "../../shared/modes"
1111
import {
1212
validateSkillName as validateSkillNameShared,
@@ -16,10 +16,11 @@ import {
1616
import { t } from "../../i18n"
1717

1818
// Re-export for convenience
19-
export type { SkillMetadata, SkillContent }
19+
export type { SkillMetadata, SkillContent, SkillDiagnostic }
2020

2121
export class SkillsManager {
2222
private skills: Map<string, SkillMetadata> = new Map()
23+
private diagnostics: SkillDiagnostic[] = []
2324
private providerRef: WeakRef<ClineProvider>
2425
private disposables: vscode.Disposable[] = []
2526
private isDisposed = false
@@ -42,6 +43,7 @@ export class SkillsManager {
4243
*/
4344
async discoverSkills(): Promise<void> {
4445
this.skills.clear()
46+
this.diagnostics = []
4547
const skillsDirs = await this.getSkillsDirectories()
4648

4749
for (const { dir, source, mode } of skillsDirs) {
@@ -100,9 +102,17 @@ export class SkillsManager {
100102

101103
try {
102104
const fileContent = await fs.readFile(skillMdPath, "utf-8")
105+
let parsed: ReturnType<typeof matter>
103106

104-
// Use gray-matter to parse frontmatter
105-
const { data: frontmatter, content: body } = matter(fileContent)
107+
try {
108+
parsed = matter(fileContent)
109+
} catch (error) {
110+
this.recordDiagnostic(skillMdPath, source, error)
111+
console.error(`Failed to parse skill at ${skillDir}:`, error)
112+
return
113+
}
114+
115+
const { data: frontmatter } = parsed
106116

107117
// Validate required fields (only name and description for now)
108118
if (!frontmatter.name || typeof frontmatter.name !== "string") {
@@ -175,6 +185,20 @@ export class SkillsManager {
175185
}
176186
}
177187

188+
private recordDiagnostic(path: string, source: "global" | "project", error: unknown): void {
189+
const yamlError = error as {
190+
reason?: unknown
191+
message?: unknown
192+
mark?: { line?: unknown; column?: unknown }
193+
}
194+
const reason = typeof yamlError.reason === "string" ? yamlError.reason : undefined
195+
const errorMessage = error instanceof Error ? error.message.split("\n", 1)[0] : String(error)
196+
const line = typeof yamlError.mark?.line === "number" ? yamlError.mark.line + 1 : undefined
197+
const column = typeof yamlError.mark?.column === "number" ? yamlError.mark.column + 1 : undefined
198+
199+
this.diagnostics.push({ path, source, message: reason ?? errorMessage, line, column })
200+
}
201+
178202
/**
179203
* Get skills available for the current mode.
180204
* Resolves overrides: project > global, mode-specific > generic.
@@ -290,6 +314,10 @@ export class SkillsManager {
290314
return this.getAllSkills()
291315
}
292316

317+
getSkillDiagnostics(): SkillDiagnostic[] {
318+
return [...this.diagnostics]
319+
}
320+
293321
/**
294322
* Get a skill by name, source, and optionally mode
295323
*/
@@ -394,25 +422,19 @@ export class SkillsManager {
394422
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
395423
.join(" ")
396424

397-
// Build frontmatter with optional modeSlugs
398-
const frontmatterLines = [`name: ${name}`, `description: ${trimmedDescription}`]
399-
if (modeSlugs && modeSlugs.length > 0) {
400-
frontmatterLines.push(`modeSlugs:`)
401-
for (const slug of modeSlugs) {
402-
frontmatterLines.push(` - ${slug}`)
403-
}
425+
const frontmatter = {
426+
name,
427+
description: trimmedDescription,
428+
...(modeSlugs && modeSlugs.length > 0 ? { modeSlugs } : {}),
404429
}
405-
406-
const skillContent = `---
407-
${frontmatterLines.join("\n")}
408-
---
409-
430+
const body = `
410431
# ${titleName}
411432
412433
## Instructions
413434
414435
Add your skill instructions here.
415436
`
437+
const skillContent = matter.stringify(body, frontmatter)
416438

417439
// Write the SKILL.md file
418440
await fs.writeFile(skillMdPath, skillContent, "utf-8")

0 commit comments

Comments
 (0)