formatters/src¶
Output formatters for PromptScript.
Generates configuration files for various AI tools (e.g., JSON, YAML, etc.) from the compiled PromptScript AST.
Classes¶
- AntigravityFormatter
- BaseFormatter
- ClaudeFormatter
- CodexFormatter
- ContinueFormatter
- ConventionRenderer
- CursorFormatter
- FactoryFormatter
- FormatterRegistry
- GeminiFormatter
- GitHubFormatter
- GrokFormatter
- KiroFormatter
- MarkdownInstructionFormatter
- TraeFormatter
- WindsurfFormatter
- ZencoderFormatter
Interfaces¶
- CanonicalFormatter
- ConventionRendererOptions
- ExtractionRule
- FeatureCoverageSummary
- FeatureSpec
- FormatOptions
- Formatter
- FormatterClass
- FormatterOutput
- FormatterVersionInfo
- FormatterWarning
- HookDefinition
- HookScriptDefinition
- HookTargetOverride
- MarkdownAgentConfig
- MarkdownCommandConfig
- MarkdownFormatterConfig
- MarkdownSkillConfig
- ParityReport
- SectionInfo
- SectionSpec
- SectionTitleOptions
- SimpleFormatterOptions
- SimpleFormatterResult
- SimpleFormatterVersions
- SourceBlockConfig
- StandaloneFormatOptions
- VersionEntry
Type Aliases¶
- ActivationType
- AdalVersion
- AiderVersion
- AmazonQVersion
- AmpVersion
- AntigravityVersion
- AugmentVersion
- ClineVersion
- CodeBuddyVersion
- CodexVersion
- CommandCodeVersion
- ContinueVersion
- CortexVersion
- CrushVersion
- DeepAgentsVersion
- DevinVersion
- FactoryVersion
- FeatureCategory
- FeatureStatus
- ForgecodeVersion
- FormatterFactory
- FormatterVersionMap
- GeminiVersion
- GooseVersion
- GrokVersion
- HermesVersion
- HookTarget
- IflowVersion
- JulesVersion
- JunieVersion
- KiloVersion
- KimiVersion
- KiroVersion
- KodeVersion
- LegacyFormatter
- MarkdownVersion
- McpjamVersion
- MimoVersion
- MistralVibeVersion
- MuxVersion
- NeovateVersion
- OpenClawVersion
- OpenCodeVersion
- OpenHandsVersion
- PiVersion
- PochiVersion
- PortableHookEvent
- QoderVersion
- QwenCodeVersion
- RooVersion
- SectionNameKey
ToolName- TraeVersion
- WarpVersion
- WindsurfVersion
- ZedVersion
- ZencoderVersion
Variables¶
- ADAL_VERSIONS
- AdalFormatter
- AIDER_VERSIONS
- AiderFormatter
- AMAZON_Q_VERSIONS
- AmazonQFormatter
- AMP_VERSIONS
- AmpFormatter
- ANTIGRAVITY_VERSIONS
- AUGMENT_VERSIONS
- AugmentFormatter
- BUILTIN_FORMATTERS
- CLAUDE_VERSIONS
- CLINE_VERSIONS
- ClineFormatter
- CODEBUDDY_VERSIONS
- CodeBuddyFormatter
- CODEX_VERSIONS
- COMMAND_CODE_VERSIONS
- CommandCodeFormatter
- CONTINUE_VERSIONS
- conventionRenderers
- CORTEX_VERSIONS
- CortexFormatter
- CRUSH_VERSIONS
- CrushFormatter
- DEEP_AGENTS_VERSIONS
- DeepAgentsFormatter
- DEVIN_VERSIONS
- DevinFormatter
- EXTRACTION_RULES
- FACTORY_VERSIONS
- FEATURE_MATRIX
- FORGECODE_VERSIONS
- ForgecodeFormatter
- GEMINI_VERSIONS
- GITHUB_VERSIONS
- GOOSE_VERSIONS
- GooseFormatter
- GROK_VERSIONS
- HERMES_VERSIONS
- HermesFormatter
- IFLOW_VERSIONS
- IflowFormatter
- JULES_VERSIONS
- JulesFormatter
- JUNIE_VERSIONS
- JunieFormatter
- KILO_VERSIONS
- KiloFormatter
- KIMI_VERSIONS
- KimiFormatter
- KIRO_VERSIONS
- KNOWN_SECTIONS
- KODE_VERSIONS
- KodeFormatter
- MCPJAM_VERSIONS
- McpjamFormatter
- MIMO_VERSIONS
- MimoFormatter
- MISTRAL_VIBE_VERSIONS
- MistralVibeFormatter
- MUX_VERSIONS
- MuxFormatter
- NEOVATE_VERSIONS
- NeovateFormatter
- OPENCLAW_VERSIONS
- OpenClawFormatter
- OPENCODE_VERSIONS
- OpenCodeFormatter
- OPENHANDS_VERSIONS
- OpenHandsFormatter
- OWNERSHIP_KEY
- PARITY_MATRIX
- PI_VERSIONS
- PiFormatter
- POCHI_VERSIONS
- PochiFormatter
- QODER_VERSIONS
- QoderFormatter
- QWEN_CODE_VERSIONS
- QwenCodeFormatter
- ROO_VERSIONS
- RooFormatter
- TRAE_VERSIONS
- WARP_VERSIONS
- WarpFormatter
- WINDSURF_VERSIONS
- ZED_VERSIONS
- ZedFormatter
- ZENCODER_VERSIONS
Functions¶
- appendTargetHookCapabilityWarnings
- applyHookTargetOverrides
- applyMergeOperations
- convertTimeout
- createConventionRenderer
- createSimpleMarkdownFormatter
- extractHooks
- extractSectionsFromOutput
- findMissingSections
- format
- formatProgram
- generateClaudeHooks
- generateCodexHooks
- generateCursorHooks
- generateFactoryHooks
- generateGeminiHooks
- generateGitHubHooks
- generateGrokHooks
- generateVSCodeHooks
- generateWindsurfHooks
- getEnabledHookScriptResources
- getExpectedSections
- getFormatter
- getHookCompatibilityWarnings
- getTargetHookCapabilityWarnings
- hasFormatter
- hasOwnedEntries
- isCanonicalFormatter
- isCanonicalTarget
- isLegacyFormatter
- listFormatters
- mapEvent
- normalizeSectionName
- parsePath
- registerFormatter
- removeStaleOwned
- resolveSectionTitle
- resolveSourceSectionTitle
- serializeMerged
- unregisterFormatter
- validateBuiltinFormatterCapabilities
References¶
createOutputPlan¶
Re-exports createOutputPlan
FormatterName¶
Re-exports FormatterName
normalizeOutputCollisionKey¶
Re-exports normalizeOutputCollisionKey
normalizeOutputPath¶
Re-exports normalizeOutputPath
OutputArtifact¶
Re-exports OutputArtifact
OutputPlan¶
Re-exports OutputPlan
OutputPlanArtifactRole¶
Re-exports OutputPlanArtifactRole
OutputPlanCandidate¶
Re-exports OutputPlanCandidate
OutputPlanCollision¶
Re-exports OutputPlanCollision
OutputPlanCollisionResolution¶
Re-exports OutputPlanCollisionResolution
OutputPlanFile¶
Re-exports OutputPlanFile
OutputPlanManagedPaths¶
Re-exports OutputPlanManagedPaths
OutputPlanPathError¶
Re-exports OutputPlanPathError
StructuredMergeOperation¶
Re-exports StructuredMergeOperation
StructuredMergePlan¶
Re-exports StructuredMergePlan