PromptScript API

Interface: Formatter¶

Defined in: formatters/src/types.ts:71

Common interface for all formatters.

Extended by¶

• CanonicalFormatter

Properties¶

defaultConvention¶

readonly defaultConvention: string

Defined in: formatters/src/types.ts:79

Default convention for this formatter

description¶

readonly description: string

Defined in: formatters/src/types.ts:77

Human-readable description

name¶

readonly name: string

Defined in: formatters/src/types.ts:73

Unique formatter identifier

outputPath¶

readonly outputPath: string

Defined in: formatters/src/types.ts:75

Default output file path

Methods¶

format()¶

format(ast, options?): FormatterOutput

Defined in: formatters/src/types.ts:81

Transform AST to target format

Parameters¶

ast¶

Program

options?¶

FormatOptions

Returns¶

FormatterOutput

formatCanonical()?¶

optional formatCanonical(ast, options?): FormatterOutput

Defined in: formatters/src/types.ts:89

Optional canonical entry point.

Implementations that do not provide this method are legacy formatters. The formatter adapter creates a detached compatibility projection before invoking their format method.

Parameters¶

ast¶

CanonicalProgram

options?¶

FormatOptions

Returns¶

FormatterOutput

getSkillBasePath()¶

getSkillBasePath(): string | null

Defined in: formatters/src/types.ts:91

Base path for skills (e.g., '.claude/skills'), or null if no skill support

Returns¶

string | null

getSkillFileName()¶

getSkillFileName(): string | null

Defined in: formatters/src/types.ts:93

Skill file name (e.g., 'SKILL.md' or 'skill.md'), or null if no skill support

Returns¶

string | null

referencesMode()¶

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

Defined in: formatters/src/types.ts:95

How this formatter handles skill references: 'directory', 'inline', or 'none'

Returns¶

"none" | "directory" | "inline"

transformInjectedSkillContent()?¶

optional transformInjectedSkillContent(content): string

Defined in: formatters/src/types.ts:104

Transform the raw content of a pass-through skill file (e.g. the bundled PromptScript SKILL.md injected by the compiler) before it is written to disk. Formatters whose target tools enforce frontmatter schemas (such as Factory AI) can override this to strip unsupported fields.

Defaults to identity when not implemented.

Parameters¶

content¶

string

Returns¶

string