Stream 5 shipped a temporary local Curve enum (PascalCase) while stream 1 was in flight. Stream 1 has now landed nisps/core/math.hpp with the authoritative lowercase Curve enum per architecture spec. Generated C++ headers now include core/math.hpp and re-export the enum into the generated namespace via 'using Curve = ::nisps::Curve;'. - codegen/generate.ts: emit lowercase enum values + include math.hpp - regenerated all 8 mode schema headers - updated golden snapshot to match Verified all 8 headers compile clean with -std=c++20 -Wall -Wextra. |
||
|---|---|---|
| .. | ||
| templates | ||
| tests | ||
| .gitignore | ||
| generate.ts | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
MEMLNaut Mode-Schema Codegen
Bun + TypeScript tool that turns schemas/modes/*.json into:
- C++ headers under
nisps/modes/generated/<mode_id>_schema.hpp(constexprdata, no runtime cost). - TypeScript modules under
playground/src/modes/generated/<mode_id>_schema.ts(typedModeSchemaobjects).
The schemas are validated against schemas/schema.json (JSON Schema Draft 2020-12) on every run. Codegen exits non-zero if any schema fails validation.
Run
cd codegen
bun install # one-shot, fetches ajv + types
bun run generate.ts # or: bun run generate
The script writes everything into the two output dirs in one shot. Re-running with no schema changes is a no-op (byte-identical output).
Tests
tests/golden_test.ts regenerates from the live schemas into a temp dir and diffs against tests/golden/. The golden directory contains a snapshot of paf_synth_schema.{hpp,ts}. To refresh after intentional codegen changes:
bun run generate.ts
cp ../nisps/modes/generated/paf_synth_schema.hpp tests/golden/
cp ../playground/src/modes/generated/paf_synth_schema.ts tests/golden/
Run the test:
bun run test
Adding a new mode
- Drop a new
<mode_id>.jsonintoschemas/modes/(must validate againstschemas/schema.json). - Run
bun run generate.ts. - Commit the JSON + the regenerated C++/TS pair.
Layout
codegen/
├── package.json # ajv (+ formats) + bun-types
├── tsconfig.json
├── generate.ts # ~400 lines, single entrypoint
├── README.md # this file
├── templates/ # reference templates (NOT consumed — for review)
│ ├── cpp_schema.hpp.template
│ └── ts_schema.ts.template
└── tests/
├── golden_test.ts # diffs latest output against tests/golden/
└── golden/
├── paf_synth_schema.hpp
└── paf_synth_schema.ts
Conventions
- C++ namespace:
nisps::modes::generated. All generated symbols areinline constexprso#include-ing the header in multiple TUs is safe. - C++ types:
std::array,std::string_view,std::size_t. Nostd::vector, no heap. Curveenum: declared innisps/modes/generated/schema_types.hppas a temporary local copy. Once stream 1 landsnisps/core/math.hpp, replace the local enum with an#include(search forTODO(stream-1)in the generated header).- Float literals: emitted with explicit
.fsuffix and decimal point, per the perf contract (architecture §3.3). - Order: schemas are processed in alphabetical order of mode_id so output is stable.
- Naming:
mode_idissnake_casein JSON; the generated C++ const prefix isk+ PascalCase (e.g.kPafSynthParams); TS const is PascalCase +Schema(e.g.PafSynthSchema).