Check for duplicate files and throw an error

Author: t-kelly

src/commands/theme/component/copy.ts

@@ -13,7 +13,7 @@ import BaseCommand from '../../../utilities/base-command.js'
 import { copyFileIfChanged } from '../../../utilities/files.js';
 import Flags from '../../../utilities/flags.js'
 import { getManifest } from '../../../utilities/manifest.js'
-import { getCollectionNodes } from '../../../utilities/nodes.js'
+import { getCollectionNodes, getDuplicateFiles } from '../../../utilities/nodes.js'
 import { getNameFromPackageJson, getVersionFromPackageJson } from '../../../utilities/package-json.js'
 import { isComponentRepo, isThemeRepo } from '../../../utilities/validate.js'
 
@@ -54,6 +54,21 @@ export default class Copy extends BaseCommand {
 
     const manifest = getManifest(path.join(destinationDir, 'component.manifest.json'))
     const sourceNodes = await getCollectionNodes(currentDir)
+    const manifest = getManifest(path.join(themeDir, 'component.manifest.json'))
+    const componentNodes = await getCollectionNodes(currentDir)
+
+    const duplicates = getDuplicateFiles(componentNodes);
+
+    if (duplicates.size > 0) {
+      const message: string[] = []
+      duplicates.forEach((nodes, key) => {
+        message.push(`Warning: Found duplicate files for ${key}:`)
+        nodes.forEach(node => {
+          message.push(`  - ${node.file}`)
+        })
+      });
+      this.error(message.join('\n'))
+    }
 
     if (manifest.collections[sourceName].version !== sourceVersion) {
       this.error(`Version mismatch: Expected ${sourceVersion} but found ${manifest.collections[sourceName].version}. Run "shopify theme component map" to update the component.manifest.json file.`);

src/commands/theme/component/manifest.ts

@@ -13,7 +13,7 @@ import BaseCommand from '../../../utilities/base-command.js'
 import Flags from '../../../utilities/flags.js'
 import { getLastCommitHash } from '../../../utilities/git.js'
 import { ManifestOptions, generateManifestFile, getManifest } from '../../../utilities/manifest.js'
-import { getCollectionNodes, getThemeNodes } from '../../../utilities/nodes.js'
+import { getCollectionNodes, getDuplicateFiles, getThemeNodes } from '../../../utilities/nodes.js'
 import { sortObjectKeys } from '../../../utilities/objects.js'
 import { getNameFromPackageJson, getVersionFromPackageJson } from '../../../utilities/package-json.js'
 import { LiquidNode } from '../../../utilities/types.js'
@@ -69,6 +69,19 @@ export default class Manifest extends BaseCommand {
 
     const sourceNodes = await getCollectionNodes(sourceDir)
 
+    const duplicates = getDuplicateFiles(sourceNodes);
+
+    if (duplicates.size > 0) {
+      const message: string[] = []
+      duplicates.forEach((nodes, key) => {
+        message.push(`Warning: Found duplicate files for ${key}:`)
+        nodes.forEach(node => {
+          message.push(`  - ${node.file}`)
+        })
+      });
+      this.error(message.join('\n'))
+    }
+
     let destinationNodes: LiquidNode[]
     let destinationName: string
 

src/utilities/nodes.ts

@@ -116,6 +116,26 @@ export async function getCollectionNodes(collectionDir: string): Promise<LiquidN
   return Promise.all([...collectionSnippets, ...collectionComponents, ...collectionAssets, ...collectionScripts, ...collectionSetup])
 }
 
+export function getDuplicateFiles(nodes: LiquidNode[]): Map<string, LiquidNode[]> {
+  const duplicateMap = new Map<string, LiquidNode[]>();
+  
+  nodes.forEach(node => {
+    if (node.themeFolder !== 'snippets' && node.themeFolder !== 'assets') return;
+    const key = `${node.themeFolder}/${node.name}`;
+    if (!duplicateMap.has(key)) {
+      duplicateMap.set(key, [node]);
+    } else {
+      duplicateMap.get(key)!.push(node);
+    }
+  });
+
+  // Filter to only return entries with duplicates
+  return new Map(
+    Array.from(duplicateMap.entries())
+      .filter(([_, nodes]) => nodes.length > 1)
+  );
+}
+
 export async function getThemeNodes(themeDir: string): Promise<LiquidNode[]> {
   const entryNodes = globSync(path.join(themeDir, '{layout,sections,blocks,templates}', '*.liquid'), { absolute: true })
     .map(file => { 

test/commands/theme/component/manifest.test.ts

@@ -357,4 +357,15 @@ describe('theme component manifest', () => {
     const data = JSON.parse(fs.readFileSync(path.join(testThemePath, 'component.manifest.json'), 'utf8'))
     expect(data.collections['@archetype-themes/test-collection'].commit).to.equal(expectedHash)
   })
+
+  it('should throw an error if there are duplicate files in the source collection', async () => {
+    const src = path.join(testCollectionPath, 'components', 'duplicate', 'duplicate.liquid')
+    const dest = path.join(testCollectionPath, 'components', 'duplicate', 'snippets', 'duplicate.liquid')
+    
+    fs.cpSync(src, dest, {recursive: true})
+
+    const {error} = await runCommand(['theme', 'component', 'manifest', testThemePath])
+    expect(error).to.be.instanceOf(Error)
+    expect(error?.message).to.include('Error: Namespace conflict in source component collection with')
+  })
 })

test/fixtures/collection/components/duplicate/duplicate.liquid

@@ -0,0 +1,22 @@
+{
+  "collections": {
+    "@archetype-themes/test-collection": {
+      "version": "1.0.0"
+    }
+  },
+  "files": {
+    "snippets": {
+      "belongs-only-to-this-collection.liquid": "@collection",
+      "uses-component-from-other-collection.liquid": "@collection",
+      "used-by-other-collection-already-installed.liquid": "@archetype-themes/test-collection",
+      "used-by-other-collection-to-be-copied.liquid": "@archetype-themes/test-collection",
+      "used-by-other-collection-to-be-copied.snippet.liquid": "@archetype-themes/test-collection"
+    },
+    "assets": {
+      "belongs-only-to-this-collection.css": "@collection",
+      "used-by-other-collection-already-installed.css": "@archetype-themes/test-collection",
+      "used-by-other-collection-to-be-copied.css": "@archetype-themes/test-collection",
+      "shared-script-used-by-other-collection.js": "@archetype-themes/test-collection"
+    }
+  }
+}

test/fixtures/test-collection-b/component.manifest.json

@@ -0,0 +1,2 @@
+{% render 'used-by-other-collection-already-installed' %}
+{% render 'used-by-other-collection-not-installed' %}