Class IndexGenerator

IndexGenerator manages the generation of index files for AdonisJS applications.

This class provides a way to configure multiple sources and generate index files that export collections of modules, typically used for barrel exports or auto-discovery patterns in AdonisJS applications.

Example

const generator = new IndexGenerator(appRoot)
generator.add('controllers', {
  source: 'app/controllers',
  output: 'app/controllers/index.ts',
  as: 'barrelFile',
  exportName: 'controllers'
})
await generator.generate()

Index

Constructors

constructor

Methods

setLogger add addFile removeFile generate

Constructors

constructor

new IndexGenerator(appRoot: string, cliLogger: Logger): IndexGenerator
Create a new IndexGenerator instance
Parameters
- appRoot: string
  The application root directory path
- cliLogger: Logger
  Logger instance for CLI output
Returns IndexGenerator
- Defined in src/index_generator/main.ts:50

Methods

setLogger

setLogger(cliLogger: Logger): void
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.
Parameters
- cliLogger: Logger
  New logger instance to use
Returns void
- Defined in src/index_generator/main.ts:63

add

add(name: string, config: IndexGeneratorSourceConfig): IndexGenerator
Add a new index generator source
Parameters
- name: string
  Unique name for the source
- config: IndexGeneratorSourceConfig
  Configuration for the index generator source
Returns IndexGenerator
This IndexGenerator instance for method chaining
- Defined in src/index_generator/main.ts:74

addFile

addFile(filePath: string): Promise<void>
Add a file to all registered index generator sources

This method propagates the file addition to all registered sources, allowing them to regenerate their index files if the new file matches their glob patterns.
Parameters
- filePath: string
  Absolute path of the file to add
Returns Promise<void>
- Defined in src/index_generator/main.ts:88

removeFile

removeFile(filePath: string): Promise<void>
Remove a file from all registered index generator sources

This method propagates the file removal to all registered sources, allowing them to regenerate their index files if the removed file was previously tracked.
Parameters
- filePath: string
  Absolute path of the file to remove
Returns Promise<void>
- Defined in src/index_generator/main.ts:104

generate

generate(): Promise<void>
Generate all registered index files

Iterates through all registered sources and generates their corresponding index files.

Returns Promise<void>
- Defined in src/index_generator/main.ts:117

Class IndexGenerator

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns IndexGenerator

Methods

setLogger

Parameters

Returns void

add

Parameters

Returns IndexGenerator

addFile

Parameters

Returns Promise<void>

removeFile

Parameters

Returns Promise<void>

generate

Returns Promise<void>

Settings

On This Page