chore: add CI, tests, tsconfig and improve code quality

- Add GitHub Actions CI workflow (lint, test, typecheck)
- Add unit tests for gitLog, github utils, and render utils
- Add tsconfig.json, env.d.ts, vitest.config.ts, eslint.config.js
- Extract regex constants for performance (RE_*) across utils and node modules
- Fix committer_date field mapping in gitLog and contributor parsing
- Make repositoryUrl configurable instead of hardcoding vueuse
- Add null check for repo in renderCommitMessage
- Fix type documentation format in README

Author: YunYouJun

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm test
+      - run: pnpm lint
+      - run: pnpm typecheck

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "valaxy"
+  ]
+}

README.md

@@ -161,7 +161,9 @@ export interface Contributor {
   count: number
   github: string | null
   hash: string
-}[]
+}
+
+// type: Contributor[]
 ```
 
 | Name   | Type             | Description                                                        |
@@ -194,7 +196,9 @@ export interface Changelog {
   body?: string
   author_name: string
   author_email: string
-}[]
+}
+
+// type: Changelog[]
 ```
 
 | Name           | Type                    | Description                                                             |

components/GitLogChangelog.vue

@@ -2,9 +2,13 @@
 import { functions } from '@vueuse/metadata'
 import changelog from 'virtual:git-log/changelog'
 import { computed } from 'vue'
+import { useAddonGitLogConfig } from '../client'
 import { renderCommitMessage } from '../utils'
 
 const props = defineProps<{ fn: string }>()
+const gitLogOptions = useAddonGitLogConfig()
+const repositoryUrl = computed(() => gitLogOptions.value.repositoryUrl || '')
+
 const info = computed(() => functions.find(i => i.name === props.fn))
 
 const names = computed(() => [props.fn, ...info.value?.alias || []])
