SimpleFormatterOptions
Defined in: formatters/src/create-simple-formatter.ts:28
Options for creating a simple markdown formatter via the factory.
These options are the only things that vary across the tier-1/2/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?
optionalhasAgents?:boolean
Defined in: formatters/src/create-simple-formatter.ts:40
Whether this formatter supports agents (default: false)
hasCommands?
optionalhasCommands?:boolean
Defined in: formatters/src/create-simple-formatter.ts:42
Whether this formatter supports commands (default: false)
hasSkills?
optionalhasSkills?: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’)
mcpConfigFormat?
optionalmcpConfigFormat?:"json"|"toml"
Defined in: formatters/src/create-simple-formatter.ts:54
MCP config format (default: ‘json’)
mcpConfigPath?
optionalmcpConfigPath?:string
Defined in: formatters/src/create-simple-formatter.ts:52
MCP config file path. If set,
Mcp Servers
block is emitted to this path.
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?
optionalskillFileName?:string
Defined in: formatters/src/create-simple-formatter.ts:48
Skill file name (default: ‘SKILL.md’)
skillsDir?
optionalskillsDir?:string
Defined in: formatters/src/create-simple-formatter.ts:50
Skill directory override (default: <dotDir>/skills)
skillsInMultifile?
optionalskillsInMultifile?:boolean
Defined in: formatters/src/create-simple-formatter.ts:46
Whether multifile mode emits skill files (default: false, skills stay full-mode-only)
unsupportedBlocks?
optionalunsupportedBlocks?: readonlystring[]
Defined in: formatters/src/create-simple-formatter.ts:56
PromptScript blocks that this target omits with compatibility warnings.