Skip to content

PromptTextFormatter

PromptScript API


Defined in: formatters/src/formatters/prompt-text.ts:55

Writes the composed system message of each prompt as Markdown, for reading.

Writes prompts/<key>.md for each prompt that has a system message and prompts/README.md as the primary file. The text is the system message of the bundle target, and the hash of that bundle sits in a comment at the top of each file. A prompt without a system message is skipped with a diagnostic.

Extends

  • PromptFormatter

Constructors

Constructor

new PromptTextFormatter(): PromptTextFormatter

Defined in: formatters/src/formatters/prompt-text.ts:56

Returns

PromptTextFormatter

Overrides

PromptFormatter.constructor

Properties

defaultConvention

readonly defaultConvention: "markdown" = 'markdown'

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

Default convention for this formatter

Inherited from

PromptFormatter.defaultConvention


description

readonly description: string

Defined in: formatters/src/prompt/prompt-formatter.ts:73

Inherited from

PromptFormatter.description


name

readonly name: string

Defined in: formatters/src/prompt/prompt-formatter.ts:71

Inherited from

PromptFormatter.name


outputPath

readonly outputPath: string

Defined in: formatters/src/prompt/prompt-formatter.ts:72

Inherited from

PromptFormatter.outputPath

Methods

format()

format(ast, options?): FormatterOutput

Defined in: formatters/src/prompt/prompt-formatter.ts:78

Transform AST to target format

Parameters

ast

Program

options?

FormatOptions

Returns

FormatterOutput

Inherited from

PromptFormatter.format


getSkillBasePath()

getSkillBasePath(): string | null

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

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

Returns

string | null

Inherited from

PromptFormatter.getSkillBasePath


getSkillFileName()

getSkillFileName(): string | null

Defined in: formatters/src/prompt/prompt-formatter.ts:124

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

Returns

string | null

Inherited from

PromptFormatter.getSkillFileName


referencesMode()

referencesMode(): "none"

Defined in: formatters/src/prompt/prompt-formatter.ts:128

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

Returns

"none"

Inherited from

PromptFormatter.referencesMode


render()

protected render(built): PromptRender

Defined in: formatters/src/formatters/prompt-text.ts:64

Parameters

built

BuiltPrompts

Returns

PromptRender

Overrides

PromptFormatter.render


getSupportedVersions()

static getSupportedVersions(): FormatterVersionMap

Defined in: formatters/src/formatters/prompt-text.ts:60

Returns

FormatterVersionMap