Design model

Platform spec article

Design model

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

Document design model for the Console Markup Format feature: role-specific normative detail beyond the feature hub.

Canonical references

• Feature hub: Console Markup Format
• Sibling articles in this bundle (design model, contracts, flow, examples, verification)

Detailed behavior

Pipeline

1. Scan — Console.Format.Scan provides length, prefix, slice, and index helpers (no allocation-heavy regex engine).
2. Parse — Markdown.RenderInner walks the source recursively for **, __, \ escapes, and bracket tags.
3. Style — Attributes / StyleChain map names (red, bold) to Ansi.Sgr or chain steps.
4. Emit — Concatenated gated escape prefixes wrap plain text segments.

Plain vs styled

Entry	ansi flag	Use
RenderPlain	false	Logs and non-TTY snapshots
RenderStyled / Format	true	Interactive terminal UI

Escape authority

Sequence bytes are defined in ANSI escape model; markup must not embed raw ESC except via the Ansi builders.

Verification

See the verification and traceability article in this bundle and compiler/corelib/beskid_corelib/tests/corelib_tests/src/console/.

Related topics

• Parent feature hub and Terminal and console area