feat: add support for creating barrel files without lazy imports

Author: thetutlage

src/index_generator/source.ts

@@ -82,7 +82,12 @@ export class IndexGeneratorSource {
     const buffer = new FileBuffer()
 
     if (this.#config.as === 'barrelFile') {
-      this.#asBarrelFile(this.#vfs, buffer, this.#config.exportName)
+      this.#asBarrelFile(
+        this.#vfs,
+        buffer,
+        this.#config.exportName,
+        this.#config.disableLazyImports
+      )
     } else {
       this.#config.as(this.#vfs, buffer, this.#config, {
         toImportPath: this.#createBarrelFileImportGenerator(
@@ -206,8 +211,15 @@ export class IndexGeneratorSource {
    * @param buffer - File buffer to write the barrel exports to
    * @param exportName - Name for the main export object
    */
-  #asBarrelFile(vfs: VirtualFileSystem, buffer: FileBuffer, exportName: string) {
+  #asBarrelFile(
+    vfs: VirtualFileSystem,
+    buffer: FileBuffer,
+    exportName: string,
+    disableLazyImports?: boolean
+  ) {
+    const useEagerImports = disableLazyImports === true ? true : false
     const keyGenerator = this.#createBarrelFileKeyGenerator(this.#config)
+    const importsBuffer = buffer.create()
     const importGenerator = this.#createBarrelFileImportGenerator(
       this.#source,
       this.#outputDirname,
@@ -216,11 +228,19 @@ export class IndexGeneratorSource {
 
     const tree = vfs.asTree({
       transformKey: keyGenerator,
-      transformValue: (filePath) => {
+      transformValue: (filePath, key) => {
+        if (useEagerImports) {
+          const importKey = new StringBuilder(key).pascalCase().toString()
+          importsBuffer.write(`import ${importKey} from '${importGenerator(filePath)}'`)
+          return importKey
+        }
         return `() => import('${importGenerator(filePath)}')`
       },
     })
 
+    if (useEagerImports) {
+      buffer.writeLine(importsBuffer)
+    }
     buffer.write(`export const ${exportName} = {`).indent()
     this.#treeToString(tree, buffer)
     buffer.dedent().write(`}`)

src/types/common.ts

@@ -36,6 +36,11 @@ export type IndexGeneratorSourceConfig = (
   | {
       exportName: string
       as: 'barrelFile'
+      /**
+       * Disable the use of lazy imports and instead import the
+       * files using the import expression
+       */
+      disableLazyImports?: boolean
     }
   | {
       as: (

src/virtual_file_system.ts

@@ -176,14 +176,15 @@ export class VirtualFileSystem {
    */
   asTree(options?: {
     transformKey?: (key: string) => string
-    transformValue?: (filePath: string) => string
+    transformValue?: (filePath: string, key: string) => string
   }) {
     const list: RecursiveFileTree = {}
     const transformKey = options?.transformKey ?? BYPASS_FN
     const transformValue = options?.transformValue ?? BYPASS_FN
 
     for (const [filePath, relativePath] of this.#files) {
-      lodash.set(list, transformKey(relativePath).split('/'), transformValue(filePath))
+      const key = transformKey(relativePath)
+      lodash.set(list, key.split('/'), transformValue(filePath, key))
     }
 
     return list

tests/index_generator.spec.ts

@@ -257,4 +257,45 @@ test.group('Index generator', () => {
       }"
     `)
   })
+
+  test('create index from without lazy imports', async ({ assert, fs }) => {
+    const outputPath = '.adonisjs/backend/controllers.ts'
+    const source = string.toUnixSlash(fs.basePath)
+
+    await fs.create('app/controllers/posts_controller.ts', '')
+    await fs.create('app/controllers/user/posts_controller.ts', '')
+    await fs.create('app/controllers/auth/signup_controller.ts', '')
+    await fs.create('app/controllers/public/home_page.ts', '')
+
+    const transformer = new IndexGenerator(source, ui.logger)
+    transformer.add('controllers', {
+      as: 'barrelFile',
+      disableLazyImports: true,
+      exportName: 'controllers',
+      output: outputPath,
+      source: 'app/controllers',
+      importAlias: '#controllers',
+    })
+    await transformer.generate()
+
+    assert.snapshot(await fs.contents(outputPath)).matchInline(`
+      "import AuthSignupController from '#controllers/auth/signup_controller'
+      import PostsController from '#controllers/posts_controller'
+      import PublicHomePage from '#controllers/public/home_page'
+      import UserPostsController from '#controllers/user/posts_controller'
+
+      export const controllers = {
+        auth: {
+          SignupController: AuthSignupController,
+        },
+        PostsController: PostsController,
+        public: {
+          HomePage: PublicHomePage,
+        },
+        user: {
+          PostsController: UserPostsController,
+        },
+      }"
+    `)
+  })
 })