Nuxt Git Info

This module wraps git-repo-info to provide information about the current git repository in your Nuxt app. All the information is available at build time and can be accessed in your Nuxt app through the public runtime config, under the gitInfo key.

• ✨  Release Notes

Features

• Provides information about the current git repository as per git-repo-info module. See git-repo-info for more information.

Quick Setup

1. Add nuxt-git-info dependency to your project

# Using pnpm
pnpm add -D nuxt-git-info

# Using yarn
yarn add --dev nuxt-git-info

# Using npm
npm install --save-dev nuxt-git-info

# Using bun
bun add -D nuxt-git-info

2. Add nuxt-git-info to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-git-info'
  ]
})

That's it! You can now use Nuxt Git Info in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release