PromptScript API

Interface: SimpleFormatterOptions¶

Defined in: formatters/src/create-simple-formatter.ts:28

Options for creating a simple markdown formatter via the factory.

These five parameters are the only things that vary across the 31 tier-½/3 formatters that have no method overrides.

Properties¶

description¶

description: string

Defined in: formatters/src/create-simple-formatter.ts:34

Human-readable description (e.g. 'Windsurf rules (Markdown)')

dotDir¶

dotDir: string

Defined in: formatters/src/create-simple-formatter.ts:38

Dot directory for skills/commands/agents (e.g. '.windsurf')

hasAgents?¶

optional hasAgents?: boolean

Defined in: formatters/src/create-simple-formatter.ts:40

Whether this formatter supports agents (default: false)

hasCommands?¶

optional hasCommands?: boolean

Defined in: formatters/src/create-simple-formatter.ts:42

Whether this formatter supports commands (default: false)

hasSkills?¶

optional hasSkills?: boolean

Defined in: formatters/src/create-simple-formatter.ts:44

Whether this formatter supports skills (default: true)

mainFileHeader¶

mainFileHeader: string

Defined in: formatters/src/create-simple-formatter.ts:36

Header rendered at top of main file (e.g. '# Project Rules')

name¶

name: string

Defined in: formatters/src/create-simple-formatter.ts:30

Formatter identifier (e.g. 'windsurf', 'kode')

outputPath¶

outputPath: string

Defined in: formatters/src/create-simple-formatter.ts:32

Default output file path (e.g. '.windsurf/rules/project.md')

skillFileName?¶

optional skillFileName?: string

Defined in: formatters/src/create-simple-formatter.ts:46

Skill file name (default: 'SKILL.md')