feat(git): 添加获取本地 Git 仓库信息列表功能

- 新增 get_local_git_repo_info_list 函数，用于获取指定路径下的 Git 仓库信息列表
- 添加递归查找功能，可以深度搜索指定目录下的所有 Git 仓库信息
- 优化 parse_git_url 函数，增加返回仓库的 HTML 地址
- 新增 LocalGitInfoType、LocalGitInfoListType 等类型定义，用于规范 Git 仓库信息的数据结构

Author: wuliya336

package.json

@@ -65,7 +65,8 @@
     "test": "tsx test/index.ts"
   },
   "dependencies": {
-    "axios": "npm:@candriajs/[email protected]",
+    "@candriajs/exec": "^1.0.4",
+    "axios": "npm:@candriajs/[email protected]",
     "color-convert": "^3.1.0",
     "dayjs": "^1.11.13",
     "exec": "npm:@candriajs/exec@^1.0.2",
@@ -74,8 +75,8 @@
     "https-proxy-agent": "^7.0.6",
     "jsonwebtoken": "^9.0.2",
     "language-colors": "^2.1.55",
-    "lodash": "npm:@candriajs/[email protected].5",
-    "simple-git": "^3.27.0",
+    "lodash": "npm:@candriajs/[email protected].7",
+    "simple-git": "npm:@candriajs/simple-git@^1.0.2",
     "socks-proxy-agent": "^8.0.5",
     "uuid": "^11.1.0"
   },

src/common/git.ts

@@ -1,3 +1,4 @@
+import fs from 'node:fs'
 import path from 'node:path'
 
 import { simpleGit } from 'simple-git'
@@ -13,6 +14,11 @@ import {
   exists,
   parse_git_url
 } from '@/common/utils'
