API Reference live_vue_contract v#0.3.1

Copy Markdown View Source

Modules

LiveVueContract

Makes the props contract between <.vue> and defineProps<T>() red before production.

LiveVueContract.Schema

Reads the generated contract file (JSON-Schema subset per Vue component) and validates encoded props against it.

LiveVueContract.Tags

Compile-time check of <.vue> tags: walks a compiled HEEx template and compares the attributes of every literal <.vue v-component="X" ...> (and <.X> shortcut) with the schema of X.

Mix Tasks

mix compile.live_vue_contract

Runs priv/gen.mjs (node + vue-component-meta from the host's node_modules) when the sources of the contract changed since the last run.