OzzyRMOzzyRMDocs
Configuration

Watch options

Configure ozzyrm watch debounce, generate-on-start, and the hot stamp bridge.

watch controls the ozzyrm watch CLI and an optional hot-reload stamp for React bundlers. Production loadCatalog ignores watch options.

Forms

TypeScript
// disable the watcher entirely
watch: false

// enable with defaults
watch: true

// object form
watch: {
  enabled: true,
  debounceMs: 200,
  generateOnStart: true,
  hot: true,
}

Fields

FieldTypeDefaultPurpose
enabledbooleantrue when object/trueWhen false, ozzyrm watch is a no-op
debounceMsnumber200Wait after file changes before regenerate
generateOnStartbooleantrueRun one generate when watch starts
hotbooleanfalseWrite .ozzyrm/stamp.js so bundlers can invalidate

Hot stamp bridge

When hot: true, each successful generate writes an allowlisted .ozzyrm/stamp.js. Server helpers that import the stamp (for example OzzyRMDocsFromConfig) let the bundler reload after schema file edits while ozzyrm watch is running.

Terminal
npx ozzyrm watch   # terminal 1
# your React app dev server in terminal 2

Without the watcher, refresh the page after schema edits (or use your framework's equivalent of a dynamic server render).

Stamp contents are validated before import. Arbitrary JavaScript in stamp.js is rejected.

Next

On this page