feat: integrate index generator with bundler

Author: thetutlage

src/bundler.ts

@@ -19,8 +19,9 @@ import { detectPackageManager } from '@antfu/install-pkg'
 
 import type { BundlerOptions } from './types/common.ts'
 import { run, parseConfig, copyFiles, loadHooks } from './utils.ts'
-import { type HookParams, type BundlerHooks } from './types/hooks.ts'
+import { type HookParams, type BundlerHooks, type CommonHooks } from './types/hooks.ts'
 import { type SupportedPackageManager } from './types/code_transformer.ts'
+import { IndexGenerator } from './index_generator/main.ts'
 
 /**
  * List of package managers we support in order to
@@ -70,9 +71,18 @@ export class Bundler {
   /**
    * Hooks to execute custom actions during the build process
    */
-  #hooks!: Hooks<{
-    [K in keyof BundlerHooks]: [HookParams<K>, HookParams<K>]
-  }>
+  #hooks!: Hooks<
+    {
+      [K in keyof CommonHooks]: [HookParams<K>, HookParams<K>]
+    } & {
+      [K in keyof BundlerHooks]: [HookParams<K>, HookParams<K>]
+    }
+  >
+
+  /**
+   * Index generator for managing auto-generated index files
+   */
+  #indexGenerator!: IndexGenerator
 
   /**
    * CLI UI instance for displaying colorful messages and progress information
@@ -202,7 +212,6 @@ export class Bundler {
    * const success = await bundler.bundle(true, 'npm')
    */
   async bundle(stopOnError: boolean = true, client?: SupportedPackageManager): Promise<boolean> {
-    this.#hooks = await loadHooks(this.options.hooks, ['buildStarting', 'buildFinished'])
     this.packageManager = client ?? (await this.#detectPackageManager()) ?? 'npm'
 
     /**
@@ -213,20 +222,33 @@ export class Bundler {
       return false
     }
 
+    this.ui.logger.info('loading hooks...')
+    this.#hooks = await loadHooks(this.options.hooks, ['init', 'buildStarting', 'buildFinished'])
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
+
+    /**
+     * Step 2: Run init hook and the index generator
+     */
+    await this.#hooks.runner('init').run(this, this.#indexGenerator)
+    this.#hooks.clear('init')
+
+    this.ui.logger.info('generating indexes...')
+    await this.#indexGenerator.generate()
+
     /**
-     * Step 2: Cleanup existing build directory (if any)
+     * Step 3: Cleanup existing build directory (if any)
      */
     const outDir = config.options.outDir || fileURLToPath(new URL('build/', this.cwd))
     this.ui.logger.info('cleaning up output directory', { suffix: this.#getRelativeName(outDir) })
     await this.#cleanupBuildDirectory(outDir)
 
     /**
-     * Step 3: Execute build starting hook
+     * Step 4: Execute build starting hook
      */
     await this.#hooks.runner('buildStarting').run(this)
 
     /**
-     * Step 4: Build typescript source code
+     * Step 5: Build typescript source code
      */
     this.ui.logger.info('compiling typescript source', { suffix: 'tsc' })
     const buildCompleted = await this.#runTsc(outDir)
@@ -258,7 +280,7 @@ export class Bundler {
     }
 
     /**
-     * Step 5: Copy meta files to the build directory
+     * Step 6: Copy meta files to the build directory
      */
     const pkgFiles = [
       'package.json',
@@ -275,12 +297,12 @@ export class Bundler {
       .heading('Run the following commands to start the server in production')
 
     /**
-     * Step 6: Execute build completed hook
+     * Step 7: Execute build completed hook
      */
     await this.#hooks.runner('buildFinished').run(this, displayMessage)
 
     /**
-     * Next steps
+     * Display next steps
      */
     displayMessage
       .add(this.ui.colors.cyan(`cd ${this.#getRelativeName(outDir)}`))

src/dev_server.ts

@@ -125,7 +125,7 @@ export class DevServer {
   /**
    * Index generator for managing auto-generated index files
    */
-  #indexGenerator: IndexGenerator
+  #indexGenerator!: IndexGenerator
 
   /**
    * Hooks to execute custom actions during the dev server lifecycle
@@ -145,7 +145,7 @@ export class DevServer {
   /**
    * CLI UI instance for displaying colorful messages and progress information
    */
-  #ui = cliui()
+  ui = cliui()
 
   /**
    * Restarts the HTTP server and throttle concurrent calls to
@@ -188,21 +188,6 @@ export class DevServer {
     this.#shortcutsManager?.cleanup()
   }
 
-  /**
-   * CLI UI instance to log colorful messages and progress information
-   */
-  get ui() {
-    return this.#ui
-  }
-
-  /**
-   * CLI UI instance to log colorful messages and progress information
-   */
-  set ui(ui: ReturnType<typeof cliui>) {
-    this.#ui = ui
-    this.#indexGenerator.setLogger(ui.logger)
-  }
-
   /**
    * The mode in which the DevServer is running.
    */
@@ -240,7 +225,6 @@ export class DevServer {
     this.cwd = cwd
     this.options = options
     this.cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
-    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
   }
 
   /**
@@ -458,6 +442,7 @@ export class DevServer {
     this.#clearScreen()
     this.ui.logger.info(`starting server in ${this.#mode} mode...`)
 
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
     this.#stickyPort = String(await getPort(this.cwd))
     this.#fileSystem = new FileSystem(this.cwdPath, tsConfig, this.options)
 

src/index_generator/main.ts

@@ -52,18 +52,6 @@ export class IndexGenerator {
     this.#cliLogger = cliLogger
   }
 
-  /**
-   * Set the logger instance used for CLI output
-   *
-   * Updates the CLI logger instance for this index generator and all
-   * registered sources to use the new logger for output.
-   *
-   * @param cliLogger - New logger instance to use
-   */
-  setLogger(cliLogger: Logger) {
-    this.#cliLogger = cliLogger
-  }
-
   /**
    * Add a new index generator source
    *

src/index_generator/source.ts

@@ -122,15 +122,6 @@ export class IndexGeneratorSource {
     })
   }
 
-  /**
-   * Set the logger instance used for CLI output
-   *
-   * @param cliLogger - New logger instance to use
-   */
-  setLogger(cliLogger: Logger) {
-    this.#cliLogger = cliLogger
-  }
-
   /**
    * Converts a recursive file tree to a string representation
    *

src/test_runner.ts

@@ -98,12 +98,12 @@ export class TestRunner {
   /**
    * Index generator for managing auto-generated index files
    */
-  #indexGenerator: IndexGenerator
+  #indexGenerator!: IndexGenerator
 
   /**
    * CLI UI instance for displaying colorful messages and progress information
    */
-  #ui = cliui()
+  ui = cliui()
 
   /**
    * Re-runs the test child process and throttle concurrent calls to
@@ -117,21 +117,6 @@ export class TestRunner {
     await this.#runTests(this.#stickyPort, filters)
   }, 'reRunTests')
 
-  /**
-   * CLI UI instance to log colorful messages and progress information
-   */
-  get ui() {
-    return this.#ui
-  }
-
-  /**
-   * CLI UI instance to log colorful messages and progress information
-   */
-  set ui(ui: ReturnType<typeof cliui>) {
-    this.#ui = ui
-    this.#indexGenerator.setLogger(ui.logger)
-  }
-
   /**
    * The script file to run as a child process
    */
@@ -162,7 +147,6 @@ export class TestRunner {
     this.cwd = cwd
     this.options = options
     this.cwdPath = string.toUnixSlash(fileURLToPath(this.cwd))
-    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
   }
 
   /**
@@ -417,17 +401,12 @@ export class TestRunner {
    */
   async run() {
     this.#stickyPort = String(await getPort(this.cwd))
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
+
     this.#clearScreen()
 
     this.ui.logger.info('loading hooks...')
-    this.#hooks = await loadHooks(this.options.hooks, [
-      'init',
-      'testsStarting',
-      'testsFinished',
-      'fileAdded',
-      'fileChanged',
-      'fileRemoved',
-    ])
+    this.#hooks = await loadHooks(this.options.hooks, ['init', 'testsStarting', 'testsFinished'])
 
     /**
      * Run init hooks and clear them as they won't be executed
@@ -462,6 +441,8 @@ export class TestRunner {
     }
 
     this.#stickyPort = String(await getPort(this.cwd))
+    this.#indexGenerator = new IndexGenerator(this.cwdPath, this.ui.logger)
+
     this.#fileSystem = new FileSystem(this.cwdPath, tsConfig, {
       ...this.options,
       suites: this.options.suites?.filter((suite) => {

tests/bundler.spec.ts

@@ -10,7 +10,7 @@
 import ts from 'typescript'
 import { test } from '@japa/runner'
 
-import { Bundler } from '../index.ts'
+import { Bundler, hooks } from '../index.ts'
 
 test.group('Bundler', () => {
   test('should copy metafiles to the build directory', async ({ assert, fs }) => {
@@ -338,4 +338,42 @@ test.group('Bundler', () => {
 
     await assert.dirExists('./build')
   })
+
+  test('generator index file', async ({ assert, fs }) => {
+    await Promise.all([
+      fs.create(
+        'tsconfig.json',
+        JSON.stringify({ compilerOptions: { outDir: 'build', skipLibCheck: true } })
+      ),
+      fs.create('adonisrc.ts', 'export default { hooks: { onBuildStarting: [() => {}] } }'),
+      fs.create('package.json', '{}'),
+      fs.create('package-lock.json', '{}'),
+    ])
+
+    const bundler = new Bundler(fs.baseUrl, ts, {
+      hooks: {
+        init: [
+          async () => ({
+            default: hooks.init((_, indexGenerator) => {
+              indexGenerator.add('controllers', {
+                as: 'barrelFile',
+                output: '.adonisjs/server/controllers.ts',
+                exportName: 'controllers',
+                source: 'app/controllers',
+                importAlias: '#controllers',
+              })
+            }),
+          }),
+        ],
+      },
+    })
+
+    bundler.ui.switchMode('raw')
+    await bundler.bundle()
+
+    assert.snapshot(await fs.contents('.adonisjs/server/controllers.ts')).matchInline(`
+      "export const controllers = {
+      }"
+    `)
+  })
 })