Merge pull request #27 from CaseyHaralson/git-backend

adding ability to use local git install to clone repos

package.json

@@ -11,9 +11,11 @@
   ],
   "dependencies": {
     "axios": "^1.6.3",
+    "cross-spawn": "^7.0.3",
     "tar": "^6.2.0"
   },
   "devDependencies": {
+    "@types/cross-spawn": "^6.0.6",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.10.6",
     "@types/shelljs": "^0.8.15",

src/interfaces/options.ts

@@ -41,4 +41,14 @@ export default interface GitlyOptions {
    * Set the request headers (default: undefined)
    */
   headers?: RawAxiosRequestHeaders | AxiosHeaders
+  /**
+   * Set the backend (default: undefined)
+   *
+   * @example
+   * ```markdown
+   * 'axios' - default behavior
+   * 'git' - use local git installation to clone the repository (allows for cloning private repositories as long as the local git installation has access)
+   * ```
+   */
+  backend?: 'axios' | 'git'
 }

src/utils/backend.git.ts

@@ -0,0 +1,16 @@
+import GitlyOptions from '../interfaces/options'
+import parse from './parse'
+import spawn from 'cross-spawn'
+
+/**
+ * Uses local git installation to clone a repository to the destination.
+ */
+export default async function gitClone(
+  repository: string,
+  destination: string,
+  options: GitlyOptions = {}
+): Promise<[string, string]> {
+  const info = parse(repository, options)
+  spawn.sync('git', ['clone', info.href, destination])
+  return [info.href, destination]
+}

src/utils/gitly.ts

@@ -1,4 +1,5 @@
 import GitlyOptions from '../interfaces/options'
+import gitClone from './backend.git'
 
 import download from './download'
 import extract from './extract'
@@ -14,6 +15,9 @@ export default async function gitly(
   destination: string,
   options: GitlyOptions
 ): Promise<[string, string]> {
+  if (options?.backend === 'git') {
+    return await gitClone(repository, destination, options)
+  }
   const source = await download(repository, options)
   return [source, await extract(source, destination, options)]
 }