The compiler

Think of fumablox as a small compiler. The frontend is Luau. The IR is a project model. Fumadocs MDX is one of several backends.

What it reads

From source, not only from tags:

Comments are annotations on that model. They never have to repeat a signature the parser already has.

The Aircraft rule

This example has no @class and no @param:

export type Aircraft = {
    altitude: number,
    speed: number,
    Takeoff: (self: Aircraft) -> (),
    Land: (self: Aircraft) -> (),
}

function Aircraft:Takeoff()
end

The compiler still emits Aircraft:

• altitude / speed as properties
• Takeoff / Land as methods (self means method, not callback)
• TookOff: RBXScriptSignal as an event
• AircraftState as an enum
• MAX_SPEED as a constant
• FlightController as a dependant

IR

fumablox extract --out api.json writes the whole model: classes, modules, graph, hierarchy, coverage, and Wally packages. That JSON is what an LSP, GitHub Action, or Studio plugin would consume later. Documentation is one backend, not the product.

import { extractProject, loadConfig } from '@metricsrb/fumablox';

const { config } = loadConfig(process.cwd());
const model = extractProject({ cwd: process.cwd(), config });

Backends today

• Fumadocs MDX — fumablox generate
• Stdout / JSON — fumablox extract
• Terminal — check, coverage, graph, search, diff