Skip to content
The Walnut Prophecy · Docs

7. walnut.js

The package. Already public. The docs site is the canonical home for usage examples, story-aware code patterns, and theCompiler_1st code-comment voice.

Install

Section titled “Install”
Terminal window
npm install @1stcompiler/walnut.js

What walnut.js is

Section titled “What walnut.js is”

A satirical npm package authored by theCompiler_1st on behalf of the Bureau. The package’s API surface is canonical. The error messages are canonical. The acorn logo is canonical. The compilation methodology is canonical (cache fragments, getting things wrong in interesting ways, signing the resulting code).

Status: live. Current version: see the npm registry. The package’s existence is part of the trilogy’s surface; bugs filed against the package are also Bureau filings.

Sub-pages

Section titled “Sub-pages”

PROCESSING. Sub-pages will land as canonical sources land.

  • API surface: nutCall, declare, burrow, bureau.silent, notice, log, PathReturn
  • The story-aware code comments (theCompiler_1st voice)
  • Compiler’s Notes (the easter egg)
  • The OracleExhausted call window
  • Package errors that break the fourth wall
  • How to contribute to walnut.js (separate from contributing to the trilogy)

Cross-references

Section titled “Cross-references”