npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

valaxy-addon-git-log

v0.2.1

Published

Integrates git logs into your page of Valaxy site.

Downloads

266

Readme

Installing this Plugin

pnpm add valaxy-addon-git-log

By default, the plugin retrieves Git information via API. Due to the limitations of static servers, it may not automatically obtain the repository address from the Git environment. Therefore, it is recommended to manually provide the repository address as shown below:

import { defineValaxyConfig } from 'valaxy'
import { addonGitLog } from 'valaxy-addon-git-log'

export default defineValaxyConfig({
  addons: [
    addonGitLog({
      repositoryUrl: 'https://github.com/your-username/your-repository.git',
    }),
  ],
})

Using this Plugin

Basic Usage

To add Git contributors to a page, use the GitLogContributor component:

<template>
  <GitLogContributor />
</template>

Customization examples

If you are a theme developer or want to customize pages with git information, you can refer to the following example:

<script setup lang="ts">
import { useGitLog } from 'valaxy-addon-git-log'

const gitLog = useGitLog()
</script>

<template>
  <ul>
    <li v-for="contributor in gitLog.contributors" :key="contributor.email">
      <img :src="contributor.avatar" alt="Avatar" width="30" height="30">
      {{ contributor.name }}
    </li>
  </ul>
</template>

Configuration / Options

In your project (wether theme or addon), you can write this in valaxy.config.ts.

export default defineValaxyConfig<ThemeConfig>({
  addons: [
    addonGitLog({
      contributor: {
        mode: 'api',
        // logArgs: '--first-parent --follow',
      },
    }),
  ],
})

| Name | Type | Default | Description | | ------------------- | ------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | repositoryUrl | string | undefined | The URL of the GitHub repository. This is used to specify the repository from which to fetch information. | | contributor.mode | 'api' | 'git' | 'api' | Defines the method to retrieve Git contributor information. If set to 'api', the GitHub API is used. If set to 'log', the git log command is used during build time, with the --no-merges parameter added by default. | | contributor.logArgs | string | '' | Additional arguments passed to the git log command when contributor.mode is set to 'git'. These arguments can customize the git log query (e.g., limiting the number of commits, filtering by date, etc.). |

[!WARNING] If you use the git method to deploy projects on static servers (such as Netlify, Vercel), there may be restrictions. To ensure proper deployment on these platforms, please use the api method.

Components

GitLogContributor

<template>
  <GitLogContributor />
</template>

GitLogChangelog

<template>
  <GitLogChangelog />
</template>

Composables

useGitLog

This composable provides a simple way to fetch Git log data based on the current page's context.

import { useGitLog } from 'valaxy-addon-git-log'
import { computed } from 'vue'

const gitLog = useGitLog()
const contributors = computed(() => gitLog.value.contributors)
const changeLog = computed(() => gitLog.value.changeLog)

Return Type:

export interface GitLog {
  contributors: Contributor[]
  changeLog: Changelog[]
  path: string
}

| Name | Type | Description | | ------------ | --------------- | -------------------------------- | | contributors | Contributor[] | see useContributor return type | | changeLog | Changelog[] | see useChangelog return type | | path | string | |

useContributor

import { useContributor } from 'valaxy-addon-git-log'

const contributor = useContributor()

Return Type:

export interface Contributor {
  name: string
  email: string
  avatar: string
  count: number
  github: string | null
  hash: string
}[]

| Name | Type | Description | | ------ | ---------------- | ------------------------------------------------------------------ | | name | string | Contributor's name | | email | string | Contributor's email | | avatar | string | Contributor's avatar URL, obtained through gravatar based on email | | count | number | Number of contributions | | github | string \| null | Only supported api mode | | hash | string | A unique hash generated based on the contributor's email |

useChangelog

import { useChangelog } from 'valaxy-addon-git-log'

const changelog = useChangelog()

Return Type:

export interface Changelog {
  functions: string[]
  version?: string
  hash: string
  date: string
  message: string
  refs?: string
  body?: string
  author_name: string
  author_email: string
}[]

| Name | Type | Description | | -------------- | ----------------------- | ----------------------------------------------------------------------- | | functions | string[] | List of functions affected or related to the changelog entry. | | version | string | undefined | Optional version number for the release or update. | | hash | string | Unique identifier or commit hash for the change. | | date | string | The date when the change was made or the changelog entry was created. | | message | string | A brief summary or description of the change. | | refs | string | undefined | Optional reference information, such as ticket IDs or PR links. | | body | string | undefined | Optional detailed body content or additional explanation of the change. | | author_name | string | Name of the person who made the change. | | author_email | string | Email address of the person who made the change. |

Other

Virtual modules

import changelog from 'virtual:git-log/changelog'

The changelog variable contains all the commit logs.

import contributors from 'virtual:git-log/contributors'

The contributors variable contains information about all contributors.