Generator, Analyzer, Rewriter

Informative guide. This Book page explains Beskid but does not define the standard. For normative requirements, use the Beskid Standard.

Three roles, one merged program. Order matters; host merge is bounded and fail-closed.

Generator

• Emits typed AST fragments only.
• Host merges, re-parses, repeats up to maxGeneratorRounds.
• Incremental by default: don’t regenerate the universe per keystroke.

Spec: Typed emitter and transforms.

Analyzer

• Runs on host + generated code after semantic snapshot exists.
• Emits diagnostics; may register rewrites as fixes.
• Must not assume generated code is “second class”: it’s all one program now.

Spec: Analysis, query, and diagnostics facades.

Rewriter

// Conceptual shape: see SDK for exact signatures
Result<TTargetNode, FixError> Rewrite(TSourceNode sourceNode);

Replaces any valid node with any other valid typed node: power with responsibility. Conflicts → diagnostics, not silent corruption.

sequenceDiagram
  accTitle: Host calls into a Mod
  accDescr: The host asks the Collector for targets, loops Generate calls with merge and reparse, asks the Analyzer for diagnostics and fixes, and applies the Rewriter to a node.
  participant H as Mod host
  participant M as Mod contracts
  H->>M: Collector.Collect(request)
  M-->>H: CollectTargetSet
  loop up to maxGeneratorRounds
    H->>M: Generator.Generate(request)
    M-->>H: typed AST contribution
    H->>H: merge and reparse
  end
  H->>M: Analyzer.Analyze(request)
  M-->>H: diagnostics and quick fixes
  H->>M: Rewriter.Rewrite(sourceNode)
  M-->>H: Result of target node or FixError

Text equivalent: The host collects targets, then repeats generate, merge and reparse up to maxGeneratorRounds. It then runs the analyzer for diagnostics and fixes and applies the rewriter, which returns a Result with the target node or a FixError.

Conflict policy

Scheduling and determinism: Incremental scheduling and determinism. When two mods fight over the same node, the host picks a documented winner or fails. Read the ADRs before betting production on undocumented merge luck.

Next

beskid mod CLI