Nuxt Typescript Bundle Template is a GitHub boilerplate for authoring Nuxt.js modules as TypeScript bundles, using the TypeScript compiler with the Vite bundler and preconfigured with linting, testing, and automated publishing.
What is Nuxt Typescript Bundle Template?
Nuxt Typescript Bundle Template is a starter repository that scaffolds a Nuxt.js module as a publishable TypeScript package. It takes a project skeleton with Nuxt, Vue, and TypeScript and produces an npm-ready bundle together with a playground Nuxt app for local development. The template is hosted on GitHub under productdevbookcom/nuxt-bundle-template and is licensed under the MIT License.
Key Features
The template ships with the following preconfigured tools:
- Nuxt + Vue — Uses Nuxt.js and Vue.js with TypeScript as the base framework stack for the bundle.
- Vite bundler — Builds the TypeScript bundle through Vite instead of a conventional library bundler.
- Vue Macros — Includes unplugin-vue-macros to enable additional Vue macro syntax.
- ESLint with Antfu config — Linting is set up using Antfu's ESLint config, with
pnpm lintandpnpm lint:fixscripts provided. - Bumpp — Generates GitHub changelogs and triggers version bumps through a dedicated release script.
- Vitest — Unit testing is configured with Vitest, runnable via
pnpm testorpnpm test:watch. - Pnpm — Package management and dependency installation are based on pnpm.
- GitHub Actions + NPM Local Registry — A CI workflow uses a local NPM registry to test the package before publishing; releases automatically publish git tags.
- Renovate — Dependency update automation is configured, requiring a GitHub App setup for Renovate.
Who is it for
- Nuxt module authors who want to start a new package with a working TypeScript + Vite build and a playground app, avoiding manual project setup.
- Open-source maintainers who need automated version bumping, changelog generation, and CI-driven publishing without extra plumbing.
- Vue/Nuxt developers who want a ready-made lint and test configuration based on community standard tooling.
What can you do with it
- Develop a Nuxt module: run
pnpm devto launch the development server, usepnpm dev:buildorpnpm dev:prepareto prepare the playground Nuxt app, and test changes interactively. - Publish a package: run
pnpm releaseto bump the version; the terminal asks for the version type, then commits and pushes, after which GitHub Actions publishes git tags and the NPM local registry publishes the package. - Maintain code quality: use
pnpm lintandpnpm testto catch issues, with watch modes available for continuous development.
How does it work
- Click the "Use this template" button on the GitHub repository to create a new project.
- Clone the repository locally and run
pnpm install. - Use
pnpm devto develop,pnpm buildto create the bundle, andpnpm releaseto cut a release.
The release flow is the most elaborate: Bumpp bumps the version, commits and pushes the change; then GitHub Actions publishes a git tag and the NPM local registry publishes the package automatically.
FAQ
What package manager does this template use?
The template requires pnpm. The README instructs installing dependencies with pnpm install and uses pnpm scripts for all development, build, test, and release commands.
How do I start developing with the template?
Clone the repo, run pnpm install, then pnpm dev to start the development server. To build the Nuxt playground app before developing, run pnpm dev:prepare or pnpm dev:build.
What happens when I run pnpm release?
The terminal prompts for the version type, then Bumpp automatically commits and pushes the changes. Behind the scenes, GitHub Actions publishes git tags and the NPM local registry publishes the package.
Is this template free to use?
Yes. The project is licensed under the MIT License, so it can be freely used, modified, and redistributed.
