Class: ConventionRenderer¶

Defined in: formatters/src/convention-renderer.ts:7

Convention renderer for applying output conventions to formatted content.

Constructors¶

Constructor¶

new ConventionRenderer(convention): ConventionRenderer

Defined in: formatters/src/convention-renderer.ts:10

Parameters¶

convention¶

string | OutputConvention

Returns¶

ConventionRenderer

Methods¶

getConvention()¶

getConvention(): OutputConvention

Defined in: formatters/src/convention-renderer.ts:27

Get the current convention.

Returns¶

OutputConvention

getSectionSeparator()¶

getSectionSeparator(): string

Defined in: formatters/src/convention-renderer.ts:93

Get the section separator based on convention.

Returns¶

string

renderCodeBlock()¶

renderCodeBlock(code, language): string

Defined in: formatters/src/convention-renderer.ts:75

Render a code block.

Parameters¶

code¶

string

language¶

string = ''

Returns¶

string

renderList()¶

renderList(items): string

Defined in: formatters/src/convention-renderer.ts:67

Render a list of items.

Parameters¶

items¶

string[]

Returns¶

string

renderSection()¶

renderSection(name, content, level): string

Defined in: formatters/src/convention-renderer.ts:38

Render a section with the convention.

Parameters¶

name¶

string

Section name (e.g., 'project', 'tech-stack')

content¶

string

Section content

level¶

number = 1

Nesting level (1 = section, 2+ = subsection)

Returns¶

string

wrapRoot()¶

wrapRoot(content): string

Defined in: formatters/src/convention-renderer.ts:83

Wrap content with root wrapper if defined.

Parameters¶

content¶

string

Returns¶

string