Skip to content

TraeFormatter

PromptScript API


Defined in: formatters/src/formatters/trae.ts:32

Abstract base class for markdown-based instruction formatters.

Provides shared section extraction logic (project, tech stack, architecture, code standards, git commits, config files, commands, post-work, documentation, diagrams, restrictions) and standard simple/multifile/full mode implementations.

Subclasses configure behavior via MarkdownFormatterConfig and can override specific methods for format-specific customization.

Extends

Constructors

Constructor

new TraeFormatter(): TraeFormatter

Defined in: formatters/src/formatters/trae.ts:33

Returns

TraeFormatter

Overrides

MarkdownInstructionFormatter.constructor

Properties

config

protected readonly config: MarkdownFormatterConfig

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

Inherited from

MarkdownInstructionFormatter.config


defaultConvention

readonly defaultConvention: string

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

Default convention for this formatter

Inherited from

MarkdownInstructionFormatter.defaultConvention


description

readonly description: string

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

Human-readable description

Inherited from

MarkdownInstructionFormatter.description


name

readonly name: string

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

Unique formatter identifier

Inherited from

MarkdownInstructionFormatter.name


outputPath

readonly outputPath: string

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

Default output file path

Inherited from

MarkdownInstructionFormatter.outputPath


standardsExtractor

protected readonly standardsExtractor: StandardsExtractor

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

Shared standards extractor for consistent extraction across all formatters.

Inherited from

MarkdownInstructionFormatter.standardsExtractor


CONTEXT_RENDERED_KEYS

protected readonly static CONTEXT_RENDERED_KEYS: ReadonlySet<string>

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

@context keys that already have a dedicated rendering path. Anything outside this set is generic and must be surfaced by the context section.

Inherited from

MarkdownInstructionFormatter.CONTEXT_RENDERED_KEYS

Methods

addCommonSections()

protected addCommonSections(ast, renderer, sections): void

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

Parameters

ast

Program

renderer

ConventionRenderer

sections

string[]

Returns

void

Inherited from

MarkdownInstructionFormatter.addCommonSections


addSection()

protected addSection(sections, content): void

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

Parameters

sections

string[]

content

string | null

Returns

void

Inherited from

MarkdownInstructionFormatter.addSection


appendGenericStandardItems()

protected appendGenericStandardItems(items, props, knownKeys): void

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

Append generic Label: value items for standards keys not handled by the known-key rendering in a section method. Keeps custom

Parameters

items

string[]

props

Record<string, Value>

knownKeys

ReadonlySet<string>

Returns

void

Standards

keys (git/config/documentation/diagrams) visible in monolith output. Skips null/undefined/false; renders bare labels for true.

Inherited from

MarkdownInstructionFormatter.appendGenericStandardItems


architecture()