+import type {
+  LocalGitInfoListOptionsType,
+  LocalGitInfoListType,
+  LocalGitInfoType
+} from '@/types'
 
 /**
  * 获取 Git 版本
@@ -44,6 +50,137 @@ async function is_installed_git (): Promise<boolean> {
   return !!await get_git_version()
 }
 
+/**
+ * 获取本地 Git 仓库信息
+ * @description 获取本地 Git 仓库信息，返回仓库名称、仓库路径、仓库地址等信息
+ * @param local_path - 本地仓库路径
+ * @returns Git 仓库信息
+ * @example
+ * ```ts
+ * const info = await get_local_git_repo_info('D:/project/repo')
+ * console.log(info)
+ * -> {
+ *   name: 'repo',
+ *   path: 'D:/project/repo',
+ *   url: 'https://github.com/owner/repo.git',
+ *   html_url: 'https://github.com/owner/repo',
+ *   owner: 'owner',
+ *   repo: 'repo'
+ * }
+ * ```
+ */
+export async function get_local_git_repo_info (
+  local_path: string
+): Promise<LocalGitInfoType | null> {
+  try {
+    if (!local_path) throw new Error(MissingLocalRepoPathMsg)
+    if (!await exists(path.join(local_path)) || !await exists(path.join(local_path, '.git'))) return null
+    const git = simpleGit(local_path)
+    const remotes = await git.getRemotes(true)
+    if (remotes.length > 0) {
+      const remoteUrl = remotes[0].refs.push
+      const { owner, repo, html_url } = parse_git_url(remoteUrl)
+      return {
+        name: path.basename(local_path),
+        path: path.join(local_path),
+        url: remoteUrl,
+        html_url,
+        owner,
+        repo
+      }
+    }
+    return null
+  } catch (error) {
+    throw new Error(`获取本地仓库信息失败: ${error}`)
+  }
+}
+
+/**
+ * 获取本地仓库信息列表
+ * @param local_path 本地仓库路径
+ * @param options 配置项
+ * - loop 是否递归查找
+ * - maxDepth 递归最大深度
+ * - dir 忽略的文件夹名称列表
+ * @returns
+ * @example
+ * ```ts
+ * // 无数据
+ * const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
+ * -> []
+ * // 有数据
+ * const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
+ * -> [
+ * {
+ * "name": "GitHub",
+ * "path": "D:\\project\\GitHub\\GitHub",
+ * "url": "https://github.com/GitHub/GitHub.git",
+ * "html_url": "https://github.com/GitHub/GitHub",
+ * "owner": "GitHub",
+ * "repo": "GitHub"
+ * }
+ * ]
+ */
+export async function get_local_git_repo_list (
+  local_path: string,
+  options: LocalGitInfoListOptionsType
+  = {
+    loop: false,
+    maxDepth: 5,
+    dir: []
+  }
+): Promise<LocalGitInfoListType> {
+  const { loop = false, maxDepth = 5, dir = [] } = options
+
+  const searchRepo = async (
+    dirPath: string,
+    currentDepth: number = 0
+  ): Promise<LocalGitInfoListType> => {
+    try {
+      if (!await exists(dirPath)) return []
+      const stat = await fs.promises.stat(dirPath)
+      if (!stat.isDirectory()) return []
+
+      const result: LocalGitInfoListType = []
+      const currentRepoInfo = await get_local_git_repo_info(dirPath)
+
+      if (currentRepoInfo) {
+        result.push(currentRepoInfo)
+      }
+      if (loop && currentDepth < maxDepth) {
+        const dirItems = await fs.promises.readdir(dirPath, { withFileTypes: true })
+
+        const subResults = await Promise.all(
+          dirItems
+            .filter(item =>
+              item.isDirectory() &&
+              !dir.includes(item.name)
+            )
+            .map(async item => {
+              const subPath = path.join(dirPath, item.name)
+              return await searchRepo(subPath, currentDepth + 1)
+            })
+        )
+
+        result.push(...subResults.flat())
+      }
+
+      return result
+    } catch (error) {
+      return []
+    }
+  }
+
+  try {
+    if (!local_path) throw new Error(MissingLocalRepoPathMsg)
+    if (!await is_installed_git()) throw new Error(GitClientNotInstalledMsg)
+
+    return await searchRepo(local_path)
+  } catch (error) {
+    throw new Error(`获取本地目录git仓库列表失败: ${(error as Error).message}`)
+  }
+}
+
 /**
  * 获取本地仓库的默认分支
  * @param local_path - 本地仓库路径

src/common/utils.ts

@@ -1,6 +1,6 @@
-import { exec as execCmd } from 'node:child_process'
 import fs from 'node:fs'
 
+import { exec as execCmd, type ExecOptions, type ExecReturn, execSync as execSyncCmd } from '@candriajs/exec'
 import convert, { type RGB } from 'color-convert'
 import dayjs from 'dayjs'
 import relativeTime from 'dayjs/plugin/relativeTime.js'
@@ -10,15 +10,13 @@ import LanguageColors from 'language-colors'
 import { basePath } from '@/root'
 import type {
   ContributionResult,
-  ExecOptions,
-  ExecReturn,
-  RepoBaseParamType
+  GitRepoType
 } from '@/types'
 
 const localeCache = new Set<string>(['en'])
 
 /**
- * 执行 shell 命令
+ * 异步执行 shell 命令
  * @param cmd 命令
  * @param options 选项
  * @param options.log 是否打印日志 默认不打印
@@ -35,54 +33,36 @@ const localeCache = new Set<string>(['en'])
  * // -> 打印执行命令和结果
  * ```
  */
