feat: get --shallow (#15)

* feat: omit helper

* feat: shallow type

* feat: expose default config

* feat: clean args

* test: args

* feat(command): add shallow option

* chore: misc

src/args.ts

@@ -1,4 +1,6 @@
 import { CAC } from 'cac'
+import { defaultConfig } from './config'
+import { omit } from './helpers/omit'
 import { OptionalConfig } from './types'
 
 export function parseCliOptionsToGitArgs(
@@ -8,9 +10,17 @@ export function parseCliOptionsToGitArgs(
 
   const args = []
 
+  if (options.shallow) {
+    args.push('--depth', 1)
+  }
+
+  // clean
+  options = omit(options, Object.keys(defaultConfig))
+
   for (const [key, value] of Object.entries(options)) {
     args.push(`${key.length !== 1 ? '-' : ''}-${key}`)
 
+    // drop `true` and `false`
     if (typeof value !== 'boolean') {
       args.push(value)
     }

src/commands/get.ts

@@ -7,9 +7,11 @@ export const get: PluginApi = {
     api.cli
       .command('get [repo]', 'Clone/sync with a remote repository')
       .alias('clone')
+      .option('--shallow', 'Shallow clone, alias to `--depth 1`')
       .example('ghq get 2nthony/ghq')
       .example('ghq get github.com/2nthony/ghq')
       .example('ghq get https://github.com/2nthony/ghq')
+      .example('ghq clone 2nthony/ghq')
       .allowUnknownOptions()
       .action((repo, options) => {
         if (!repo) {

src/config.ts

@@ -6,8 +6,9 @@ import { expandTildePath, join } from './path'
 export const ghqConfigFileName = '.ghqrc'
 export const userConfigFilePath = join(homedir(), ghqConfigFileName)
 
-const defaultConfig: Config = {
+export const defaultConfig: Config = {
   root: '~/ghq',
+  shallow: false,
 }
 
 export async function resolveConfig() {

src/helpers/omit.ts

@@ -0,0 +1,10 @@
+export function omit<T extends object, K extends keyof T>(
+  obj: T,
+  keys: K[],
+): Omit<T, K> {
+  const newObj = { ...obj }
+
+  keys.forEach((k) => delete newObj[k])
+
+  return newObj
+}

src/types.ts

@@ -16,6 +16,7 @@ export type Repo = {
 
 export type Config = {
   root: string
+  shallow: boolean
 }
 
 export type OptionalConfig = Partial<Config>

test/args.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, test } from 'vitest'
+import { parseCliOptionsToGitArgs } from '../src/args'
+import { defaultConfig } from '../src/config'
+
+describe('parse cli options to args', () => {
+  test('empty', () => {
+    const args = parseCliOptionsToGitArgs(defaultConfig)
+    expect(args).toEqual([])
+  })
+
+  test('shallow', () => {
+    const args = parseCliOptionsToGitArgs({ ...defaultConfig, shallow: true })
+    expect(args).toEqual(['--depth', 1])
+  })
+})