Class: GitHubFormatter¶

Defined in: formatters/src/formatters/github.ts:200

Formatter for GitHub Copilot instructions.

Supports three versions: - simple: Single .github/copilot-instructions.md file - multifile: Main + .github/instructions/*.instructions.md + .github/prompts/*.prompt.md - full (default): Multifile + .github/skills/<name>/SKILL.md + AGENTS.md

Example¶

targets:
  - github  # uses full mode (default)
  - github:
      version: multifile
  - github:
      version: full

See¶

https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot

Extends¶

BaseFormatter

Constructors¶

Constructor¶

new GitHubFormatter(): GitHubFormatter

Returns¶

GitHubFormatter

Inherited from¶

BaseFormatter.constructor

Properties¶

defaultConvention¶

readonly defaultConvention: "markdown" = 'markdown'

Defined in: formatters/src/formatters/github.ts:204

Default convention for this formatter

Overrides¶

BaseFormatter.defaultConvention

description¶

readonly description: "GitHub Copilot instructions (Markdown)" = 'GitHub Copilot instructions (Markdown)'

Defined in: formatters/src/formatters/github.ts:203

Human-readable description

Overrides¶

BaseFormatter.description

name¶

readonly name: "github" = 'github'

Defined in: formatters/src/formatters/github.ts:201

Unique formatter identifier

Overrides¶

BaseFormatter.name

outputPath¶

readonly outputPath: ".github/copilot-instructions.md" = '.github/copilot-instructions.md'

Defined in: formatters/src/formatters/github.ts:202

Default output file path

Overrides¶

BaseFormatter.outputPath

standardsExtractor¶

protected readonly standardsExtractor: StandardsExtractor

Defined in: formatters/src/base-formatter.ts:28

Shared standards extractor for consistent extraction across all formatters.

Inherited from¶

BaseFormatter.standardsExtractor

Methods¶

createRenderer()¶

protected createRenderer(options?): ConventionRenderer

Defined in: formatters/src/base-formatter.ts:34

Create a convention renderer for this formatter. Uses the provided convention from options or falls back to the default.

Parameters¶

dedent()¶

protected dedent(text): string

Defined in: formatters/src/base-formatter.ts:452

Remove common leading whitespace from all lines (dedent). Handles the case where trim() was already called, causing the first line to lose its indentation while subsequent lines retain theirs. Calculates minimum indent from lines 2+ only.

Parameters¶

text¶

string

Returns¶

string

Inherited from¶

BaseFormatter.dedent

extractExamples()¶

protected extractExamples(ast): object[]

Defined in: formatters/src/base-formatter.ts:532

Extract examples from the

Parameters¶

ast¶

Program

Returns¶

object[]

Examples¶

block. Returns an array of example definitions with name, input, output, and optional description.

Inherited from¶

BaseFormatter.extractExamples

extractSectionWithCodeBlock()¶

protected extractSectionWithCodeBlock(text, header): string | null

Defined in: formatters/src/base-formatter.ts:176

Safe extraction of a section that contains a header + content + code block + content Avoids ReDoS by using string search instead of backtracking regex. Matches pattern: Header ... ...

Parameters¶

text¶

string

Returns¶

string | null

Inherited from¶

BaseFormatter.extractSectionWithCodeBlock

extractSkillExamples()¶

protected extractSkillExamples(skillProps): object[]

Defined in: formatters/src/base-formatter.ts:545

Extract examples from a skill's nested examples property. Returns the same shape as extractExamples.

Parameters¶

skillProps¶

Record\<string, Value>

Returns¶

object[]

Inherited from¶

BaseFormatter.extractSkillExamples

extractText()¶

protected extractText(content): string

Defined in: formatters/src/base-formatter.ts:69

Extract text from block content.

Parameters¶

content¶

BlockContent

Returns¶

string

Inherited from¶

BaseFormatter.extractText

findBlock()¶

protected findBlock(ast, name): Block | undefined

Defined in: formatters/src/base-formatter.ts:62

Find a block by name, ignoring internal blocks (starting with __).

Parameters¶

ast¶

Program

name¶

string

Returns¶

Block | undefined

Inherited from¶

BaseFormatter.findBlock

format()¶

format(ast, options?): FormatterOutput

Defined in: formatters/src/formatters/github.ts:225

Transform AST to tool-specific format

Parameters¶

ast¶

Program

options?¶

FormatOptions

Returns¶

FormatterOutput

Overrides¶

BaseFormatter.format

formatArray()¶

protected formatArray(arr): string

Defined in: formatters/src/base-formatter.ts:120

Format an array as comma-separated string.

Parameters¶

arr¶

unknown[]

Returns¶

string

Inherited from¶

BaseFormatter.formatArray

formatStandardsList()¶

protected formatStandardsList(items): string[]

Defined in: formatters/src/base-formatter.ts:112

Format standards list from array of values (pass-through). Returns array of strings for rendering as bullet list.

Parameters¶

items¶

Value

Returns¶

string[]

Inherited from¶

BaseFormatter.formatStandardsList

getArrayElements()¶

protected getArrayElements(content): Value[]

Defined in: formatters/src/base-formatter.ts:144

Extract array elements from block content.

Parameters¶

content¶

BlockContent

Returns¶

Value[]

Inherited from¶

BaseFormatter.getArrayElements

getMetaField()¶

protected getMetaField(ast, key): string | undefined

Defined in: formatters/src/base-formatter.ts:134

Get meta field value as string.

Parameters¶

ast¶

Program

key¶

string

Returns¶

string | undefined

Inherited from¶

BaseFormatter.getMetaField

getOutputPath()¶

protected getOutputPath(options?): string

Defined in: formatters/src/base-formatter.ts:55

Get the output path, respecting options override.

Parameters¶

options?¶

FormatOptions

Returns¶

string

Inherited from¶

BaseFormatter.getOutputPath

getPrettierOptions()¶

protected getPrettierOptions(options?): Required\<PrettierMarkdownOptions>

Defined in: formatters/src/base-formatter.ts:45

Get resolved Prettier options, merging provided options with defaults.

Parameters¶

options?¶

FormatOptions

Returns¶

Required\<PrettierMarkdownOptions>

Inherited from¶

BaseFormatter.getPrettierOptions

getProp()¶

protected getProp(content, key): Value | undefined

Defined in: formatters/src/base-formatter.ts:83

Get a specific property from block content.

Parameters¶

content¶

BlockContent

key¶

string

Returns¶

Value | undefined

Inherited from¶

BaseFormatter.getProp

getProps()¶

protected getProps(content): Record\<string, Value>

Defined in: formatters/src/base-formatter.ts:97

Get all properties from block content.

Parameters¶

content¶

BlockContent

Returns¶

Record\<string, Value>

Inherited from¶

BaseFormatter.getProps

getSkillBasePath()¶

getSkillBasePath(): string | null

Defined in: formatters/src/formatters/github.ts:213

Base path for skills, or null if formatter has no skill support.

Returns¶

string | null

Overrides¶

BaseFormatter.getSkillBasePath

getSkillFileName()¶

getSkillFileName(): string | null

Defined in: formatters/src/formatters/github.ts:217

Skill file name, or null if formatter has no skill support.

Returns¶

string | null

Overrides¶

BaseFormatter.getSkillFileName

isSafeSkillName()¶

protected isSafeSkillName(name): boolean

Defined in: formatters/src/base-formatter.ts:622

Check if a skill name is safe for use in file paths.

Parameters¶

name¶

string

Returns¶

boolean

Inherited from¶

BaseFormatter.isSafeSkillName

normalizeMarkdownForPrettier()¶

protected normalizeMarkdownForPrettier(content): string

Defined in: formatters/src/base-formatter.ts:204

Normalize markdown content to match Prettier formatting. - Strips common leading indentation from lines - Trims trailing whitespace from lines - Normalizes markdown table formatting - Adds blank lines before lists when preceded by text - Adds blank lines before code blocks when preceded by text - Escapes markdown special characters in paths

Parameters¶

content¶

string

Returns¶

string

Inherited from¶

BaseFormatter.normalizeMarkdownForPrettier

referenceProvenance()¶

protected referenceProvenance(sourcePath): string

Defined in: formatters/src/base-formatter.ts:615

Generate a provenance comment for a reference file.

Parameters¶

sourcePath¶

string

Returns¶

string

Inherited from¶

BaseFormatter.referenceProvenance

referencesMode()¶

referencesMode(): "none" | "directory" | "inline"

Defined in: formatters/src/formatters/github.ts:221

How this formatter handles skill references. - 'directory': emit as separate files in references/ subdirectory - 'inline': append as sections in the main output file - 'none': references not supported

Returns¶

"none" | "directory" | "inline"

Overrides¶

BaseFormatter.referencesMode

renderCodeFence()¶

protected renderCodeFence(content, lang?): string

Defined in: formatters/src/base-formatter.ts:630

Render content inside a code fence, using a longer fence if the content itself contains triple backticks (prevents code fence injection).

Parameters¶

content¶

string

lang?¶

string = ''

Returns¶

string

Inherited from¶

BaseFormatter.renderCodeFence

renderExamplesSection()¶

protected renderExamplesSection(ast, renderer, sectionName?): string | null

Defined in: formatters/src/base-formatter.ts:561

Render an examples section from the

Parameters¶

ast¶

Program

renderer¶

ConventionRenderer

sectionName?¶

string = 'Examples'

Custom section heading name (default: 'Examples')

Returns¶

string | null

Examples¶

block. Shared rendering logic used by Claude, GitHub, and MarkdownInstructionFormatter.

Inherited from¶

BaseFormatter.renderExamplesSection

sanitizeResourceFiles()¶

protected sanitizeResourceFiles(resources, targetDir): FormatterOutput[]

Defined in: formatters/src/base-formatter.ts:483

Filter resource files to only include safe paths. Rejects paths with traversal, absolute paths, and unsafe names.

Parameters¶

resources¶

object[] | undefined

targetDir¶

string

Returns¶

FormatterOutput[]

Inherited from¶

BaseFormatter.sanitizeResourceFiles

stripAllIndent()¶

protected stripAllIndent(content): string

Defined in: formatters/src/base-formatter.ts:348

Strip all leading indentation from markdown content. Used for AGENTS.md where content from multiple sources has inconsistent indentation. Preserves indentation inside code blocks.

Parameters¶

content¶

string

Returns¶

string

Inherited from¶

BaseFormatter.stripAllIndent

truncate()¶

protected truncate(str, max): string

Defined in: formatters/src/base-formatter.ts:127

Truncate string to max length with ellipsis.

Parameters¶

str¶

string

max¶

number

Returns¶

string

Inherited from¶

BaseFormatter.truncate

valueToString()¶

protected valueToString(value): string

Defined in: formatters/src/base-formatter.ts:154

Convert value to string representation.

Parameters¶

value¶

Value

Returns¶

string

Inherited from¶

BaseFormatter.valueToString

getSupportedVersions()¶

static getSupportedVersions(): object

Defined in: formatters/src/formatters/github.ts:209

Get supported versions for this formatter.

Returns¶

object

full¶

readonly full: object

full.description¶

readonly description: "Multifile + skills (.github/skills/) + agents (.github/agents/) + AGENTS.md" = 'Multifile + skills (.github/skills/) + agents (.github/agents/) + AGENTS.md'

full.name¶

readonly name: "full" = 'full'

full.outputPath¶

readonly outputPath: ".github/copilot-instructions.md" = '.github/copilot-instructions.md'

multifile¶

readonly multifile: object

multifile.description¶

readonly description: "Main + path-specific instructions (.github/instructions/) + prompts" = 'Main + path-specific instructions (.github/instructions/) + prompts'

multifile.name¶

readonly name: "multifile" = 'multifile'

multifile.outputPath¶

readonly outputPath: ".github/copilot-instructions.md" = '.github/copilot-instructions.md'

simple¶

readonly simple: object

simple.description¶

readonly description: "Single file output (.github/copilot-instructions.md)" = 'Single file output (.github/copilot-instructions.md)'

simple.name¶

readonly name: "simple" = 'simple'

simple.outputPath¶

readonly outputPath: ".github/copilot-instructions.md" = '.github/copilot-instructions.md'

Class: GitHubFormatter¶

Example¶

See¶

Extends¶

Constructors¶

Constructor¶

Returns¶

Inherited from¶

Properties¶

defaultConvention¶

Overrides¶

description¶

Overrides¶

name¶

Overrides¶

outputPath¶

Overrides¶

standardsExtractor¶

Inherited from¶

Methods¶

createRenderer()¶

Parameters¶

options?¶

Returns¶

Inherited from¶

dedent()¶

Parameters¶

text¶

Returns¶

Inherited from¶

extractExamples()¶

Parameters¶

ast¶

Returns¶

Examples¶

Inherited from¶

extractSectionWithCodeBlock()¶

Parameters¶

text¶

header¶

Returns¶

Inherited from¶

extractSkillExamples()¶

Parameters¶

skillProps¶

Returns¶

Inherited from¶

extractText()¶

Parameters¶

content¶

Returns¶

Inherited from¶

findBlock()¶

Parameters¶

ast¶

name¶

Returns¶

Inherited from¶

format()¶

Parameters¶

ast¶

options?¶

Returns¶

Overrides¶

formatArray()¶

Parameters¶

arr¶

Returns¶

Inherited from¶

formatStandardsList()¶

Parameters¶

items¶

Returns¶

Inherited from¶

getArrayElements()¶

Parameters¶

content¶

Returns¶

Inherited from¶

getMetaField()¶