Merge pull request #5963 from Shopify/remove-remote-repo-theme-init

Remove git remote on theme init

Author: EvilGenius13

.changeset/remove-git-remote-theme-init.md

@@ -0,0 +1,6 @@
+---
+"@shopify/theme": patch
+"@shopify/cli-kit": patch
+---
+
+Remove git remote after cloning theme in `theme init` command to prevent accidental pushes to the skeleton theme repository

packages/cli-kit/src/public/node/git.test.ts

@@ -13,6 +13,8 @@ const mockedCommit = vi.fn(async () => ({}))
 const mockedRaw = vi.fn(async () => '')
 const mockedCheckout = vi.fn(async () => ({}))
 const mockedGitStatus = vi.fn(async (): Promise<{isClean: () => boolean}> => ({isClean: () => false}))
+const mockedRemoveRemote = vi.fn(async () => {})
+const mockedGetRemotes = vi.fn(async () => [] as {name: string; refs: any}[])
 const mockedTags = vi.fn(async () => ({}))
 const simpleGitProperties = {
   clone: mockedClone,
@@ -25,6 +27,8 @@ const simpleGitProperties = {
   checkoutLocalBranch: mockedCheckout,
   status: mockedGitStatus,
   tags: mockedTags,
+  removeRemote: mockedRemoveRemote,
+  getRemotes: mockedGetRemotes,
 }
 
 vi.mock('simple-git')
@@ -506,3 +510,44 @@ describe('addToGitIgnore()', () => {
     })
   })
 })
+
+describe('removeGitRemote()', () => {
+  beforeEach(() => {
+    mockedGetRemotes.mockReset()
+    mockedRemoveRemote.mockReset()
+  })
+
+  test('calls simple-git to remove a remote successfully', async () => {
+    // Given
+    const directory = '/test/directory'
+    const remoteName = 'origin'
+    mockedGetRemotes.mockResolvedValue([{name: 'origin', refs: {}}])
+    mockedRemoveRemote.mockResolvedValue(undefined)
+
+    // When
+    await git.removeGitRemote(directory, remoteName)
+
+    // Then
+    expect(simpleGit).toHaveBeenCalledWith(directory)
+    expect(mockedGetRemotes).toHaveBeenCalled()
+    expect(mockedRemoveRemote).toHaveBeenCalledWith(remoteName)
+  })
+
+  test('does nothing when remote does not exist', async () => {
+    // Given
+    const directory = '/test/directory'
+    const remoteName = 'nonexistent'
+    mockedGetRemotes.mockResolvedValue([
+      {name: 'origin', refs: {}},
+      {name: 'upstream', refs: {}},
+    ])
+
+    // When
+    await git.removeGitRemote(directory, remoteName)
+
+    // Then
+    expect(simpleGit).toHaveBeenCalledWith(directory)
+    expect(mockedGetRemotes).toHaveBeenCalled()
+    expect(mockedRemoveRemote).not.toHaveBeenCalled()
+  })
+})

packages/cli-kit/src/public/node/git.ts

@@ -361,3 +361,30 @@ export async function getLatestTag(directory?: string): Promise<string | undefin
   const tags = await git({baseDir: directory}).tags()
   return tags.latest
 }
+
+/**
+ * Remove a git remote from the given directory.
+ *
+ * @param directory - The directory where the git repository is located.
+ * @param remoteName - The name of the remote to remove (defaults to 'origin').
+ * @returns A promise that resolves when the remote is removed.
+ */
+export async function removeGitRemote(directory: string, remoteName = 'origin'): Promise<void> {
+  outputDebug(outputContent`Removing git remote ${remoteName} from ${outputToken.path(directory)}...`)
+  await ensureGitIsPresentOrAbort()
+
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const repo = git(directory)
+
+  // Check if remote exists first
+  const remotes = await repo.getRemotes()
+  const remoteExists = remotes.some((remote: {name: string}) => remote.name === remoteName)
+
+  if (!remoteExists) {
+    outputDebug(outputContent`Remote ${remoteName} does not exist, no action needed`)
+    return
+  }
+
+  await repo.removeRemote(remoteName)
+}

packages/theme/src/cli/services/init.test.ts

@@ -24,12 +24,13 @@ describe('cloneRepoAndCheckoutLatestTag()', async () => {
     const repoUrl = 'https://github.com/Shopify/dawn.git'
     const destination = 'destination'
     const latestTag = true
+    const shallow = true
 
     // When
     await cloneRepoAndCheckoutLatestTag(repoUrl, destination)
 
     // Then
-    expect(downloadGitRepository).toHaveBeenCalledWith({repoUrl, destination, latestTag})
+    expect(downloadGitRepository).toHaveBeenCalledWith({repoUrl, destination, latestTag, shallow})
   })
 })
 
@@ -38,12 +39,12 @@ describe('cloneRepo()', async () => {
     // Given
     const repoUrl = 'https://github.com/Shopify/dawn.git'
     const destination = 'destination'
-
+    const shallow = true
     // When
     await cloneRepo(repoUrl, destination)
 
     // Then
-    expect(downloadGitRepository).toHaveBeenCalledWith({repoUrl, destination})
+    expect(downloadGitRepository).toHaveBeenCalledWith({repoUrl, destination, shallow})
   })
 })
 

packages/theme/src/cli/services/init.ts

@@ -1,5 +1,5 @@
 import {renderSelectPrompt, renderTasks} from '@shopify/cli-kit/node/ui'
-import {downloadGitRepository} from '@shopify/cli-kit/node/git'
+import {downloadGitRepository, removeGitRemote} from '@shopify/cli-kit/node/git'
 import {joinPath} from '@shopify/cli-kit/node/path'
 import {mkdir, writeFile} from '@shopify/cli-kit/node/fs'
 import {fetch} from '@shopify/cli-kit/node/http'
@@ -21,7 +21,9 @@ async function downloadRepository(repoUrl: string, destination: string, latestTa
           repoUrl,
           destination,
           latestTag,
+          shallow: true,
         })
+        await removeGitRemote(destination)
       },
     },
   ])