Contracts and edge cases

Platform spec article

Contracts and edge cases

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 contracts and edge cases 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

Normative requirements

ID	Requirement
FMT-001	Unclosed ** or __ spans must fall through as literal text (no panic).
FMT-002	Unknown bracket tag names must render as literal [name] text.
FMT-003	Backslash before a recognized sigil must emit the sigil literally and continue parsing.
FMT-004	Format must delegate to styled render only when ShouldStyle() is true.
FMT-005	Each styled span should reset attributes after the span (StyleChain / SGR reset).

Supported constructs (v1)

Construct	Effect when styled
**text**	Bold
__text__	Underline
[red]text[/]	Foreground palette (name table in Attributes.bd)
\[ etc.	Escape sigil

Edge cases

• Nested styles apply inner chain then outer tail recursively.
• Empty source returns "".
• Markup does not interpret HTML or full Markdown block syntax (headings, lists).

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