Merge pull request #4572 from Shopify/add_shopifyignore_support

Allow ignoring liquid files using .cli-liquid-bypass
Shopify · Oct 17, 2024 · b9036b2 · b9036b2
2 parents b5a2378 + 09ca514
commit b9036b2
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 2 deletions.
diff --git a/packages/app/src/cli/services/init/template/cleanup.test.ts b/packages/app/src/cli/services/init/template/cleanup.test.ts
@@ -9,6 +9,7 @@ describe('cleanup', () => {
     await Promise.all([
       // should keep these
       writeFile(joinPath(tmpDir, 'server.js'), 'console.log()'),
+      writeFile(joinPath(tmpDir, 'cli-liquid-bypass'), '*'),
       mkdir(joinPath(tmpDir, 'node_modules')),
 
       // should delete these
@@ -40,6 +41,7 @@ describe('cleanup', () => {
       await expect(fileExists(joinPath(tmpDir, '.git'))).resolves.toBe(false)
       await expect(fileExists(joinPath(tmpDir, '.github'))).resolves.toBe(false)
       await expect(fileExists(joinPath(tmpDir, '.gitmodules'))).resolves.toBe(false)
+      await expect(fileExists(joinPath(tmpDir, '.cli-liquid-bypass'))).resolves.toBe(false)
       await expect(fileExists(joinPath(tmpDir, 'frontend', '.git'))).resolves.toBe(false)
       await expect(fileExists(joinPath(tmpDir, 'package.json.cli2'))).resolves.toBe(false)
     })

diff --git a/packages/app/src/cli/services/init/template/cleanup.ts b/packages/app/src/cli/services/init/template/cleanup.ts
@@ -7,6 +7,7 @@ export default async function cleanup(webOutputDirectory: string) {
       joinPath(webOutputDirectory, '**', '.git'),
       joinPath(webOutputDirectory, '**', '.github'),
       joinPath(webOutputDirectory, '**', '.gitmodules'),
+      joinPath(webOutputDirectory, '**', '.cli-liquid-bypass'),
       joinPath(webOutputDirectory, 'LICENSE*'),
       joinPath(webOutputDirectory, '**', 'frontend/LICENSE*'),
       joinPath(webOutputDirectory, 'package.json.cli2'),

diff --git a/packages/cli-kit/src/public/node/liquid.test.ts b/packages/cli-kit/src/public/node/liquid.test.ts
@@ -51,4 +51,40 @@ describe('recursiveLiquidTemplateCopy', () => {
       expect(JSON.parse(outPackageJson)).toEqual(packageJson)
     })
   })
+
+  test('ignores files and folders in .cli-liquid-bypass', async () => {
+    const bypassPatterns = ['ignored.liquid', 'ignored-folder']
+
+    // Given
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      const from = joinPath(tmpDir, 'from')
+      const ignoredFolder = joinPath(from, 'ignored-folder')
+      const to = joinPath(tmpDir, 'to')
+      await mkdir(from)
+      await mkdir(ignoredFolder)
+      await mkdir(to)
+
+      const bypassFile = joinPath(from, '.cli-liquid-bypass')
+      const ignoredFile = joinPath(from, 'ignored.liquid')
+      const folderIgnoredFile = joinPath(ignoredFolder, 'ignored2.liquid')
+      const processedFile = joinPath(from, 'processed.md.liquid')
+      await writeFile(bypassFile, bypassPatterns.join('\n'))
+      await writeFile(ignoredFile, '# {{variable}}')
+      await writeFile(folderIgnoredFile, '# {{variable}}')
+      await writeFile(processedFile, '# {{variable}}')
+
+      // When
+      await recursiveLiquidTemplateCopy(from, to, {variable: 'test'})
+
+      // Then
+      const outFile = joinPath(to, 'ignored.liquid')
+      const outFolderFile = joinPath(to, 'ignored-folder/ignored2.liquid')
+      const outProcessedFile = joinPath(to, 'processed.md')
+
+      await expect(readFile(outFile)).resolves.toEqual('# {{variable}}')
+      await expect(readFile(outFolderFile)).resolves.toEqual('# {{variable}}')
+      await expect(readFile(outProcessedFile)).resolves.toEqual('# test')
+    })
+  })
 })
diff --git a/packages/cli-kit/src/public/node/liquid.ts b/packages/cli-kit/src/public/node/liquid.ts
@@ -1,4 +1,15 @@
-import {mkdir, readFile, copyFile, chmod, isDirectory, writeFile, fileHasExecutablePermissions, glob} from './fs.js'
+import {
+  mkdir,
+  readFile,
+  copyFile,
+  chmod,
+  isDirectory,
+  writeFile,
+  fileHasExecutablePermissions,
+  glob,
+  fileExists,
+  matchGlob,
+} from './fs.js'
 import {joinPath, dirname, relativePath} from './path.js'
 import {outputContent, outputToken, outputDebug} from '../../public/node/output.js'
 import {Liquid} from 'liquidjs'
@@ -29,16 +40,29 @@ export async function recursiveLiquidTemplateCopy(from: string, to: string, data
   outputDebug(outputContent`Copying template from directory ${outputToken.path(from)} to ${outputToken.path(to)}`)
   const templateFiles: string[] = await glob(joinPath(from, '**/*'), {dot: true})
 
+  const bypassPaths = joinPath(from, '.cli-liquid-bypass')
+  let bypassPatterns: string[] = []
+  if (await fileExists(bypassPaths)) {
+    bypassPatterns = (await readFile(bypassPaths)).split('\n').filter((line) => line.trim().length > 0)
+  }
+
   const sortedTemplateFiles = templateFiles
     .map((path) => path.split('/'))
     .sort((lhs, rhs) => (lhs.length < rhs.length ? 1 : -1))
     .map((components) => components.join('/'))
   await Promise.all(
     sortedTemplateFiles.map(async (templateItemPath) => {
       const outputPath = await renderLiquidTemplate(joinPath(to, relativePath(from, templateItemPath)), data)
+      const bypass = bypassPatterns.some((pattern) => {
+        const path = relativePath(from, templateItemPath)
+        const cleanPattern = pattern.replace(/^\.\//, '')
+
+        return matchGlob(path, cleanPattern) || path.startsWith(cleanPattern)
+      })
+
       if (await isDirectory(templateItemPath)) {
         await mkdir(outputPath)
-      } else if (templateItemPath.endsWith('.liquid')) {
+      } else if (templateItemPath.endsWith('.liquid') && !bypass) {
         await mkdir(dirname(outputPath))
         const content = await readFile(templateItemPath)
         const contentOutput = await renderLiquidTemplate(content, data)