feat: add support for registering nested index.edge file with the parent folder name

Author: thetutlage

async-fixtures/index-path/components/modal/index.edge

@@ -0,0 +1 @@
+{{ title }}

async-fixtures/index-path/index.edge

@@ -0,0 +1,2 @@
+@modal(title = 'Hello world')
+@endmodal

async-fixtures/index-path/index.json

@@ -0,0 +1 @@
+{}

async-fixtures/index-path/index.txt

@@ -0,0 +1 @@
+Hello world

fixtures/index-path/components/modal/index.edge

@@ -0,0 +1 @@
+{{ title }}

fixtures/index-path/index.edge

@@ -0,0 +1,2 @@
+@modal(title = 'Hello world')
+@endmodal

fixtures/index-path/index.json

@@ -0,0 +1 @@
+{}

fixtures/index-path/index.txt

@@ -0,0 +1 @@
+Hello world

src/Supercharged/index.ts

@@ -118,17 +118,39 @@ export class Supercharged {
         .map((segment) => string.camelCase(segment)) // Convert each segment to camelCase
         .join('.') // Join by .
 
+      /**
+       * Add prefix to name when defined
+       */
+      const prefixedName = options.prefix ? `${options.prefix}.${name}` : name
+
+      /**
+       * Do not normalize the path here. Edge wants unix style paths
+       */
+      const componentPath = `${options.diskName ? `${options.diskName}::` : ''}components/${file}`
+
       /**
        * Register the component
        */
-      this.registerComponent(
-        options.prefix ? `${options.prefix}.${name}` : name,
-
-        /**
-         * Do not normalize the path here. Edge wants unix style paths
-         */
-        `${options.diskName ? `${options.diskName}::` : ''}components/${file}`
-      )
+      this.registerComponent(prefixedName, componentPath)
+
+      /**
+       * Register components with `.index` with the parent name. Doing this can also
+       * run into race conditions as described below
+       *
+       * - There is a file called `components/modal.edge`
+       * - Then there is a file called `components/modal/index.edge`
+       * - The file discovered later will win over the file discovered first.
+       *
+       * So is this a bad practice?? Not really. Coz someone creating directory structure
+       * like this themselves opting into the confusion of which component they are
+       * intending to use.
+       *
+       * Infact this race condition will force them to re-think the directory structure. Something
+       * they should
+       */
+      if (name.endsWith('.index')) {
+        this.registerComponent(prefixedName.replace(/\.index$/, ''), componentPath)
+      }
     })
 
     return this

test/supercharged.spec.ts

@@ -168,4 +168,82 @@ test.group('SuperCharged', (group) => {
       },
     })
   })
+
+  test('register nested .index files with the parent name', async (assert) => {
+    await fs.add('components/form/input.edge', '')
+    await fs.add('components/form/label.edge', '')
+    await fs.add('components/form/button.edge', '')
+    await fs.add('components/form/index.edge', '')
+
+    const charged = new Supercharged()
+    charged.discoverComponents(fs.basePath)
+
+    assert.deepEqual(charged.components, {
+      'form': {
+        path: 'components/form/index.edge',
+      },
+      'form.button': {
+        path: 'components/form/button.edge',
+      },
+      'form.index': {
+        path: 'components/form/index.edge',
+      },
+      'form.label': {
+        path: 'components/form/label.edge',
+      },
+      'form.input': {
+        path: 'components/form/input.edge',
+      },
+    })
+  })
+
+  test('register index files as index when there is no parent', async (assert) => {
+    await fs.add('components/form/input.edge', '')
+    await fs.add('components/form/label.edge', '')
+    await fs.add('components/form/button.edge', '')
+    await fs.add('components/index.edge', '')
+
+    const charged = new Supercharged()
+    charged.discoverComponents(fs.basePath)
+
+    assert.deepEqual(charged.components, {
+      'form.button': {
+        path: 'components/form/button.edge',
+      },
+      'form.label': {
+        path: 'components/form/label.edge',
+      },
+      'form.input': {
+        path: 'components/form/input.edge',
+      },
+      'index': {
+        path: 'components/index.edge',
+      },
+    })
+  })
+
+  test('register index files as index when there is no parent with a prefix', async (assert) => {
+    await fs.add('components/form/input.edge', '')
+    await fs.add('components/form/label.edge', '')
+    await fs.add('components/form/button.edge', '')
+    await fs.add('components/index.edge', '')
+
+    const charged = new Supercharged()
+    charged.discoverComponents(fs.basePath, { prefix: 'hl' })
+
+    assert.deepEqual(charged.components, {
+      'hl.form.button': {
+        path: 'components/form/button.edge',
+      },
+      'hl.form.label': {
+        path: 'components/form/label.edge',
+      },
+      'hl.form.input': {
+        path: 'components/form/input.edge',
+      },
+      'hl.index': {
+        path: 'components/index.edge',
+      },
+    })
+  })
 })