Examples

Platform spec article

Examples

Back to Console markup format ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0030-markup-not-full-commonmark Markup is not full CommonMark Accepted

   Only the tested markup subset is normative.

   Context

   Console.Format targets terminal styling, not a document renderer.

   Decision

   Rule	Detail
   Scope	Tested sigils and markdown subset only
   Non-goal	Full CommonMark compliance

   Consequences

   New syntax requires tests before Standard promotion.

   Verification anchors

   FormatMarkdownTests.bd; Format/Scan.bd.

   Open full ADR page

2. 0031-bracket-palette-tags-v1 Bracket palette tags in v1 Accepted

   Bracket color tags map to fixed palette names.

   Context

   Arbitrary RGB in markup v1 would bypass capability downgrade rules.

   Decision

   Rule	Detail
   Tags	[red]-style names map to fixed palette
   RGB	Not supported inside markup v1

   Consequences

   Authors use Ansi builders for advanced color outside markup.

   Verification anchors

   FormatAttributesTests.bd.

   Open full ADR page

Articles

• Contracts and edge cases Markup parsing rules and rendering requirements. article Standard Reviewed Thu May 21
• Design model Markup syntax layers and render pipeline overview. article Standard Reviewed Thu May 21
• Examples Console markup usage for CLI output. article Standard Reviewed Thu May 21
• Flow and algorithm Recursive descent rendering for console markup. article Standard Reviewed Thu May 21
• Verification and traceability Markup golden tests and module anchors. article Standard Reviewed Thu May 21

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 3 SpecSection(s) · 1 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Console markup format

  Parent feature hub

Purpose

Show how application code turns console markup into syscall-backed stdout/stderr lines using Console.Format and the split stream modules.

Canonical references

• Feature hub: Console markup format
• Parsing rules: contracts and edge cases (FMT-001–FMT-005)
• Escape tables: ANSI escape model / design model
• Write surface: Console I/O streams / examples

Detailed behavior

One-line styled output

Console.FormatLine("[green]ok[/] **built** in 12ms");

FormatLine renders with ShouldStyle() (same predicate as ShouldEmitAnsi()), then calls System.Output.WriteLine. When color is stripped, output is plain text without bracket tags interpreted as color.

Plain vs styled render entry points

string plain = Console.Format.Markdown.RenderPlain("[red]ignored[/]");
string styled = Console.Format.Markdown.RenderStyled("[red]alert[/]");

Use RenderPlain for logs and redirected stdout; use RenderStyled or Format when building strings that will be gated before write.

Nested styles

string line = Console.Format.Markdown.RenderStyled(
    "[blue]**Error:**[/] file not found"
);
System.Output.WriteLine(line);

Inner ** spans compose with outer bracket color via Ansi.StyleChain (see flow and algorithm).

Verification

Golden coverage: FormatMarkdownTests.bd, FormatAttributesTests.bd, AnsiStyleChainTests.bd under compiler/corelib/beskid_corelib/tests/corelib_tests/src/console/.

Related topics

• Console capabilities — when ShouldStyle() is false
• Console controls — full-screen widgets that may call Format for labels