SimpleDocExtractor.ts

Main orchestrator class for extracting and generating documentation from source files.

This class coordinates the entire documentation generation process by scanning files,

extracting documentation content, and generating both individual documentation files

and index files. It supports multiple targets and provides comprehensive logging.

@example

 const scraper = new SimpleDocsExtractor({
   baseDir: './src',
   extraction: {
     extractMethod: 'tags',
     startTag: '#START',
     endTag: '#END'
   },
   searchAndReplace: { replace: '' },
   generators: {
     index: { template: './templates/index.md' },
     documentation: { template: './templates/doc.md' }
   },
   targets: [{
     globOptions: { cwd: './src', extensions: '*.js' },
     outDir: './docs',
     createIndexFile: true
   }]
 });

 const result = await scraper.start();

---

Methods

create

Creates a new config object using the Builder.

@param baseDir - The base directory for the config

@returns The config instance

---

getConfig

Returns the current configuration.

@returns The current SimpleDocExtractor configuration

---

start

Starts the documentation generation process for all configured targets.

@returns Promise resolving to result object with success count, total count, and logs

---

handleTarget

Processes a single target directory by scanning files and generating documentation.

@param target - The target configuration to process

@param targetIndex - The index of the target for logging purposes

---

processSingleFile

Processes a single file by extracting documentation and generating output.

@param file - The file path to process

@param target - The target configuration

@param targetIndex - The index of the target for logging

@param preProcessedFiles - Array to collect processed file results

@param codeFileProcessor - The file processor instance to use

---

handleRecursivelyCreateIndexFiles

Creates an index file recursively for the target if configured to do so.

@param target - The target configuration

---

handleRootIndexFile

Creates the root index file.

@param target - The target configuration

---

getIndexProcessorConfig

Gets the index processor config for the target.

• Returns the target’s index processor config if it exists

• Returns the default index processor config if the target’s index processor config does not exist

• Returns an empty object if the default index processor config does not exist

@param target - The target configuration

@returns The index processor config

---

Gets the files for the target using the configured file scanner.

@param target - The target configuration containing glob options

@returns Promise resolving to array of matching file paths

---

Last updated: 2025-09-16T21:51:51.930Z

This file is auto generated. Do not edit manually.*

Back to Index