Skip to content

gaslamp Documentation

Project Structure

Repository Overview¶

Top-level Directories¶

Directory	Description
`src/`	TypeScript source code
`gaslamp/`	GAS project files including the bundled library
`pilotlamp/`	GAS test/example project
`legacy/`	Archived modules (v0 and v1 implementations)
`__tests__/`	Vitest unit tests (Node.js)
`docs/`	Documentation (MkDocs)
`scripts/`	Build utility scripts
`specs/`	Feature specification documents (SpecKit format)

Source Modules (`src/`)¶

Module	Description
`torch/`	Core data processing — Expression, BareFrame, FlameFrame, LazyFrame, AfterGlow, FlameWright
`gaslets/`	GAS-specific utilities — Book, Sheet, Calendar, Drive, Trigger
`gears/`	General utilities — ClockSmith, Counter, JunkPocket
`jestlite/`	GAS-compatible testing framework — Expect, Matcher, TestSuite
`remnantflicker/`	Warning and deprecation utilities

Module Relationships¶

graph TD
  subgraph Torch
    EX[Expression]
    FF[BareFrame]
    FrF[FlameFrame]
    LF[LazyFrame]
    AG[AfterGlow Logger]
    FW[FlameWright]
    FG[FlameGuards]
  end

  subgraph Gaslets
    SA[SheetArtisan]
    BA[BookArtisan]
    CA[CalendarArtisan]
  end

  subgraph Gears
    CS[ClockSmith]
    CT[Counter]
    JP[JunkPocket]
  end

  subgraph JestLite
    ES[Expect/Matcher]
    TS[TestSuite]
  end

  EX -->|filter| FF
  FrF -->|uses| FF
  LF -->|wraps| FF

  FG -->|used by| FF
  FG -->|used by| FrF
  FW -->|builds| FG

  SA -->|writes| FF
  BA -->|integrates| FF

  AG -->|logs| CT
  CS -->|timing| CT

Contributing — How to contribute code and guidelines
GitLab Workflow — Issue and merge request workflow
Setup — Environment setup for development
Conceptual Guides — Design philosophy behind each module