@@ -42,7 +46,7 @@ const commits = computed(() => {
         </div>
         <div>
           <a
-            :href="`https://github.com/vueuse/vueuse/releases/tag/${commit.version}`"
+            :href="`${repositoryUrl}/releases/tag/${commit.version}`"
             target="_blank"
           >
             <code class="!text-primary font-bold">{{ commit.version }}</code>
@@ -53,12 +57,12 @@ const commits = computed(() => {
       <template v-else>
         <octicon-git-commit-16 class="m-auto rotate-90 transform opacity-30" />
         <div>
-          <a :href="`https://github.com/vueuse/vueuse/commit/${commit.hash}`" target="_blank">
+          <a :href="`${repositoryUrl}/commit/${commit.hash}`" target="_blank">
             <code class="!hover:text-primary !text-xs !text-$vp-c-text-2">{{ commit.hash.slice(0, 5) }}</code>
           </a>
           <span text="sm">
             -
-            <span v-html="renderCommitMessage(commit.message.replace(`(${fn})`, ''))" />
+            <span v-html="renderCommitMessage(commit.message.replace(`(${fn})`, ''), repositoryUrl)" />
           </span>
         </div>
       </template>

env.d.ts

@@ -0,0 +1,19 @@
+export {}
+
+declare module 'valaxy' {
+  import type { ComputedRef } from 'vue'
+
+  interface ValaxyAddon<AddonOptions = Record<string, any>> {
+    name: string
+    global?: boolean
+    props?: Record<string, any>
+    options?: AddonOptions
+  }
+
+  interface RuntimeConfig {
+    addons: Record<string, ValaxyAddon>
+  }
+
+  export function useFrontmatter<T extends Record<string, any> = Record<string, any>>(): ComputedRef<T>
+  export function useRuntimeConfig(): ComputedRef<RuntimeConfig>
+}

eslint.config.js

@@ -0,0 +1,4 @@
+// @ts-check
+import antfu from '@antfu/eslint-config'
+
+export default antfu()

node/changeLog.ts

@@ -4,6 +4,9 @@ import { git } from '.'
 
 let cache: Changelog[] | undefined
 
+const RE_BACKSLASH = /\\/g
+const RE_PACKAGE_PATH = /^packages\/\w+\/(\w+)\/\w+\.ts$/
+
 /**
  * Separator used to split combined git log output into per-commit blocks.
  */
@@ -63,10 +66,10 @@ export async function getChangelog(maxCount = 200, path?: string) {
     }
     else {
       // Changed files are on the remaining non-empty lines
-      const files = lines.slice(1).filter(Boolean).map(f => f.replace(/\\/g, '/'))
+      const files = lines.slice(1).filter(Boolean).map(f => f.replace(RE_BACKSLASH, '/'))
       log.functions = uniq(
         files
-          .map(i => i.match(/^packages\/\w+\/(\w+)\/\w+\.ts$/)?.[1])
+          .map(i => i.match(RE_PACKAGE_PATH)?.[1])
           .filter(Boolean),
       )
     }

node/contributor.ts

@@ -1,5 +1,5 @@
 import type { Contributor, GitLogOptions } from '../types'
-import { execSync } from 'node:child_process'
+import { execFileSync } from 'node:child_process'
 import gravatar from 'gravatar'
 import md5 from 'md5'
 import { git } from '.'
@@ -9,7 +9,7 @@ export async function getContributors(filePath?: string, options?: GitLogOptions
   const { contributor } = options || {}
 
   try {
-    const gitArgs: string[] = ['log', '--no-merges', '--pretty=format:"%an|%ae"']
+    const gitArgs: string[] = ['log', '--no-merges', '--pretty=format:%an|%ae']
 
     const additionalArgs: string[] = [
       filePath && `--`,
@@ -21,7 +21,7 @@ export async function getContributors(filePath?: string, options?: GitLogOptions
 
     const contributorsMap = gitLog
       .split('\n')
-      .map(line => line.slice(1, -1).split('|') as [string, string])
+      .map(line => line.split('|') as [string, string])
       .filter(([_, email]) => email)
       .reduce((acc, [name, email]) => {
         if (!acc[email]) {
@@ -50,6 +50,6 @@ export async function getContributors(filePath?: string, options?: GitLogOptions
 }
 
 export function getLastUpdated(filePath: string) {
-  const lastUpdated = execSync(`git log -1 --format=%ct ${filePath}`, { encoding: 'utf-8' })
+  const lastUpdated = execFileSync('git', ['log', '-1', '--format=%ct', '--', filePath], { encoding: 'utf-8' })
   return Number.parseInt(lastUpdated, 10) * 1000
 }

node/gitLog.ts

@@ -1,14 +1,24 @@
-import type { EditableTreeNode } from 'unplugin-vue-router'
+import type { EditableTreeNode } from 'vue-router/unplugin'
 import type { Changelog, Contributor, GitLogFileEntry, GitLogOptions } from '../types'
 import path from 'node:path'
 import process from 'node:process'
 import consola from 'consola'
+import fs from 'fs-extra'
 import gravatar from 'gravatar'
 import md5 from 'md5'
-import fs from 'fs-extra'
 import { git } from '.'
 import { guessGitHubUsername } from '../utils'
 
+const RE_WHITESPACE = /\s+/
+
+interface FrontmatterWithGitLog {
+  git_log: Record<string, any>
+}
+
+function getFrontmatter(route: EditableTreeNode): FrontmatterWithGitLog {
+  return route.meta.frontmatter as FrontmatterWithGitLog
+}
+
 export const destDir = path.resolve(process.cwd(), './public')
 // Only allow files from the user's working directory 'pages' folder
 export const currentWorkingDirectory = path.join(process.cwd(), 'pages')
@@ -73,8 +83,9 @@ export async function handleGitLogInfo(options: GitLogOptions, route: EditableTr
   if (!filePath)
     return
 
-  if (!route.meta.frontmatter.git_log)
-    route.meta.frontmatter.git_log = {}
+  const frontmatter = getFrontmatter(route)
+  if (!frontmatter.git_log)
+    frontmatter.git_log = {}
 
   // Ensure basePath is available before computing relative path
   let resolvedBase: string
@@ -87,7 +98,7 @@ export async function handleGitLogInfo(options: GitLogOptions, route: EditableTr
   }
 
   const gitRelativePath = path.relative(resolvedBase, filePath).split(path.sep).join('/')
-  route.meta.frontmatter.git_log.path = gitRelativePath
+  frontmatter.git_log.path = gitRelativePath
 
   if (!isPrebuilt && !isBuildTime)
     return
@@ -115,7 +126,7 @@ async function batchGetContributors(resolvedBase: string, filePaths: string[], o
       '--no-merges',
       '--pretty=format:---COMMIT_SEP---%an|%ae',
       '--name-only',
-      ...(contributor?.logArgs ? contributor.logArgs.trim().split(/\s+/) : []),
+      ...(contributor?.logArgs?.trim() ? contributor.logArgs.trim().split(RE_WHITESPACE) : []),
       '--',
       ...filePaths,
     ]
@@ -301,8 +312,9 @@ export async function flushGitLogBatch(options: GitLogOptions) {
     const changeLog = changelogMap.get(filePath) || []
 
     if (isBuildTime) {
-      route.meta.frontmatter.git_log.contributors = contributors
-      route.meta.frontmatter.git_log.changeLog = changeLog
+      const frontmatter = getFrontmatter(route)
+      frontmatter.git_log.contributors = contributors
+      frontmatter.git_log.changeLog = changeLog
     }
 
     if (isPrebuilt) {

package.json

@@ -1,7 +1,8 @@
 {
   "name": "valaxy-addon-git-log",
+  "type": "module",
   "version": "0.3.4",
-  "packageManager": "pnpm@9.15.0",
+  "packageManager": "pnpm@10.33.0",
   "description": "Integrates git logs into your page of Valaxy site.",
   "repository": "https://github.com/valaxyjs/valaxy-addon-git-log",
   "keywords": [
@@ -13,23 +14,32 @@
   "main": "index.ts",
   "types": "index.d.ts",
   "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run",
+    "typecheck": "vue-tsc --noEmit",
     "release": "bumpp"
   },
   "peerDependencies": {
     "valaxy": ">=0.22"
   },
   "dependencies": {
-    "@octokit/rest": "^21.0.2",
-    "fs-extra": "^11.3.0",
+    "@octokit/rest": "^22.0.1",
+    "fs-extra": "^11.3.4",
     "gravatar": "^1.8.2",
     "md5": "^2.3.0",
-    "simple-git": "^3.27.0"
+    "simple-git": "^3.33.0"
   },
   "devDependencies": {
+    "@antfu/eslint-config": "^7.7.3",
     "@types/fs-extra": "^11.0.4",
     "@types/gravatar": "^1.8.6",
-    "@types/md5": "^2.3.5",
-    "bumpp": "^10.1.0",
-    "valaxy": "^0.23.0"
+    "@types/md5": "^2.3.6",
+    "bumpp": "^11.0.1",
+    "eslint": "^10.1.0",
+    "typescript": "^5.9.3",
+    "valaxy": "^0.28.1",
+    "vitest": "^4.1.2",
+    "vue-tsc": "^3.2.6"
   }
 }