PromptScript API

Interface: Formatter¶

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

Common interface for all formatters.

Properties¶

defaultConvention¶

readonly defaultConvention: string

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

Default convention for this formatter

description¶

readonly description: string

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

Human-readable description

name¶

readonly name: string

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

Unique formatter identifier

outputPath¶

readonly outputPath: string

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

Default output file path

Methods¶

format()¶

format(ast, options?): FormatterOutput

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

Transform AST to tool-specific format

Parameters¶

ast¶

Program

options?¶

FormatOptions

Returns¶

FormatterOutput

getSkillBasePath()¶

getSkillBasePath(): string | null

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

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:63

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:65

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

Returns¶

"none" | "directory" | "inline"