Abstract Class: MarkdownInstructionFormatter¶

renderer¶

sections¶

string[]

Returns¶

void

addSection()¶

protected addSection(sections, content): void

Defined in: formatters/src/markdown-instruction-formatter.ts:560

Parameters¶

sections¶

string[]

content¶

string | null

Returns¶

void

architecture()¶

protected architecture(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:659

Parameters¶

ast¶

renderer¶

Returns¶

string | null

codeStandards()¶

protected codeStandards(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:672

Parameters¶

ast¶

renderer¶

Returns¶

string | null

commands()¶

protected commands(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:728

Parameters¶

ast¶

renderer¶

Returns¶

string | null

configFiles()¶

protected configFiles(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:710

Parameters¶

ast¶

renderer¶

Returns¶

string | null

createRenderer()¶

protected createRenderer(options?): ConventionRenderer

Defined in: formatters/src/base-formatter.ts:34

Create a convention renderer for this formatter. Uses the provided convention from options or falls back to the default.

Parameters¶

dedent()¶

protected dedent(text): string

Defined in: formatters/src/base-formatter.ts:452

Remove common leading whitespace from all lines (dedent). Handles the case where trim() was already called, causing the first line to lose its indentation while subsequent lines retain theirs. Calculates minimum indent from lines 2+ only.

Parameters¶

text¶

string

Returns¶

string

Inherited from¶

BaseFormatter.dedent

diagrams()¶

protected diagrams(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:791

Parameters¶

ast¶

renderer¶

Returns¶

string | null

documentation()¶

protected documentation(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:772

Parameters¶

ast¶

renderer¶

Returns¶

string | null

examples()¶

protected examples(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:863

Parameters¶

ast¶

renderer¶

Returns¶

string | null

extractAgents()¶

protected extractAgents(ast): MarkdownAgentConfig[]

Defined in: formatters/src/markdown-instruction-formatter.ts:461

Parameters¶

ast¶

Returns¶

MarkdownAgentConfig[]

extractCommands()¶

protected extractCommands(ast): MarkdownCommandConfig[]

Defined in: formatters/src/markdown-instruction-formatter.ts:293

Parameters¶

ast¶

MarkdownCommandConfig[]

Returns¶

extractExamples()¶

protected extractExamples(ast): object[]

Defined in: formatters/src/base-formatter.ts:592

Extract examples from the

Parameters¶

ast¶

BaseFormatter.extractExamples

Returns¶

object[]

Examples¶

block. Returns an array of example definitions with name, input, output, and optional description.

Inherited from¶

extractRestrictionsItems()¶

protected extractRestrictionsItems(content): string[]

Defined in: formatters/src/markdown-instruction-formatter.ts:867

Parameters¶

content¶

BaseFormatter.extractSectionWithCodeBlock

Returns¶

string[]

extractSectionWithCodeBlock()¶

protected extractSectionWithCodeBlock(text, header): string | null

Defined in: formatters/src/base-formatter.ts:176

Safe extraction of a section that contains a header + content + code block + content Avoids ReDoS by using string search instead of backtracking regex. Matches pattern: Header ... ...

Parameters¶

text¶

string

Returns¶

string | null

Inherited from¶

extractSkillExamples()¶

protected extractSkillExamples(skillProps): object[]

Defined in: formatters/src/base-formatter.ts:605

Extract examples from a skill's nested examples property. Returns the same shape as extractExamples.

Parameters¶

skillProps¶

Record\<string, Value>

Returns¶

object[]

Inherited from¶

BaseFormatter.extractSkillExamples

extractSkills()¶

protected extractSkills(ast, options?): MarkdownSkillConfig[]

Defined in: formatters/src/markdown-instruction-formatter.ts:359

Parameters¶

ast¶

options?¶

Returns¶

MarkdownSkillConfig[]

extractTechStackFromContext()¶

protected extractTechStackFromContext(context): string[]

Defined in: formatters/src/markdown-instruction-formatter.ts:617

Parameters¶

context¶

Block | undefined

Returns¶

string[]

extractTechStackFromStandards()¶

protected extractTechStackFromStandards(standards): string[]

Defined in: formatters/src/markdown-instruction-formatter.ts:643

Parameters¶

standards¶

Block | undefined

Returns¶

string[]

extractText()¶

protected extractText(content): string

Defined in: formatters/src/base-formatter.ts:69

Extract text from block content.

Parameters¶

content¶

BaseFormatter.extractText

Returns¶

string

Inherited from¶

findBlock()¶

protected findBlock(ast, name): Block | undefined

Defined in: formatters/src/base-formatter.ts:62

Find a block by name, ignoring internal blocks (starting with __).

Parameters¶

ast¶

BaseFormatter.findBlock

name¶

string

Returns¶

Block | undefined

Inherited from¶

format()¶

format(ast, options?): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:150

Transform AST to tool-specific format

Parameters¶

ast¶

options?¶

Returns¶

BaseFormatter.formatArray

Overrides¶

BaseFormatter.format

formatArray()¶

protected formatArray(arr): string

Defined in: formatters/src/base-formatter.ts:120

Format an array as comma-separated string.

Parameters¶

arr¶

unknown[]

Returns¶

string

Inherited from¶

formatFull()¶

protected formatFull(ast, options?): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:234

Parameters¶

ast¶

options?¶

Returns¶

formatMultifile()¶

protected formatMultifile(ast, options?): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:198

Parameters¶

ast¶

options?¶

Returns¶

formatSimple()¶

protected formatSimple(ast, options?): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:178

Parameters¶

ast¶

options?¶

Returns¶

BaseFormatter.formatStandardsList

formatStandardsList()¶

protected formatStandardsList(items): string[]

Defined in: formatters/src/base-formatter.ts:112

Format standards list from array of values (pass-through). Returns array of strings for rendering as bullet list.

Parameters¶

items¶

Value

Returns¶

string[]

Inherited from¶

generateAgentFile()¶

protected generateAgentFile(config): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:485

Parameters¶

config¶

MarkdownAgentConfig

Returns¶

generateCommandFile()¶

protected generateCommandFile(config): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:332

Parameters¶

config¶

MarkdownCommandConfig

Returns¶

generateSkillFile()¶

protected generateSkillFile(config, options?): FormatterOutput

Defined in: formatters/src/markdown-instruction-formatter.ts:394

Parameters¶

config¶

MarkdownSkillConfig

options?¶

Returns¶

getArrayElements()¶

protected getArrayElements(content): Value[]

Defined in: formatters/src/base-formatter.ts:144

Extract array elements from block content.

Parameters¶

content¶

BaseFormatter.getArrayElements

Returns¶

Value[]

Inherited from¶

getMetaField()¶

protected getMetaField(ast, key): string | undefined

Defined in: formatters/src/base-formatter.ts:134

Get meta field value as string.

Parameters¶

ast¶

BaseFormatter.getMetaField

key¶

string

Returns¶

string | undefined

Inherited from¶

getOutputPath()¶

protected getOutputPath(options?): string

Defined in: formatters/src/base-formatter.ts:55

Get the output path, respecting options override.

Parameters¶

options?¶

BaseFormatter.getOutputPath

Returns¶

string

Inherited from¶

getPrettierOptions()¶

protected getPrettierOptions(options?): Required\<PrettierMarkdownOptions>

Defined in: formatters/src/base-formatter.ts:45

Get resolved Prettier options, merging provided options with defaults.

Parameters¶

options?¶

BaseFormatter.getPrettierOptions

Returns¶

Required\<PrettierMarkdownOptions>

Inherited from¶

getProp()¶

protected getProp(content, key): Value | undefined

Defined in: formatters/src/base-formatter.ts:83

Get a specific property from block content.

Parameters¶

content¶

BaseFormatter.getProp

key¶

string

Returns¶

Value | undefined

Inherited from¶

getProps()¶

protected getProps(content): Record\<string, Value>

Defined in: formatters/src/base-formatter.ts:97

Get all properties from block content.

Parameters¶

content¶

BaseFormatter.getProps

Returns¶

Record\<string, Value>

Inherited from¶

getSectionName()¶

protected getSectionName(key): string

Defined in: formatters/src/markdown-instruction-formatter.ts:277

Parameters¶

key¶

SectionNameKey

Returns¶

string

getSkillBasePath()¶

getSkillBasePath(): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:142

Base path for skills, or null if formatter has no skill support.

Returns¶

string | null

Overrides¶

BaseFormatter.getSkillBasePath

getSkillFileName()¶

getSkillFileName(): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:146

Skill file name, or null if formatter has no skill support.

Returns¶

string | null

Overrides¶

BaseFormatter.getSkillFileName

gitCommits()¶

protected gitCommits(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:688

Parameters¶

ast¶

renderer¶

BaseFormatter.isSafeSkillName

Returns¶

string | null

isSafeSkillName()¶

protected isSafeSkillName(name): boolean

Defined in: formatters/src/base-formatter.ts:682

Check if a skill name is safe for use in file paths.

Parameters¶

name¶

string

Returns¶

boolean

Inherited from¶

knowledgeContent()¶

protected knowledgeContent(ast, _renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:816

Render remaining

Parameters¶

ast¶

_renderer¶

BaseFormatter.normalizeMarkdownForPrettier

Returns¶

string | null

Knowledge¶

text content that isn't consumed by other sections. Strips "## Development Commands" and "## Post-Work Verification" sub-sections since those are already rendered by commands() and postWork().

normalizeMarkdownForPrettier()¶

protected normalizeMarkdownForPrettier(content): string

Defined in: formatters/src/base-formatter.ts:204

Normalize markdown content to match Prettier formatting. - Strips common leading indentation from lines - Trims trailing whitespace from lines - Normalizes markdown table formatting - Adds blank lines before lists when preceded by text - Adds blank lines before code blocks when preceded by text - Escapes markdown special characters in paths

Parameters¶

content¶

string

Returns¶

string

Inherited from¶

normalizeOutputDir()¶

protected normalizeOutputDir(dir): string

Defined in: formatters/src/base-formatter.ts:485

Normalize a user-provided output directory (from @use ... into "<path>" or skillTargets config) to a safe forward-slash relative path. Rejects .., . and leading slashes so the result can be appended to a target's dot-directory without escaping it.

Parameters¶

dir¶

string

Returns¶

string

Inherited from¶

BaseFormatter.normalizeOutputDir

postWork()¶

protected postWork(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:759

Parameters¶

ast¶

renderer¶

Returns¶

string | null

project()¶

protected project(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:564

Parameters¶

ast¶

renderer¶

BaseFormatter.referenceProvenance

Returns¶

string | null

referenceProvenance()¶

protected referenceProvenance(sourcePath): string

Defined in: formatters/src/base-formatter.ts:675

Generate a provenance comment for a reference file.

Parameters¶

sourcePath¶

string

Returns¶

string

Inherited from¶

referencesMode()¶

referencesMode(): "none" | "directory" | "inline"

Defined in: formatters/src/base-formatter.ts:668

How this formatter handles skill references. - 'directory': emit as separate files in references/ subdirectory - 'inline': append as sections in the main output file - 'none': references not supported

Returns¶

"none" | "directory" | "inline"

Inherited from¶

BaseFormatter.referencesMode

renderCodeFence()¶

protected renderCodeFence(content, lang?): string

Defined in: formatters/src/base-formatter.ts:690

Render content inside a code fence, using a longer fence if the content itself contains triple backticks (prevents code fence injection).

Parameters¶

content¶

string

lang?¶

string = ''

Returns¶

string

Inherited from¶

BaseFormatter.renderCodeFence

renderExamplesSection()¶

protected renderExamplesSection(ast, renderer, sectionName?): string | null

Defined in: formatters/src/base-formatter.ts:621

Render an examples section from the

Parameters¶

ast¶

renderer¶

BaseFormatter.renderExamplesSection

sectionName?¶

string = 'Examples'

Custom section heading name (default: 'Examples')

Returns¶

string | null

Examples¶

block. Shared rendering logic used by Claude, GitHub, and MarkdownInstructionFormatter.

Inherited from¶

resolveSkillDir()¶

protected resolveSkillDir(defaultSkillBasePath, skillName, outputDir?, options?): string

Defined in: formatters/src/base-formatter.ts:509

Resolve the directory for a generated skill, respecting per-target skill base overrides while preserving existing @use ... into behavior.

Parameters¶

defaultSkillBasePath¶

string

skillName¶

string

outputDir?¶

string

options?¶

BaseFormatter.resolveSkillDir

Returns¶

string

Inherited from¶

resolveVersion()¶

protected resolveVersion(version?): MarkdownVersion

Defined in: formatters/src/markdown-instruction-formatter.ts:168

Parameters¶

version?¶

string

Returns¶

MarkdownVersion

restrictions()¶

protected restrictions(ast, renderer): string | null

Defined in: formatters/src/markdown-instruction-formatter.ts:853

Parameters¶

ast¶

renderer¶

BaseFormatter.sanitizeResourceFiles

Returns¶

string | null

sanitizeResourceFiles()¶

protected sanitizeResourceFiles(resources, targetDir): FormatterOutput[]

Defined in: formatters/src/base-formatter.ts:543

Filter resource files to only include safe paths. Rejects paths with traversal, absolute paths, and unsafe names.

Parameters¶

resources¶

object[] | undefined

targetDir¶

string

Returns¶

FormatterOutput[]

Inherited from¶

shouldIncludeSkill()¶

protected shouldIncludeSkill(name, options?): boolean

Defined in: formatters/src/base-formatter.ts:498

Return true when the target configuration allows emitting the given skill.

Parameters¶

name¶

string

options?¶