Improve mechanism that adds .shopify to .gitignore to avoid duplicate entries

Author: karreiro

.changeset/curvy-kangaroos-flow.md

@@ -0,0 +1,6 @@
+---
+'@shopify/cli-kit': patch
+'@shopify/theme': patch
+---
+
+Improve mechanism that adds `.shopify` to `.gitignore` to avoid duplicate entries

packages/cli-kit/package.json

@@ -137,6 +137,7 @@
     "gradient-string": "2.0.2",
     "graphql": "16.8.1",
     "graphql-request": "5.2.0",
+    "ignore": "6.0.2",
     "ink": "4.4.1",
     "is-interactive": "2.0.0",
     "jose": "5.9.6",

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

@@ -444,4 +444,38 @@ describe('addToGitIgnore()', () => {
       expect(gitIgnoreContent).toBe('node_modules\ndist\n.shopify\n')
     })
   })
+
+  test('does nothing when .shopify/* pattern exists in .gitignore', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      const gitIgnorePath = `${tmpDir}/.gitignore`
+      const gitIgnoreContent = '.shopify/*\nnode_modules\n'
+
+      writeFileSync(gitIgnorePath, gitIgnoreContent)
+
+      // When
+      git.addToGitIgnore(tmpDir, '.shopify')
+
+      // Then
+      const actualContent = readFileSync(gitIgnorePath).toString()
+      expect(actualContent).toBe(gitIgnoreContent)
+    })
+  })
+
+  test('does nothing when .shopify/** pattern exists in .gitignore', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      const gitIgnorePath = `${tmpDir}/.gitignore`
+      const gitIgnoreContent = '.shopify/**\nnode_modules\n'
+
+      writeFileSync(gitIgnorePath, gitIgnoreContent)
+
+      // When
+      git.addToGitIgnore(tmpDir, '.shopify')
+
+      // Then
+      const actualContent = readFileSync(gitIgnorePath).toString()
+      expect(actualContent).toBe(gitIgnoreContent)
+    })
+  })
 })

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

@@ -6,6 +6,7 @@ import {cwd, joinPath} from './path.js'
 import {runWithTimer} from './metadata.js'
 import {outputContent, outputToken, outputDebug} from '../../public/node/output.js'
 import git, {TaskOptions, SimpleGitProgressEvent, DefaultLogFields, ListLogLine, SimpleGit} from 'simple-git'
+import ignore from 'ignore'
 
 /**
  * Initialize a git repository at the given directory.
@@ -83,8 +84,14 @@ export function addToGitIgnore(root: string, entry: string): void {
   const gitIgnoreContent = readFileSync(gitIgnorePath).toString()
   const eol = detectEOL(gitIgnoreContent)
 
-  if (gitIgnoreContent.split(eol).some((line) => line.trim() === entry.trim())) {
-    // The file already existing in the .gitignore
+  const lines = gitIgnoreContent.split(eol).map((line) => line.trim())
+  const ignoreManager = ignore.default({allowRelativePaths: true}).add(lines)
+
+  const isIgnoredEntry = ignoreManager.ignores(joinPath(entry))
+  const isIgnoredEntryAsDir = ignoreManager.ignores(joinPath(entry, 'ignored.txt'))
+  const isAlreadyIgnored = isIgnoredEntry || isIgnoredEntryAsDir
+  if (isAlreadyIgnored) {
+    // The file is already ignored by an existing pattern
     return
   }