Class IndexGeneratorSource

constructor

• new IndexGeneratorSource(
      name: string,
      appRoot: string,
      cliLogger: Logger,
      config: IndexGeneratorSourceConfig,
  ): IndexGeneratorSource

  Create a new IndexGeneratorSource instance

  Parameters

  • name: string

    Unique name for this index generator source

  • appRoot: string

    The application root directory path

  • cliLogger: Logger

    Logger instance for CLI output

  • config: IndexGeneratorSourceConfig

    Configuration for this index generator source

  Returns IndexGeneratorSource

name

setLogger

• setLogger(cliLogger: Logger): void

  Set the logger instance used for CLI output

  Parameters

  • cliLogger: Logger

    New logger instance to use

  Returns void

addFile

• addFile(filePath: string): Promise<void>

  Add a file to the virtual file system and regenerate index if needed

  If the file matches the configured glob patterns, it will be added to the virtual file system and the index file will be regenerated.

  Parameters

  • filePath: string

    Absolute path of the file to add

  Returns Promise<void>

removeFile

• removeFile(filePath: string): Promise<void>

  Remove a file from the virtual file system and regenerate index if needed

  If the file was previously tracked, it will be removed from the virtual file system and the index file will be regenerated.

  Parameters

  • filePath: string

    Absolute path of the file to remove

  Returns Promise<void>

generate

• generate(): Promise<void>

  Generate the index file

  This method scans the source directory, processes files according to the configuration, and writes the generated index file to disk.

  Returns Promise<void>