kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-07 08:04:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: improve parsing logic for SKILL.md files and enhance error collection in validation

Browse Source
This commit is contained in:
Mohan Raj Rajamanickam 2026-03-11 15:56:32 -07:00
parent 6ba596d9fa
commit 4c9a9afb80
No known key found for this signature in database
GPG Key ID: 7CE83B7611FA8B8B
1 changed files with 22 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
scripts/validate-skills.ts
View File

@ -225,29 +225,25 @@ function getChangedSkillDirs(base: string): string[] {
}
/**
* Parses the YAML frontmatter block (`--- ... ---`) from a markdown file.
* Returns a flat key/value map, or `null` if no valid block is found.
* Wrapping quotes on values are stripped.
* Parses a SKILL.md file into its frontmatter fields and body.
* `frontmatter` is `null` if the `--- ... ---` block is missing or malformed.
* Wrapping quotes on frontmatter values are stripped.
*/
function parseFrontmatter(content: string): Record<string, string> | null {
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---/)
if (!match) return null
const result: Record<string, string> = {}
function parseSkillMd(content: string): { frontmatter: Record<string, string> | null; body: string } {
const match = content.match(/^---\r?\n([\s\S]*?)\r?\n---\r?\n?/)
if (!match) return { frontmatter: null, body: content }
const frontmatter: Record<string, string> = {}
for (const line of match[1].split(/\r?\n/)) {
const colonIdx = line.indexOf(":")
if (colonIdx === -1) continue
const key = line.slice(0, colonIdx).trim()
// Strip wrapping single or double quotes to match how consumers read values
const raw = line.slice(colonIdx + 1).trim()
result[key] = raw.replace(/^(['"])([\s\S]*)\1$/, "$2")
// Strip wrapping single or double quotes to match how consumers read values
frontmatter[key] = raw.replace(/^(['"])([\s\S]*)\1$/, "$2")
}
return result
}
/** Returns the character offset immediately after the closing `---` of the frontmatter block, or -1 if absent. */
function getFrontmatterEnd(content: string): number {
const match = content.match(/^---\r?\n[\s\S]*?\r?\n---\r?\n?/)
return match ? match[0].length : -1
return { frontmatter, body: content.slice(match[0].length) }
}
/**
@ -262,24 +258,26 @@ function validateSkill(dirName: string, dirPath: string): SkillResult {
const errors: string[] = []
const warnings: string[] = []
const collect = ({ errors: msgs, fatal, severity }: CheckResult): boolean => {
if (msgs.length === 0) return false
;(severity === "warning" ? warnings : errors).push(...msgs)
return !!fatal && severity !== "warning"
const collectIssues = (result: CheckResult): boolean => {
if (result.errors.length === 0) return false
if (result.severity === "warning") {
warnings.push(...result.errors)
} else {
errors.push(...result.errors)
}
return result.fatal === true && result.severity !== "warning"
}
for (const check of STRUCTURE_CHECKS) {
if (collect(check.run(dirName, dirPath))) return { errors, warnings }
if (collectIssues(check.run(dirName, dirPath))) return { errors, warnings }
}
const content = fs.readFileSync(path.join(dirPath, "SKILL.md"), "utf8")
const frontmatter = parseFrontmatter(content)
const frontmatterEnd = getFrontmatterEnd(content)
const body = frontmatterEnd !== -1 ? content.slice(frontmatterEnd) : ""
const { frontmatter, body } = parseSkillMd(content)
const ctx: SkillContext = { dirName, dirPath, content, frontmatter, body }
for (const check of CONTENT_CHECKS) {
if (collect(check.run(ctx))) return { errors, warnings }
if (collectIssues(check.run(ctx))) return { errors, warnings }
}
return { errors, warnings }