FormatterOutput
Defined in: compiler/src/types.ts:24
Output from a formatter.
Extends
Properties
additionalFiles?
optionaladditionalFiles?:FormatterOutput[]
Defined in: compiler/src/types.ts:39
Additional files to generate (e.g., .cursor/commands/, .github/prompts/)
Overrides
OutputArtifact.additionalFiles
composition?
optionalcomposition?:PromptComposition[]
Defined in: compiler/src/types.ts:41
Blocks composed into prompts, for the prompt targets. Not part of any written file.
content
content:
string
Defined in: core/src/output-plan.ts:14
File contents.
Inherited from
managedOutputDirectories?
optionalmanagedOutputDirectories?:string[]
Defined in: core/src/output-plan.ts:22
Relative directories managed by this artifact.
Inherited from
OutputArtifact.managedOutputDirectories
managedOutputFiles?
optionalmanagedOutputFiles?:string[]
Defined in: core/src/output-plan.ts:24
Relative files managed by this artifact.
Inherited from
OutputArtifact.managedOutputFiles
merge?
optionalmerge?:StructuredMergePlan
Defined in: core/src/output-plan.ts:18
Optional structured merge instructions.
Inherited from
mode?
optionalmode?:number
Defined in: core/src/output-plan.ts:16
Optional Unix file mode.
Inherited from
omit?
optionalomit?:boolean
Defined in: core/src/output-plan.ts:29
Plan nothing for this artifact. A formatter sets it when it has no file to write, for example a prompt target in a program without prompts.
Inherited from
path
path:
string
Defined in: compiler/src/types.ts:26
Output file path
Overrides
source?
optionalsource?:string
Defined in: compiler/src/types.ts:30
Source entry used to produce this output.
target?
optionaltarget?:string
Defined in: compiler/src/types.ts:28
Target formatter that produced this output.
warnings?
optionalwarnings?:object[]
Defined in: compiler/src/types.ts:32
Target compatibility warnings produced during formatting
code
code:
string
location?
optionallocation?:SourceLocation
message
message:
string
suggestion?
optionalsuggestion?:string