Skip to content

SCAFFOLD.md

Latest commit

 

History

History
65 lines (42 loc) · 3.18 KB

SCAFFOLD.md

File metadata and controls

65 lines (42 loc) · 3.18 KB

Scaffold instructions for coding agents

You (the coding agent spawned by the Eliza orchestrator) are responsible for turning this template into a working Eliza app. Read this entire file before editing.

1. Replace placeholders

Every file in this template contains one or both of:

  • __APP_NAME__ — the npm-style package name. Use lowercase, hyphenated. Scope it under @elizaos/ for first-party apps, otherwise pick a sensible scope.
  • __APP_DISPLAY_NAME__ — the human-readable name shown in the dashboard.

Replace all occurrences in package.json, index.html, src/, tests/, and README.md. Do not leave a single placeholder behind — verification will fail.

2. Fill in real metadata

In package.json:

  • Replace the placeholder description with one factual sentence about what the app does.
  • Set elizaos.app.category to one of the canonical categories (game, utility, productivity, social, creative, dev-tools, finance, media).
  • Replace assets/hero.png with a real hero image when you have one. The placeholder 1x1 PNG is intentional — do not delete it without a replacement.

3. Implement the actual feature

The default runtime plugin is intentionally empty. Add real actions, providers, and UI for whatever the user asked for. Keep one passing test in tests/ that exercises the new code path.

4. Verify before signaling done

Run, in this order, from the app's package directory:

bun run typecheck
bun run lint
bun run test

All three must exit zero. If one fails, fix it. Do not silence errors with unsafe casts to any, // @ts-ignore, broad try/catch, or ?? defaultValue patterns that hide missing data.

5. Signal completion

After verification passes, emit a single line on stdout:

APP_CREATE_DONE {"appName":"<__APP_NAME__>","files":["<list>"],"tests":{"passed":<n>,"failed":0},"lint":"ok","typecheck":"ok","description":"<one factual sentence>"}

Field contract (all required except description):

  • appName — string, the npm-style package name you used in package.json.
  • files — array of repo-relative paths you created or modified.
  • tests — object with the exact Vitest count: passed is the verified passed count and failed must be 0.
  • lint — literal "ok", only after bun run lint exits zero.
  • typecheck — literal "ok", only after bun run typecheck exits zero.
  • description — optional one-sentence summary of what the app does.

Do not emit legacy fields such as name, testsPassed, or lintClean; the orchestrator rejects them.

The orchestrator will cross-check the claims against disk and the verification log. If anything you assert does not match reality, it will retry you with a structured failure report (capped by ELIZA_APP_VERIFICATION_MAX_RETRIES, default 3).

Rules

  • Single source of truth: derived state lives in the use case / action handler, not the React component.
  • No business math in the React UI. Read DTO fields and format only.
  • Logger over console.* for any runtime code (UI may use console for browser-side dev).
  • DTO fields are required by default. No ?? 0 or as casts to skip missing data.
  • Do not invent endpoints with no UI trigger.