protected architecture(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.architecture


codeStandards()

protected codeStandards(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.codeStandards


commands()

protected commands(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.commands


configFiles()

protected configFiles(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.configFiles


context()

protected context(ast, renderer): string | null

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

Render

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Context

block text content as a ”## Context” section.

The ”## Architecture” subsection (with code block) is stripped because it is already rendered separately by architecture. Remaining headings are shifted below h2, keeping their relative levels, to avoid clashing with the formatter’s own h2 section headings. When no

Identity

block exists, the project() fallback already consumes the full

Context

text, so only the generic properties are rendered to avoid duplication.

Inherited from

MarkdownInstructionFormatter.context


contextArchitectureProperty()

protected contextArchitectureProperty(ast): string | null

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

Read the architecture property of @context. Used as a fallback for sources that declare architecture as a property rather than as an ## Architecture heading inside the block text.

Parameters

ast

Program

Returns

string | null

Inherited from

MarkdownInstructionFormatter.contextArchitectureProperty


contextPropertyItems()

protected contextPropertyItems(ast, alsoRenderedKeys?): string[]

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

Render @context properties that no dedicated section consumes as Label: value items, so structured context is never silently dropped.

Parameters

ast

Program

alsoRenderedKeys?

readonly string[] = []

Returns

string[]

Inherited from

MarkdownInstructionFormatter.contextPropertyItems


contextTextConsumedByProject()

protected contextTextConsumedByProject(ast): boolean

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

Whether the @context block’s text is consumed by the project/intro fallback. Must mirror the project() and intro() consumption conditions exactly, otherwise the context section would either duplicate the text (predicate too narrow) or drop it entirely (predicate too wide).

Parameters

ast

Program

Returns

boolean

Inherited from

MarkdownInstructionFormatter.contextTextConsumedByProject


createRenderer()

protected createRenderer(options?): ConventionRenderer

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

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

Parameters

options?

FormatOptions

Returns

ConventionRenderer

Inherited from

MarkdownInstructionFormatter.createRenderer


dedent()

protected dedent(text): string

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

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

MarkdownInstructionFormatter.dedent


diagrams()

protected diagrams(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.diagrams


documentation()

protected documentation(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.documentation


documentationItem()

protected documentationItem(value, defaultText): string | null

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

Resolve a documentation-standard entry that accepts either a boolean flag or author-supplied prose. A string value is authoritative and replaces the target’s default phrasing, so authored text is never silently discarded.

Parameters

value

Value | undefined

defaultText

string

Returns

string | null

Inherited from

MarkdownInstructionFormatter.documentationItem


examples()

protected examples(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.examples


extractAgents()

protected extractAgents(ast, _options?): MarkdownAgentConfig[]

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

Parameters

ast

Program

_options?

FormatOptions

Returns

MarkdownAgentConfig[]

Inherited from

MarkdownInstructionFormatter.extractAgents


extractCommands()

protected extractCommands(ast): MarkdownCommandConfig[]

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

Parameters

ast

Program

Returns

MarkdownCommandConfig[]

Inherited from

MarkdownInstructionFormatter.extractCommands


extractContextTechStackItems()

protected extractContextTechStackItems(props): string[]

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

Collect @context tech-stack entries from every supported shape: an explicit techStack list plus the languages/runtime/monorepo properties.

Parameters

props

Record<string, Value>

Returns

string[]

Inherited from

MarkdownInstructionFormatter.extractContextTechStackItems


extractExamples()

protected extractExamples(ast): object[]

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

Extract examples from the

Parameters

ast

Program

Returns

object[]

Examples

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

Inherited from

MarkdownInstructionFormatter.extractExamples


extractRestrictionsItems()

protected extractRestrictionsItems(block): string[]

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

Parameters

block

Block

Returns

string[]

Inherited from

MarkdownInstructionFormatter.extractRestrictionsItems


extractSectionWithCodeBlock()

protected extractSectionWithCodeBlock(text, header): string | null

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

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

string

Returns

string | null

Inherited from

MarkdownInstructionFormatter.extractSectionWithCodeBlock


extractSkillExamples()

protected extractSkillExamples(skillProps): object[]

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

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

Parameters

skillProps

Record<string, Value>

Returns

object[]

Inherited from

MarkdownInstructionFormatter.extractSkillExamples


extractSkills()

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

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

Extract skills from the

Parameters

ast

Program

options?

FormatOptions

Returns

SkillFileConfig[]

Skills

block, skipping unsafe names and skills excluded by the target’s skill filter.

Inherited from

MarkdownInstructionFormatter.extractSkills


extractTechStackFromContext()

protected extractTechStackFromContext(context): string[]

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

Parameters

context

Block | undefined

Returns

string[]

Inherited from

MarkdownInstructionFormatter.extractTechStackFromContext


extractTechStackFromStandards()

protected extractTechStackFromStandards(standards): string[]

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

Parameters

standards

Block | undefined

Returns

string[]

Inherited from

MarkdownInstructionFormatter.extractTechStackFromStandards


extractText()

protected extractText(content): string

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

Extract text from block content.

Parameters

content

BlockContent

Returns

string

Inherited from

MarkdownInstructionFormatter.extractText


findBlock()

protected findBlock(ast, name): Block | undefined

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

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

Parameters

ast

Program

name

string

Returns

Block | undefined

Inherited from

MarkdownInstructionFormatter.findBlock


format()

format(input, options?): FormatterOutput

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

Transform AST to target format

Parameters

input

Program

options?

FormatOptions

Returns

FormatterOutput

Inherited from

MarkdownInstructionFormatter.format


formatArray()

protected formatArray(arr): string

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

Format an array as comma-separated string.

Parameters

arr

unknown[]

Returns

string

Inherited from

MarkdownInstructionFormatter.formatArray


formatCanonical()

formatCanonical(ast, options?): FormatterOutput

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

Canonical entry point for legacy implementations.

Subclasses can override this method to consume ordered canonical entries directly. Until then, keep the compatibility projection isolated here.

Parameters

ast

CanonicalProgram

options?

FormatOptions

Returns

FormatterOutput

Inherited from

MarkdownInstructionFormatter.formatCanonical


formatFull()

protected formatFull(ast, options?): FormatterOutput

Defined in: formatters/src/formatters/trae.ts:60

Parameters

ast

Program

options?

FormatOptions

Returns

FormatterOutput

Overrides

MarkdownInstructionFormatter.formatFull


formatMultifile()

protected formatMultifile(ast, options?): FormatterOutput

Defined in: formatters/src/formatters/trae.ts:56

Parameters

ast

Program

options?

FormatOptions

Returns

FormatterOutput

Overrides

MarkdownInstructionFormatter.formatMultifile


formatSimple()

protected formatSimple(ast, options?): FormatterOutput

Defined in: formatters/src/formatters/trae.ts:52

Parameters

ast

Program

options?

FormatOptions

Returns

FormatterOutput

Overrides

MarkdownInstructionFormatter.formatSimple


formatStandardsList()

protected formatStandardsList(items): string[]

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

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

MarkdownInstructionFormatter.formatStandardsList


generateAgentFile()

protected generateAgentFile(config): FormatterOutput

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

Parameters

config

MarkdownAgentConfig

Returns

FormatterOutput

Inherited from

MarkdownInstructionFormatter.generateAgentFile


generateCommandFile()

protected generateCommandFile(config): FormatterOutput

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

Parameters

config

MarkdownCommandConfig

Returns

FormatterOutput

Inherited from

MarkdownInstructionFormatter.generateCommandFile


generateFrontmatter()

protected generateFrontmatter(_ast, _options?): string | undefined

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

Parameters

_ast

Program

_options?

FormatOptions

Returns

string | undefined

Inherited from

MarkdownInstructionFormatter.generateFrontmatter


generateMcpConfig()

protected generateMcpConfig(ast): FormatterOutput | undefined

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

Generate MCP config file from

Parameters

ast

Program

Returns

FormatterOutput | undefined

Mcp Servers

block if configured. Returns FormatterOutput or undefined if no MCP block or no config path.

Inherited from

MarkdownInstructionFormatter.generateMcpConfig


generateSkillFile()

protected generateSkillFile(config, options?): FormatterOutput | null

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

Render a skill file at the target’s skill base path. Returns null when the target declares no skill support.

Parameters

config

SkillFileConfig

options?

FormatOptions

Returns

FormatterOutput | null

Inherited from

MarkdownInstructionFormatter.generateSkillFile


getArrayElements()

protected getArrayElements(content): Value[]

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

Extract array elements from block content.

Parameters

content

BlockContent

Returns

Value[]

Inherited from

MarkdownInstructionFormatter.getArrayElements


getBlockArrayElements()

protected getBlockArrayElements(block): Value[]

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

Parameters

block

Block

Returns

Value[]

Inherited from

MarkdownInstructionFormatter.getBlockArrayElements


getDotDir()

getDotDir(): string | null

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

Dot directory of the target, by default the parent of a <dir>/skills skill base path, or null when there is none.

Returns

string | null

Inherited from

MarkdownInstructionFormatter.getDotDir


getMetaField()

protected getMetaField(ast, key): string | undefined

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

Get meta field value as string.

Parameters

ast

Program

key

string

Returns

string | undefined

Inherited from

MarkdownInstructionFormatter.getMetaField


getNativeAgentName()

protected getNativeAgentName(ast, name): string

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

Return the deterministic native identifier for one agent.

Parameters

ast

Program

name

string

Returns

string

Inherited from

MarkdownInstructionFormatter.getNativeAgentName


getNativeAgentNameMap()

protected getNativeAgentNameMap(ast): ReadonlyMap<string, string>

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

Map all agent names consistently for a target’s native files.

Parameters

ast

Program

Returns

ReadonlyMap<string, string>

Inherited from

MarkdownInstructionFormatter.getNativeAgentNameMap


getOutputPath()

protected getOutputPath(options?): string

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

Get the output path, respecting options override.

Parameters

options?

FormatOptions

Returns

string

Inherited from

MarkdownInstructionFormatter.getOutputPath


getPrettierOptions()

protected getPrettierOptions(options?): Required<PrettierMarkdownOptions>

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

Get resolved Prettier options, merging provided options with defaults.

Parameters

options?

FormatOptions

Returns

Required<PrettierMarkdownOptions>

Inherited from

MarkdownInstructionFormatter.getPrettierOptions


getProp()

protected getProp(content, key): Value | undefined

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

Get a specific property from block content.

Parameters

content

BlockContent

key

string

Returns

Value | undefined

Inherited from

MarkdownInstructionFormatter.getProp


getProps()

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

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

Get all properties from block content.

Parameters

content

BlockContent

Returns

Record<string, Value>

Inherited from

MarkdownInstructionFormatter.getProps


getRenderedSectionName()

protected getRenderedSectionName(ast, key, renderer, defaultTitle?): string

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

Parameters

ast

Program

key

SectionNameKey

renderer

ConventionRenderer

defaultTitle?

string

Returns

string

Inherited from

MarkdownInstructionFormatter.getRenderedSectionName


getSectionName()

protected getSectionName(ast, key, defaultTitle?): string

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

Parameters

ast

Program

key

SectionNameKey

defaultTitle?

string

Returns

string

Inherited from

MarkdownInstructionFormatter.getSectionName


getSkillBasePath()

getSkillBasePath(): string | null

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

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

Returns

string | null

Inherited from

MarkdownInstructionFormatter.getSkillBasePath


getSkillFileName()

getSkillFileName(): string | null

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

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

Returns

string | null

Inherited from

MarkdownInstructionFormatter.getSkillFileName


getUnsupportedBlockSuggestion()

protected getUnsupportedBlockSuggestion(blockName): string

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

Provide a safe migration path for an omitted block.

Parameters

blockName

string

Returns

string

Inherited from

MarkdownInstructionFormatter.getUnsupportedBlockSuggestion


getUnsupportedBlockWarnings()

protected getUnsupportedBlockWarnings(ast, skippedBlocks?): FormatterWarning[]

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

Report blocks that have no verified project-local output contract. Native target files are never invented for these blocks.

Parameters

ast

Program

skippedBlocks?

ReadonlySet<string> = ...

Returns

FormatterWarning[]

Inherited from

MarkdownInstructionFormatter.getUnsupportedBlockWarnings


gitCommits()

protected gitCommits(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.gitCommits


hasEnabledHooks()

protected hasEnabledHooks(ast): boolean

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

Parameters

ast

Program

Returns

boolean

Inherited from

MarkdownInstructionFormatter.hasEnabledHooks


humanizeLabel()

protected humanizeLabel(value): string

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

Convert a camelCase/kebab-case key into a human-readable label.

Parameters

value

string

Returns

string

Inherited from

MarkdownInstructionFormatter.humanizeLabel


isBlockUnsupported()

protected isBlockUnsupported(blockName): boolean

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

Parameters

blockName

string

Returns

boolean

Inherited from

MarkdownInstructionFormatter.isBlockUnsupported


isSafeAgentName()

protected isSafeAgentName(name): boolean

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

Check if an agent name is safe for use in file paths.

Parameters

name

string

Returns

boolean

Inherited from

MarkdownInstructionFormatter.isSafeAgentName


isSafeName()

protected isSafeName(name): boolean

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

Check if a name is safe for use in file paths. Rejects path traversal sequences and path separators.

Parameters

name

string

Returns

boolean

Inherited from

MarkdownInstructionFormatter.isSafeName


isSafeSkillName()

protected isSafeSkillName(name): boolean

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

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

Parameters

name

string

Returns

boolean

Inherited from

MarkdownInstructionFormatter.isSafeSkillName


knowledgeContent()

protected knowledgeContent(ast, renderer, includeResolvedTitle?): string | null

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

Render remaining

Parameters

ast

Program

renderer

ConventionRenderer

includeResolvedTitle?

boolean = true

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().

Inherited from

MarkdownInstructionFormatter.knowledgeContent


mergeRequiredSkillFrontmatter()

protected mergeRequiredSkillFrontmatter(rawFrontmatter, name, description): string

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

Preserve raw skill frontmatter while supplying mandatory skill fields.

Parameters

rawFrontmatter

string

name

string

description

string

Returns

string

Inherited from

MarkdownInstructionFormatter.mergeRequiredSkillFrontmatter


normalizeMarkdownForPrettier()

protected normalizeMarkdownForPrettier(content): string

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

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

The result must keep the meaning of the input: table cells, code spans and list nesting (including tight lists) are never changed.

With verbatimMarkdown (formatting.postFormat: false) only the common indentation is removed and the text stays as written.

Parameters

content

string

Returns

string

Inherited from

MarkdownInstructionFormatter.normalizeMarkdownForPrettier


normalizeOutputDir()

protected normalizeOutputDir(dir): string

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

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

MarkdownInstructionFormatter.normalizeOutputDir


normalizeResourcePath()

protected normalizeResourcePath(relativePath): string | null

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

Normalize a resource path to a safe, portable relative path.

Parameters

relativePath

string

Returns

string | null

Inherited from

MarkdownInstructionFormatter.normalizeResourcePath


postWork()

protected postWork(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.postWork


project()

protected project(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.project


referenceProvenance()

protected referenceProvenance(sourcePath): string

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

Generate a provenance comment for a reference file.

Parameters

sourcePath

string

Returns

string

Inherited from

MarkdownInstructionFormatter.referenceProvenance


referencesMode()

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

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

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

MarkdownInstructionFormatter.referencesMode


removeRawFrontmatterKeys()

protected removeRawFrontmatterKeys(rawFrontmatter, keys): string

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

Remove top-level keys (with their nested lines) from raw SKILL.md frontmatter. Used for PromptScript-only keys such as params, which are resolved at compile time and mean nothing to the target tool.

Parameters

rawFrontmatter

string

keys

ReadonlySet<string>

Returns

string

Inherited from

MarkdownInstructionFormatter.removeRawFrontmatterKeys


renderCodeFence()

protected renderCodeFence(content, lang?): string

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

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

MarkdownInstructionFormatter.renderCodeFence


renderExamplesSection()

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

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

Render an examples section from the

Parameters

ast

Program

renderer

ConventionRenderer

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

MarkdownInstructionFormatter.renderExamplesSection


resolveSkillDir()

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

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

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?

FormatOptions

Returns

string

Inherited from

MarkdownInstructionFormatter.resolveSkillDir


resolveVersion()

protected resolveVersion(version?): MarkdownVersion

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

Parameters

version?

string

Returns

MarkdownVersion

Inherited from

MarkdownInstructionFormatter.resolveVersion


restrictions()

protected restrictions(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.restrictions


sanitizeResourceFiles()

protected sanitizeResourceFiles(resources, targetDir): FormatterOutput[]

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

Filter resource files to only include safe canonical paths.

Parameters

resources

object[] | undefined

targetDir

string

Returns

FormatterOutput[]

Inherited from

MarkdownInstructionFormatter.sanitizeResourceFiles


shiftContextHeadings()

protected shiftContextHeadings(text): string

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

Shift

Parameters

text

string

Returns

string

Context

headings so none of them reaches the formatter’s own h1 and h2 levels. All headings move by the same amount, so their relative levels stay as written. Text that already starts at h3 or deeper is kept as is.

Inherited from

MarkdownInstructionFormatter.shiftContextHeadings


shiftHeadingsToMinLevel()

protected shiftHeadingsToMinLevel(text, targetLevel): string

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

Shift all ATX headings by the same amount so the shallowest heading lands at targetLevel. Levels clamp to h1-h6 and fenced code blocks are ignored.

Parameters

text

string

targetLevel

number

Returns

string

Inherited from

MarkdownInstructionFormatter.shiftHeadingsToMinLevel


shortcutSummary()

protected shortcutSummary(value, fallback?): string

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

Extract a stable one-line summary from any supported shortcut value.

Parameters

value

Value

fallback?

string = ''

Returns

string

Inherited from

MarkdownInstructionFormatter.shortcutSummary


shouldIncludeSkill()

protected shouldIncludeSkill(name, options?): boolean

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

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

Parameters

name

string

options?

FormatOptions

Returns

boolean

Inherited from

MarkdownInstructionFormatter.shouldIncludeSkill


startFormat()

protected startFormat(options?): void

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

Call first in format, so markdown helpers know whether to keep the text as written. The state is reset on every call.

Parameters

options?

FormatOptions

Returns

void

Inherited from

MarkdownInstructionFormatter.startFormat


stripAllIndent()

protected stripAllIndent(content): string

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

Strip all leading indentation from markdown content. Used for AGENTS.md where content from multiple sources has inconsistent indentation. Preserves indentation inside code blocks.

With verbatimMarkdown only the common indentation is removed.

Parameters

content

string

Returns

string

Inherited from

MarkdownInstructionFormatter.stripAllIndent


techStack()

protected techStack(ast, renderer): string | null

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

Parameters

ast

Program

renderer

ConventionRenderer

Returns

string | null

Inherited from

MarkdownInstructionFormatter.techStack


transformInjectedSkillContent()

transformInjectedSkillContent(content): string

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

Default pass-through for injected skill content. Formatters whose target tools restrict skill frontmatter (e.g. Factory AI) override this hook to filter unsupported fields before the compiler writes the file.

Parameters

content

string

Returns

string

Inherited from

MarkdownInstructionFormatter.transformInjectedSkillContent


transformRestrictionItem()

protected transformRestrictionItem(s): string

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

Parameters

s

string

Returns

string

Inherited from

MarkdownInstructionFormatter.transformRestrictionItem


truncate()

protected truncate(str, max): string

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

Truncate string to max length with ellipsis.

Parameters

str

string

max

number

Returns

string

Inherited from

MarkdownInstructionFormatter.truncate


valueToString()

protected valueToString(value): string

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

Convert value to string representation.

Parameters

value

Value

Returns

string

Inherited from

MarkdownInstructionFormatter.valueToString


yamlQuoted()

protected yamlQuoted(value): string

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

Escape a value for use inside a double-quoted YAML scalar.

Parameters

value

string

Returns

string

Inherited from

MarkdownInstructionFormatter.yamlQuoted


yamlString()

protected yamlString(value): string

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

Serialize a string as a YAML scalar, quoting only when required.

Parameters

value

string

Returns

string

Inherited from

MarkdownInstructionFormatter.yamlString


getSupportedVersions()

static getSupportedVersions(): SimpleFormatterVersions

Defined in: formatters/src/formatters/trae.ts:48

Returns

SimpleFormatterVersions