feat: extend git return things

Author: yjl9903

examples/vite/env.d.ts

@@ -1,3 +1,50 @@
+declare module '~build/git' {
+  /** Github repo url */
+  export const github: string | null;
+
+  /** The current branch */
+  export const branch: string;
+
+  /** SHA of the current commit */
+  export const sha: string;
+
+  /** The first 10 chars of the current SHA */
+  export const abbreviatedSha: string;
+
+  /** The tag for the current SHA (or `null` if no tag exists) */
+  export const tag: string | null;
+
+  /** The tags for the current SHA*/
+  export const tags: string[];
+
+  /** Tag for the closest tagged ancestor (or `null` if no ancestor is tagged) */
+  export const lastTag: string | null;
+
+  /** The committer of the current SHA */
+  export const committer: string;
+
+  /** The committer email of the current SHA */
+  export const committerEmail: string;
+
+  /** The commit date of the current SHA */
+  export const committerDate: string;
+
+  /** The author for the current SHA */
+  export const author: string;
+
+  /** The author email for the current SHA */
+  export const authorEmail: string;
+
+  /** The authored date for the current SHA */
+  export const authorDate: string;
+
+  /** The commit message for the current SHA */
+  export const commitMessage: string;
+
+  /** Gets whether this represents a clean working branch. */
+  export const isClean: boolean;
+}
+
 declare module '~build/meta' {
   export const message: string;
 }

examples/vite/main.ts

@@ -14,7 +14,8 @@ import {
   author,
   authorEmail,
   authorDate,
-  commitMessage
+  commitMessage,
+  isClean
 } from '~build/git';
 import { message } from '~build/meta';
 import { name, version } from '~build/package';
@@ -59,6 +60,7 @@ append('Author: ', author);
 append('Author Email: ', authorEmail);
 append('Author Date: ', authorDate);
 append('Commit Message: ', commitMessage);
+append('Is Clean: ', isClean ? 'true' : 'false');
 
 append('Message: ', message);
 

examples/vite/vite.config.ts

@@ -4,5 +4,15 @@ import BuildInfo from '../../src/vite';
 
 export default defineConfig({
   base: './',
-  plugins: [BuildInfo({ meta: { message: 'This is set from vite.config.ts' } })]
+  plugins: [
+    BuildInfo({
+      git: {
+        isClean: async (git) => {
+          const status = await git.status();
+          return status.isClean();
+        }
+      },
+      meta: { message: 'This is set from vite.config.ts' }
+    })
+  ]
 });

src/core/git.ts

@@ -2,27 +2,35 @@ import { type SimpleGit, simpleGit } from 'simple-git';
 
 import parseGitUrl from 'git-url-parse';
 
-export async function getRepoInfo(root: string) {
+import type { Options } from './types';
+
+export async function getRepoInfo(root: string, extra: Options['git'] = {}) {
   const git = simpleGit(root);
 
   if (!(await git.checkIsRepo())) {
     return undefined;
   }
 
-  const [branch, currentCommit, commiter, tags, github] = await Promise.all([
+  const [branch, currentCommit, commiter, tags, github, result] = await Promise.all([
     getBranch(git),
     getCommit(git),
     getCommitter(git),
     getTags(git),
-    getGitHubUrl(git)
+    getGitHubUrl(git),
+    Promise.all(
+      Object.entries(extra).map(async ([key, fn]) => {
+        return [key, await fn(git)] as const;
+      })
+    )
   ] as const);
 
   return {
     ...branch,
     ...currentCommit,
     ...commiter,
     ...tags,
-    ...github
+    ...github,
+    ...Object.fromEntries(result)
   };
 }
 

src/core/index.ts

@@ -47,8 +47,10 @@ export const UnpluginInfo = createUnplugin<Options | undefined>((option) => {
       if (id === ModuleName.BuildTime) {
         return `const time = new Date(${now.getTime()})\n` + 'export default time';
       } else if (id === ModuleName.BuildInfo || id === ModuleName.BuildGit) {
-        const info = await getRepoInfo(root);
-        const github = option?.github ?? info?.github;
+        const info = await getRepoInfo(root, option?.git);
+        if (info && option?.github) {
+          info.github = option.github;
+        }
 
         if (id === ModuleName.BuildInfo) {
           this.warn(
@@ -59,28 +61,34 @@ export const UnpluginInfo = createUnplugin<Options | undefined>((option) => {
           this.warn('This may not be a git repo');
         }
 
-        const gen = (key: keyof NonNullable<typeof info>) => {
-          return `export const ${key} = ${info ? JSON.stringify(info[key]) : 'undefined'}`;
+        const keys = [
+          ...new Set([
+            'github',
+            'sha',
+            'abbreviatedSha',
+            'branch',
+            'tag',
+            'tags',
+            'lastTag',
+            'author',
+            'authorEmail',
+            'authorDate',
+            'committer',
+            'committerEmail',
+            'committerDate',
+            'commitMessage',
+            ...Object.keys(option?.git ?? {})
+          ])
+        ];
+        const gen = (key: string) => {
+          return `export const ${key} = ${info ? JSON.stringify((info as any)[key]) : 'null'}`;
         };
 
         return [
           id === ModuleName.BuildInfo
             ? `export const CI = ${ci.isCI ? `"${ci.name}"` : 'null'}`
             : ``,
-          `export const github = ${JSON.stringify(github ?? null)}`,
-          gen('sha'),
-          gen('abbreviatedSha'),
-          gen('branch'),
-          gen('tag'),
-          gen('tags'),
-          gen('lastTag'),
-          gen('author'),
-          gen('authorEmail'),
-          gen('authorDate'),
-          gen('committer'),
-          gen('committerEmail'),
-          gen('committerDate'),
-          gen('commitMessage')
+          ...keys.map((key) => gen(key))
         ].join('\n');
       } else if (id === ModuleName.BuildCI) {
         return [

src/core/types.ts

@@ -1,3 +1,5 @@
+import type { SimpleGit } from 'simple-git';
+
 export interface Options {
   /**
    * Git repo root path
@@ -9,6 +11,11 @@ export interface Options {
    */
   github?: string;
 
+  /**
+   * Custom the exported fields in ~build/git
+   */
+  git?: Record<string, (git: SimpleGit) => Promise<any> | any>;
+
   /**
    * Custom virtual module prefix
    *