Skip to content

PromptScript API


Interface: Formatter

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

Common interface for all formatters.

Properties

defaultConvention

readonly defaultConvention: string

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

Default convention for this formatter


description

readonly description: string

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

Human-readable description


name

readonly name: string

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

Unique formatter identifier


outputPath

readonly outputPath: string

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

Default output file path

Methods

format()

format(ast, options?): FormatterOutput

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

Transform AST to tool-specific format

Parameters

ast

Program

options?

FormatOptions

Returns

FormatterOutput