PromptScript API

Abstract Class: BaseFormatter¶

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

Abstract base formatter with common helper methods. Extend this class to create new formatter implementations.

Extended by¶

• GitHubFormatter
• ClaudeFormatter
• CursorFormatter
• AntigravityFormatter

Implements¶

• Formatter

Constructors¶

Constructor¶

new BaseFormatter(): BaseFormatter

Returns¶

BaseFormatter

Properties¶

defaultConvention¶

abstract readonly defaultConvention: string

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

Default convention for this formatter

Implementation of¶

Formatter.defaultConvention

description¶

abstract readonly description: string

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

Human-readable description

Implementation of¶

Formatter.description

name¶

abstract readonly name: string

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

Unique formatter identifier

Implementation of¶

Formatter.name

outputPath¶

abstract readonly outputPath: string

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

Default output file path

Implementation of¶

Formatter.outputPath

standardsExtractor¶

protected readonly standardsExtractor: StandardsExtractor

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

Shared standards extractor for consistent extraction across all formatters.

Methods¶

createRenderer()¶

protected createRenderer(options?): ConventionRenderer

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

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

Parameters¶

options?¶

FormatOptions

Returns¶

ConventionRenderer

dedent()¶

protected dedent(text): string

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

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

extractSectionWithCodeBlock()¶

protected extractSectionWithCodeBlock(text, header): string | null

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

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

header¶

string

Returns¶

string | null

extractText()¶

protected extractText(content): string

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

Extract text from block content.

Parameters¶

content¶

BlockContent

Returns¶

string

findBlock()¶

protected findBlock(ast, name): Block | undefined

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

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

Parameters¶

ast¶

Program

name¶

string

Returns¶

Block | undefined

format()¶

abstract format(ast, options?): FormatterOutput

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

Transform AST to tool-specific format

Parameters¶

ast¶

Program

options?¶

FormatOptions

Returns¶

FormatterOutput

Implementation of¶

Formatter.format

formatArray()¶

protected formatArray(arr): string

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

Format an array as comma-separated string.

Parameters¶

arr¶

unknown[]

Returns¶

string

formatStandardsList()¶

protected formatStandardsList(items): string[]

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

Format standards list from array of values (pass-through). Returns array of strings for rendering as bullet list.

Parameters¶

items¶

Value

Returns¶

string[]

getArrayElements()¶

protected getArrayElements(content): Value[]

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

Extract array elements from block content.

Parameters¶

content¶

BlockContent

Returns¶

Value[]

getMetaField()¶

protected getMetaField(ast, key): string | undefined

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

Get meta field value as string.

Parameters¶

ast¶

Program

key¶

string

Returns¶

string | undefined

getOutputPath()¶

protected getOutputPath(options?): string

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

Get the output path, respecting options override.

Parameters¶

options?¶

FormatOptions

Returns¶

string

getPrettierOptions()¶

protected getPrettierOptions(options?): Required\<PrettierMarkdownOptions>

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

Get resolved Prettier options, merging provided options with defaults.

Parameters¶

options?¶

FormatOptions

Returns¶

Required\<PrettierMarkdownOptions>

getProp()¶

protected getProp(content, key): Value | undefined

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

Get a specific property from block content.

Parameters¶

content¶

BlockContent

key¶

string

Returns¶

Value | undefined

getProps()¶

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

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

Get all properties from block content.

Parameters¶

content¶

BlockContent

Returns¶

Record\<string, Value>

normalizeMarkdownForPrettier()¶

protected normalizeMarkdownForPrettier(content): string

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

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

Parameters¶

content¶

string

Returns¶

string

stripAllIndent()¶

protected stripAllIndent(content): string

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

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

Parameters¶

content¶

string

Returns¶

string

truncate()¶

protected truncate(str, max): string

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

Truncate string to max length with ellipsis.

Parameters¶

str¶

string

max¶

number

Returns¶

string

valueToString()¶

protected valueToString(value): string

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

Convert value to string representation.

Parameters¶

value¶

Value

Returns¶

string