feat: share helpers to create importPath with index generator

Author: thetutlage

src/index_generator/main.ts

@@ -33,7 +33,7 @@ export class IndexGenerator {
   /**
    * The application root directory path
    */
-  #appRoot: string
+  appRoot: string
 
   /**
    * Collection of registered index generator sources
@@ -48,7 +48,7 @@ export class IndexGenerator {
    * @param cliLogger - Logger instance for CLI output
    */
   constructor(appRoot: string, cliLogger: Logger) {
-    this.#appRoot = appRoot
+    this.appRoot = appRoot
     this.#cliLogger = cliLogger
   }
 
@@ -60,7 +60,7 @@ export class IndexGenerator {
    * @returns This IndexGenerator instance for method chaining
    */
   add(name: string, config: IndexGeneratorSourceConfig) {
-    this.#sources[name] = new IndexGeneratorSource(name, this.#appRoot, this.#cliLogger, config)
+    this.#sources[name] = new IndexGeneratorSource(name, this.appRoot, this.#cliLogger, config)
     return this
   }
 

src/index_generator/source.ts

@@ -84,7 +84,13 @@ export class IndexGeneratorSource {
     if (this.#config.as === 'barrelFile') {
       this.#asBarrelFile(this.#vfs, buffer, this.#config.exportName)
     } else {
-      this.#config.as(this.#vfs, buffer, this.#config)
+      this.#config.as(this.#vfs, buffer, this.#config, {
+        toImportPath: this.#createBarrelFileImportGenerator(
+          this.#source,
+          this.#outputDirname,
+          this.#config
+        ),
+      })
     }
 
     await mkdir(dirname(this.#output), { recursive: true })
@@ -180,10 +186,10 @@ export class IndexGeneratorSource {
     return function (filePath: string) {
       if (config.importAlias) {
         debug('converting "%s" to import alias, source "%s"', filePath, source)
-        return `() => import('${removeExtension(filePath.replace(source, config.importAlias))}')`
+        return removeExtension(filePath.replace(source, config.importAlias))
       }
       debug('converting "%s" to relative import, source "%s"', filePath, outputDirname)
-      return `() => import('${relative(outputDirname, filePath)}')`
+      return relative(outputDirname, filePath)
     }
   }
 
@@ -207,7 +213,9 @@ export class IndexGeneratorSource {
 
     const tree = vfs.asTree({
       transformKey: keyGenerator,
-      transformValue: importGenerator,
+      transformValue: (filePath) => {
+        return `() => import('${importGenerator(filePath)}')`
+      },
     })
 
     buffer.write(`export const ${exportName} = {`).indent()

src/types/common.ts

@@ -37,7 +37,14 @@ export type IndexGeneratorSourceConfig = (
       as: 'barrelFile'
     }
   | {
-      as: (vfs: VirtualFileSystem, buffer: FileBuffer, config: IndexGeneratorSourceConfig) => void
+      as: (
+        vfs: VirtualFileSystem,
+        buffer: FileBuffer,
+        config: IndexGeneratorSourceConfig,
+        helpers: {
+          toImportPath(filePath: string): string
+        }
+      ) => void
     }
 ) & {
   source: string

tests/index_generator.spec.ts

@@ -8,9 +8,9 @@
  */
 
 import { test } from '@japa/runner'
+import { join } from 'node:path/posix'
 import { cliui } from '@poppinss/cliui'
 import string from '@poppinss/utils/string'
-import { join, relative } from 'node:path/posix'
 import { IndexGenerator } from '../src/index_generator/main.ts'
 
 const ui = cliui({
@@ -134,10 +134,10 @@ test.group('Index generator', () => {
 
     const transformer = new IndexGenerator(source, ui.logger)
     transformer.add('inertiaPages', {
-      as(vfs, buffer) {
+      as(vfs, buffer, _, helpers) {
         const list = vfs.asList({
           transformValue(filePath) {
-            return `InferPageProps<typeof import('${relative(join(source, outputPath), filePath)}').default>`
+            return `InferPageProps<typeof import('${helpers.toImportPath(filePath)}').default>`
           },
         })
 
@@ -157,10 +157,10 @@ test.group('Index generator', () => {
     assert.snapshot(await fs.contents(outputPath)).matchInline(`
       "declare module '@adonisjs/inertia' {
         interface Pages {
-          'blog/comments/index': InferPageProps<typeof import('../../../inertia/pages/blog/comments/index.tsx').default>
-          'blog/comments/show': InferPageProps<typeof import('../../../inertia/pages/blog/comments/show.tsx').default>
-          'blog/posts/index': InferPageProps<typeof import('../../../inertia/pages/blog/posts/index.tsx').default>
-          'home': InferPageProps<typeof import('../../../inertia/pages/home.tsx').default>
+          'blog/comments/index': InferPageProps<typeof import('../../inertia/pages/blog/comments/index.tsx').default>
+          'blog/comments/show': InferPageProps<typeof import('../../inertia/pages/blog/comments/show.tsx').default>
+          'blog/posts/index': InferPageProps<typeof import('../../inertia/pages/blog/posts/index.tsx').default>
+          'home': InferPageProps<typeof import('../../inertia/pages/home.tsx').default>
         }
       }"
     `)