Package io.typeflows.github.copilot
Class CopilotInstructions
-
- All Implemented Interfaces:
-
io.typeflows.fs.TypeflowsFSEntry,io.typeflows.util.Named,io.typeflows.util.Renderable
public final class CopilotInstructions extends TypeflowsFile<MarkdownContent>Represents GitHub Copilot instructions configuration file.
This class generates the copilot-instructions.md file that provides context and guidance to GitHub Copilot for AI-assisted development within the repository.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCopilotInstructions.DSLpublic classCopilotInstructions.Companion
-
Field Summary
Fields Modifier and Type Field Description public final MarkdownContentcontentprivate final Stringnamepublic final static CopilotInstructions.CompanionCompanion
-
Method Summary
Modifier and Type Method Description StringgetName()MarkdownContentrender()final static CopilotInstructionscreate(Configure<CopilotInstructions.DSL> block)Creates and configures a CopilotInstructions instance. final static CopilotInstructionscreate()Creates and configures a CopilotInstructions instance. -
Methods inherited from class io.typeflows.fs.TypeflowsFile
writeTo -
Methods inherited from class io.typeflows.util.Base
equals, hashCode, toString -
Methods inherited from class io.typeflows.fs.TypeflowsFSEntry
plus -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
render
MarkdownContent render()
-
create
@JvmOverloads() final static CopilotInstructions create(Configure<CopilotInstructions.DSL> block)
Creates and configures a CopilotInstructions instance.
- Parameters:
block- Configuration lambda to set up the Copilot instructions content- Returns:
Configured CopilotInstructions instance
-
create
@JvmOverloads() final static CopilotInstructions create()
Creates and configures a CopilotInstructions instance.
- Returns:
Configured CopilotInstructions instance
-
-
-
-