-export function exec<T extends boolean = false> (
+export async function exec<T extends boolean = false> (
   cmd: string,
   options?: ExecOptions<T>
 ): Promise<ExecReturn<T>> {
-  const logger = console
-  return new Promise((resolve) => {
-    if (options?.log) {
-      logger.info([
-        '[exec] 执行命令:',
-        `pwd: ${options?.cwd ?? process.cwd()}`,
-        `cmd: ${cmd}`,
-        `options: ${JSON.stringify(options)}`
-      ].join('\n'))
-    }
-
-    execCmd(cmd, options, (error, stdout, stderr) => {
-      if (options?.log) {
-        const info = error as Error
-        if (info.message) info.message = `\x1b[91m${info.message}\x1b[0m`
-        logger.info([
-          '[exec] 执行结果:',
-          `stderr: ${stderr.toString()}`,
-          `stdout: ${stdout.toString()}`,
-          `error: ${JSON.stringify(info, null, 2)}`
-        ].join('\n'))
-      }
-
-      if (options?.booleanResult) {
-        return resolve((!error) as ExecReturn<T>)
-      }
-
-      stdout = stdout.toString()
-      stderr = stderr.toString()
-
-      if (options?.trim) {
-        stdout = stdout.trim()
-        stderr = stderr.trim()
-      }
+  return await execCmd(cmd, options)
+}
 
-      const value = {
-        status: !error,
-        error,
-        stdout,
-        stderr
-      } as ExecReturn<T>
-      resolve(value)
-    })
-  })
+/**
+ * 同步执行 shell 命令
+ * @param cmd 命令
+ * @param options 选项
+ * @param options.log 是否打印日志 默认不打印
+ * @param options.booleanResult 是否只返回布尔值 表示命令是否成功执行 默认返回完整的结果
+ * @example
+ * ```ts
+ * const { status, error, stdout, stderr } = execSync('ls -al')
+ * // -> { status: true, error: null, stdout: '...', stderr: '...' }
+ *
+ * const status = execSync('ls -al', { booleanResult: true })
+ * // -> true
+ *
+ * const { status, error, stdout, stderr } = execSync('ls -al', { log: true })
+ * // -> 打印执行命令和结果
+ * ```
+ */
+export function execSync<T extends boolean = false> (
+  cmd: string,
+  options?: ExecOptions<T>
+): ExecReturn<T> {
+  return execSyncCmd(cmd, options)
 }
 
 /**
@@ -202,14 +182,14 @@ export async function get_relative_time (
  * @example
  * ```ts
  * console.log(parse_git_url('https://github.com/user/repo.git'))
- * -> { owner: 'user', repo: 'repo' }
+ * -> { owner: 'user', repo: 'repo', html_url: 'https://github.com/user/repo.git' }
  * console.log(parse_git_url('https://ghproxy.com/github.com/user/repo.git'))
- * -> { owner: 'user', repo: 'repo' }
+ * -> { owner: 'user', repo: 'repo', html_url: 'https://github.com/user/repo.git' }
  * console.log(parse_git_url('https://ghproxy.com/https://github.com/user/repo.git'))
- * -> { owner: 'user', repo: 'repo' }
+ * -> { owner: 'user', repo: 'repo', html_url: 'https://github.com/user/repo.git' }
  * ```
  */
-export function parse_git_url (url: string): RepoBaseParamType {
+export function parse_git_url (url: string): GitRepoType {
   const proxyRegex = /^https?:\/\/[^/]+\/(?:https?:\/\/)?([^/]+\/[^/]+\/[^/]+)/
   const proxyMatch = url.match(proxyRegex)
 
@@ -220,6 +200,7 @@ export function parse_git_url (url: string): RepoBaseParamType {
 
   const info = GitUrlParse(url)
   return {
+    html_url: info.href,
     owner: info.owner,
     repo: info.name
   }

src/exports/lodash.ts

@@ -1,5 +1,4 @@
 import * as lodash from 'lodash'
 export { lodash as default }
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-expect-error
+// @ts-expect-error TS2498
 export * from 'lodash'

src/index.ts

@@ -1,6 +1,7 @@
 import {
   format_date,
   get_langage_color,
+  get_local_git_repo_list,
   get_local_repo_default_branch,
   get_relative_time,
   get_remote_repo_default_branch
@@ -34,6 +35,7 @@ export {
   create_state_id,
   format_date,
   get_langage_color,
+  get_local_git_repo_list,
   get_local_repo_default_branch,
   get_relative_time,
   get_remote_repo_default_branch

src/types/base/git.ts

@@ -0,0 +1,31 @@
+/** 本地Git仓库信息 */
+export interface LocalGitInfoType {
+  /** 文件夹名称 */
+  name: string
+  /** 文件夹路径 */
+  path: string
+  /**
+   * git地址，原始地址可能是反代的地址
+   *  */
+  url: string
+  /**
+   * 仓库地址, 这个是经过处理的，保证是不经过任何代理地址的地址
+   * */
+  html_url: string
+  /** 仓库名称 */
+  owner: string
+  /** 仓库名称 */
+  repo: string
+}
+
+/** 获取本地路径的Git仓库信息列表 */
+export type LocalGitInfoListType = Array<LocalGitInfoType>
+
+export interface LocalGitInfoListOptionsType {
+  /** 是否递归查找 */
+  loop?: boolean
+  /** 递归最大深度 */
+  maxDepth?: number
+  /** 忽略目录 */
+  dir?: string[]
+}

src/types/base/index.ts

@@ -1,4 +1,5 @@
 export * from '@/types/base/base'
+export * from '@/types/base/git'
 export * from '@/types/base/pkg'
 export * from '@/types/base/request'
 export * from '@/types/base/response'