feat(branch): add startPoint param to specify start point for new branch

alex-titarenko · alex-titarenko · commit ee360652f563 · 2022-09-30T20:29:01.000-07:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "git-essentials",
-  "version": "0.3.28",
+  "version": "0.3.29",
   "description": "The essential GIT commands",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/api/branch.ts b/src/api/branch.ts
@@ -18,6 +18,9 @@ type BranchParams = {
   /** What to name the branch. */
   ref: string
 
+  /** What oid to use as the start point. Accepts a symbolic ref (default: `HEAD`). */
+  startPoint?: string
+
   /** Update `HEAD` to point at the newly created branch. */
   checkout?: boolean
 
@@ -42,6 +45,7 @@ export async function branch({
   dir,
   gitdir = join(dir, '.git'),
   ref,
+  startPoint = 'HEAD',
   checkout = false,
   force = false,
 }: BranchParams): Promise<void> {
@@ -54,6 +58,7 @@ export async function branch({
       gitdir,
       ref,
       checkout,
+      startPoint,
       force
     })
   } catch (err: any) {
diff --git a/src/commands/branch.ts b/src/commands/branch.ts
@@ -9,6 +9,7 @@ type BranchParams = {
   fs: FileSystem
   gitdir: string
   ref: string
+  startPoint?: string
   checkout?: boolean
   force?: boolean
 }
@@ -26,7 +27,14 @@ type BranchParams = {
  *
  */
 export async function _branch(
-  { fs, gitdir, ref, checkout = false, force = false }: BranchParams): Promise<void> {
+  {
+    fs,
+    gitdir,
+    ref,
+    startPoint = 'HEAD',
+    checkout = false,
+    force = false
+  }: BranchParams): Promise<void> {
   if (ref !== cleanGitRef.clean(ref)) {
     throw new InvalidRefNameError(ref, cleanGitRef.clean(ref))
   }
@@ -40,10 +48,10 @@ export async function _branch(
     }
   }
 
-  // Get current HEAD tree oid
+  // Get start point tree oid
   let oid: string | undefined
   try {
-    oid = await GitRefManager.resolve({ fs, gitdir, ref: 'HEAD' })
+    oid = await GitRefManager.resolve({ fs, gitdir, ref: startPoint })
   } catch (e) {
     // Probably an empty repo
   }
diff --git a/tests/branch.test.ts b/tests/branch.test.ts
@@ -4,6 +4,7 @@ import { expectNotToFailAsync, expectToFailWithTypeAsync } from './helpers/asser
 import * as path from './helpers/path'
 
 import branchFsFixtureData from './fixtures/fs/branch.json'
+import branchStartPointFsFixtureData from './fixtures/fs/branch-start-point.json'
 
 describe('branch', () => {
   it('branch', async () => {
@@ -19,7 +20,28 @@ describe('branch', () => {
     expect(await currentBranch({ fs, dir })).toBe('main')
   })
 
-  it('branch force=false', async () => {
+  it('branch with start point', async () => {
+    // arrange
+    const { fs, dir } = await makeFsFixture(branchStartPointFsFixtureData as FsFixtureData)
+    let files = await fs.readdir(path.resolve(dir, '.git', 'refs', 'heads'))
+
+    // assert
+    expect(files).toEqual(['main', 'start-point'])
+
+    // act
+    await branch({ fs, dir, ref: 'test-branch', startPoint: 'start-point' })
+
+    // assert
+    files = await fs.readdir(path.resolve(dir, '.git', 'refs', 'heads'))
+    expect(files).toEqual(['main', 'start-point', 'test-branch'])
+    expect(await currentBranch({ fs, dir })).toEqual('main')
+    expect(await fs.readFile(path.resolve(dir, '.git', 'refs', 'heads', 'test-branch'), { encoding: 'utf8' })
+    ).toEqual(await fs.readFile(path.resolve(dir, '.git', 'refs', 'heads', 'start-point'), { encoding: 'utf8' }))
+    expect(await listFiles({ fs, dir, ref: 'HEAD' })).toEqual(['new-file.txt'])
+    expect(await listFiles({ fs, dir, ref: 'test-branch' })).toEqual([])
+  })
+
+  it('branch force=undefined', async () => {
     // arrange
     const { fs, dir } = await makeFsFixture(branchFsFixtureData as FsFixtureData)
 
@@ -79,28 +101,28 @@ describe('branch', () => {
     await expectNotToFailAsync(action)
   })
 
-  // it('branch with start point force', async () => {
-  //   // arrange
-  //   const { fs, dir } = await makeFsFixture('test-branch-start-point')
+  it('branch with start point force', async () => {
+    // arrange
+    const { fs, dir } = await makeFsFixture(branchStartPointFsFixtureData as FsFixtureData)
 
-  //   // act
-  //   await branch({ fs, dir, ref: 'test-branch', startPoint: 'start-point' })
+    // act
+    await branch({ fs, dir, ref: 'test-branch', startPoint: 'start-point' })
 
-  //   // assert
-  //   expect(await currentBranch({ fs, dir })).toEqual('main')
-  //   expect(await fs.exists(path.resolve(dir, '.git', 'refs/heads/test-branch'))).toBeTruthy()
+    // assert
+    expect(await currentBranch({ fs, dir })).toEqual('main')
+    expect(await fs.exists(path.resolve(dir, '.git', 'refs/heads/test-branch'))).toBeTruthy()
 
-  //   // act
-  //   const action = async () => {
-  //     await branch({ fs, dir, ref: 'test-branch', force: true })
-  //   }
+    // act
+    const action = async () => {
+      await branch({ fs, dir, ref: 'test-branch', force: true })
+    }
 
-  //   // assert
-  //   await expectNotToFailAsync(action)
-  //   expect(await listFiles({ fs, dir, ref: 'test-branch' })).toEqual([
-  //     'new-file.txt',
-  //   ])
-  // })
+    // assert
+    await expectNotToFailAsync(action)
+    expect(await listFiles({ fs, dir, ref: 'test-branch' })).toEqual([
+      'new-file.txt',
+    ])
+  })
 
   it('branch --checkout', async () => {
     // arrange
diff --git a/tests/fixtures/fs/branch-start-point.json b/tests/fixtures/fs/branch-start-point.json
@@ -0,0 +1,146 @@
+[
+  {
+    "name": ".git",
+    "type": "dir",
+    "children": [
+      {
+        "name": "objects",
+        "type": "dir",
+        "children": [
+          {
+            "name": "12",
+            "type": "dir",
+            "children": [
+              {
+                "name": "f00e90b6ef79117ce6e650416b8cf517099b78",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAFLyslPUrBkSM7PK0nNKynmAgAuLQVx"
+              }
+            ]
+          },
+          {
+            "name": "13",
+            "type": "dir",
+            "children": [
+              {
+                "name": "86e77b0a7afa8333663a9e4cbf8e6158e625c1",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGdk8vOo0YUhLPmKXpvTWigaSDKRAGD8Q8GczHGsMNc2+ZmDBjz9OPMbLOasyqVVCodlb60axoyAgYy0h/jkOcAXUWWz1KM2PSK86uUQAxzHl0LMcMSK4rFNc+RBBGVTGPVDSAkdQ32pB67Fvz9aqqf6t+ySUj9Z9o1/wCGh0hkBU4UwDeIIKQ+7qdyzH8nW/blk5Tg23+naPqXDRzdAf6XbsunwNN++hQ458OTdO1fQG8nRwczQwEKEPcrVWRZkUtZV1wjfmaFKMudoRmRMZmhT3DCj6zrysZua3fMvNsZoxdfWnmJnfFsShQwNf5RrtG1C+hoSpbpbibJI6DrcXjujvW4eH7+Nax3JiqqruDD+GFkxItrizf49nGpaAr4N8FkhN6L9FsfoT3NGwFXaalnnfa66NgHnCCOSXi10YwjlF5yH4vx+a1uYfaYmrQtKLChh/W2bFVat1iewf1FmLxlqg15vU3L2Xo2ccQqDGy1ULhc9kIieH57clUUE37E93yhQHdolXn1PE6DfkT7Fo7so74Q4W7IF9xsH8/t6NZDbGCy02cGddzU7IWDLduHwNp758Pnizc8lU9ryvSzAblcDU9hIRibVpEDvDfoyj6RZvHlPYIdes08b5uVXq8MFjO6z/TdlQKnrl1suCyTMtNYoC9WdRqnrq0fpHK5wlBk1bATZ16GwVoRHWlqIXnKbuOtJBL9ABMKNHqkIHhR1xbbuieEBSfIdnV3wq4wjfGtmtaG6yMrRXgSHEayd/UbvYUe3gJ6waowUyBPSWxmqXibw3JleUsitIkCsWFOvigd/KFntY49wFU/snFyLcPLdr9atsnScs8lWbulgP2sj3bdu+pOyN9ZulmfelFKlWiRskFbppu9udJI4SS6s57fBVT8GxL95JhcjufXPH+2qF03ySGKIoyrcNuRIRVZpZyZw0mumOMwwTIWNmvyenz2CLiz0KZeuFvdPDh7I1bhjQKBjzu02XTsTYR3tpJNX0kp8F15lz71CxPNVv8PEkpr+vENfsFI/QDVEEHI"
+              }
+            ]
+          },
+          {
+            "name": "3b",
+            "type": "dir",
+            "children": [
+              {
+                "name": "24a8639f118afcb1883084e76971ff199f2607",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGVjUEKAjEMRV33FLmAkimdkIDIHEIP0HYyKlg6dCLo7S16And/8d77uZZyNxhIdtZUIST245wp+JxIk0Qk1DGkhWcSz7wk1SAYXHzarTY462Zw2bTB0fqc9BXL+tBDbddTr9IgjCwC+95Bl79v1un/PKdltTf8dPcBlp83SQ=="
+              }
+            ]
+          },
+          {
+            "name": "67",
+            "type": "dir",
+            "children": [
+              {
+                "name": "5fdb77c45298fb4248ae21f262454d15c71716",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGdjV0KQiEQRnt2FbOBREUnhYiCNjLq3LrhT1zsod1ntIMevwPnfKnXug7Qh7AbGzPY6I3LCa1JETkGUqjY2bj4jMF4v0RmG5QV9Br3vsGVGlxK4QbHTE0+JH3H+VZpLTL1egKNqINX3jnYz5gSk87LwX/JgutzvOHXEB+Fhjlu"
+              }
+            ]
+          },
+          {
+            "name": "97",
+            "type": "dir",
+            "children": [
+              {
+                "name": "e8c903c3647863f404e5f0100b3d3671621d9b",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGdjlEKwjAQBf3OKfYClmzbbBIQUfAi22RXK00qJeL1rVfwcx4Mb9Jaytyg7/2hbSKQgjgldIlsGElzUs8oyfKkPqbRhclZspjNizepDYapHznQEBUxsKYJQxh2VTxFj6oYo/ZkveF3e6wb3LjCdVmkwilz7Z4d/+ByLzwvXVrLGZAIY7DRjXDcr6zZ1z2xyV+y4Zyhygd0XsR8AcWJRgU="
+              }
+            ]
+          },
+          {
+            "name": "b0",
+            "type": "dir",
+            "children": [
+              {
+                "name": "356faa631d1e390ba42e0faba4ed99151a60e0",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGdjV0KAiEURnt2FXcDiYpzRyGGgjZy1Ts14U8M9tDuM9pBj9+Bc77YStk66Nkf+s4MNjgzpYjWxIAcPClUPNmwuoTeOLcGZuuVFfTq97bDlSpccuYKp0RVPiR9x/lWaMsytrKARtTeKTcbOI6YEoOOy85/yYLLs7/h1xAfhSE5bA=="
+              }
+            ]
+          },
+          {
+            "name": "c8",
+            "type": "dir",
+            "children": [
+              {
+                "name": "e5f615c60846fdcf7a1ec0abf79c458b50601d",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAErKUpNVTAxYDA0MDAzMVHISy3XTcvMSdUrqShhEPrAN2Hb+0rBmmfPAhyze76Kc86uAAB+FhHw"
+              }
+            ]
+          },
+          {
+            "name": "e3",
+            "type": "dir",
+            "children": [
+              {
+                "name": "e4a27a404219060f4d3688af93080a298c12bf",
+                "type": "file",
+                "encoding": "base64",
+                "content": "eAGVjksOwjAMBVnnFL4AKG4bx5EQ4hBwgCS1oVJ/SoPg+FTcgN0s3uhNXqZpqNCgP9QiApnFKaHLZLkj7bP6iJJtTOpD7hwnZ8lib9ZYZK7QpqaLTG1QRI6aEzK3uyqegkdVDEEbst7EV30uBW6yVbhvUuBcd7zKJ07rKKelPC6ARBjYBm7guL9Yk391dV//55nY9zDLG3QYxXwBUJxD0g=="
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "refs",
+        "type": "dir",
+        "children": [
+          {
+            "name": "heads",
+            "type": "dir",
+            "children": [
+              {
+                "name": "main",
+                "type": "file",
+                "encoding": "utf8",
+                "content": "e3e4a27a404219060f4d3688af93080a298c12bf\n"
+              },
+              {
+                "name": "start-point",
+                "type": "file",
+                "encoding": "utf8",
+                "content": "3b24a8639f118afcb1883084e76971ff199f2607\n"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "HEAD",
+        "type": "file",
+        "encoding": "utf8",
+        "content": "ref: refs/heads/main\n"
+      },
+      {
+        "name": "config",
+        "type": "file",
+        "encoding": "utf8",
+        "content": "[core]\n\trepositoryformatversion = 0\n\tfilemode = true\n\tbare = true\n\tlogallrefupdates = true\n\tsymlinks = false\n\tignorecase = true\n"
+      }
+    ]
+  }
+]

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "git-essentials",`
`3`		`- "version": "0.3.28",`
	`3`	`+ "version": "0.3.29",`
`4`	`4`	`"description": "The essential GIT commands",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"types": "dist/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ type BranchParams = {`
`9`	`9`	`fs: FileSystem`
`10`	`10`	`gitdir: string`
`11`	`11`	`ref: string`
	`12`	`+ startPoint?: string`
`12`	`13`	`checkout?: boolean`
`13`	`14`	`force?: boolean`
`14`	`15`	`}`
`@@ -26,7 +27,14 @@ type BranchParams = {`
`26`	`27`	`*`
`27`	`28`	`*/`
`28`	`29`	`export async function _branch(`
`29`		`- { fs, gitdir, ref, checkout = false, force = false }: BranchParams): Promise<void> {`
	`30`	`+ {`
	`31`	`+ fs,`
	`32`	`+ gitdir,`
	`33`	`+ ref,`
	`34`	`+ startPoint = 'HEAD',`
	`35`	`+ checkout = false,`
	`36`	`+ force = false`
	`37`	`+ }: BranchParams): Promise<void> {`
`30`	`38`	`if (ref !== cleanGitRef.clean(ref)) {`
`31`	`39`	`throw new InvalidRefNameError(ref, cleanGitRef.clean(ref))`
`32`	`40`	`}`
`@@ -40,10 +48,10 @@ export async function _branch(`
`40`	`48`	`}`
`41`	`49`	`}`
`42`	`50`
`43`		`- // Get current HEAD tree oid`
	`51`	`+ // Get start point tree oid`
`44`	`52`	`let oid: string \| undefined`
`45`	`53`	`try {`
`46`		`- oid = await GitRefManager.resolve({ fs, gitdir, ref: 'HEAD' })`
	`54`	`+ oid = await GitRefManager.resolve({ fs, gitdir, ref: startPoint })`
`47`	`55`	`} catch (e) {`
`48`	`56`	`// Probably an empty repo`
`49`	`57`	`}`