Skip to content

renderers — Code View

← Back to Container | ← Back to System


Component Information

Field Value
Component renderers
Container Application
Type module
Description Render stage of the AAC pipeline | Mermaid image renderer | PlantUML image renderer | Structurizr DSL export renderer | Structurizr direct image renderer
---

Code Structure

Class Diagram

Class Diagram

Code Elements

13 code element(s) #### Functions ##### `run()` Execute the rendering stage | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promise` || **Location** | `C:/Users/chris/git/archlette/src/4-render/index.ts:36` | **Parameters:** - `ctx`: import("C:/Users/chris/git/archlette/src/core/types").PipelineContext — - Pipeline context with configuration, logging, and DSL file location --- ##### `mermaidRender()` Render Mermaid files to images | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promise` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/mermaid-render.ts:41` | **Parameters:** - `ctx`: import("C:/Users/chris/git/archlette/src/core/types").PipelineContext- `node`: any --- ##### `plantumlRender()` Render PlantUML files to PNG images | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promise` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/plantuml-render.ts:28` | **Parameters:** - `ctx`: import("C:/Users/chris/git/archlette/src/core/types").PipelineContext --- ##### `structurizrExport()` Export Structurizr DSL to PlantUML and/or Mermaid formats | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promise` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-export.ts:36` | **Parameters:** - `ctx`: import("C:/Users/chris/git/archlette/src/core/types").PipelineContext- `node`: any --- ##### `findGraphviz()` Find Graphviz dot command in PATH | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:41` | **Parameters:** - `log`: { debug?: (msg: string) => void; warn?: (msg: string) => void; } --- ##### `structurizrRender()` Render Structurizr DSL to images using CLI DOT export + Graphviz | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promise` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:74` | **Parameters:** - `ctx`: import("C:/Users/chris/git/archlette/src/core/types").PipelineContext- `node`: any --- ##### `extractStylesBlock()` Extract styles block from theme content using brace counting | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:267` | **Parameters:** - `content`: string --- ##### `removeBlock()` Remove a block from DSL content using brace counting | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:293` | **Parameters:** - `content`: string- `blockName`: string --- ##### `removeStylesBlock()` | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:319` | **Parameters:** - `content`: string --- ##### `removeBrandingBlock()` | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:323` | **Parameters:** - `content`: string --- ##### `escapeInvalidHtmlTags()` Escape all angle brackets that aren't part of valid DOT HTML tags. Handles cases where Structurizr inserts
for word-wrapping inside other tag-like content (e.g., that are NOT part of those tags | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:359` | **Parameters:** - `content`: string- `debug`: boolean --- ##### `sanitizeDotContent()` Sanitize DOT file content for Graphviz compatibility Applies string replacements only within label=<<...>> content, preserving the DOT structural syntax. | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `string` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:410` | **Parameters:** - `content`: string- `debug`: boolean --- ##### `sanitizeDotFiles()` Sanitize all DOT files in a directory | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `private` | | **Returns** | `void` || **Location** | `C:/Users/chris/git/archlette/src/renderers/builtin/structurizr-render.ts:501` | **Parameters:** - `dotDir`: string- `debug`: boolean ---