Development Workflow

Install dependencies

The repository uses pnpm:

pnpm install

Run the playground

pnpm dev

The command prepares the module and starts the Nuxt application in playground/. Use its pages and JSON files to verify runtime registration, presets, route changes, and generated head output.

Run checks

pnpm test
pnpm playground:build

The test command runs unit tests followed by the Nuxt integration project.

Build the package

pnpm build

This prepares the Nuxt module types and builds the package entries in dist/module/.

Work on the documentation

pnpm docs:dev
pnpm docs:build
pnpm docs:preview

docs:build is the final check for broken VitePress links and invalid documentation configuration.