Config

Structure

interface SwerrConfig {
	sourceFile: {
		inputDir?: string;
		meta?: {
			projectName?: string;
			version?: string;
			description?: string;
		};
		export?: {
			saveToFile?: boolean;
			fileName?: string;
			outputDir?: string;
		};
		options?: {
			ignoreDirs?: string[];
			whitelistExtensions?: string[];
		}
	},
	converter: ConverterConfig<any>[]
}

interface ConverterConfig<CFG> {
	factory: ConverterFn<CFG>;
	config: CFG;
}

type ConverterFn<CFG> = (config: CFG, scheme: SwerrScheme) => Promise<void>;

sourceFile

The sourceFile object is important for defining certain information that the CLI uses to generate the source file consumed by the converter.

inputDir

type: string required

The root directory that the CLI scans for exception classes and JSDoc comments

meta

Optional metadata that is attached to the generated source file. This information can be used by converters for documentation headers, versioning, or display purposes.

export

Controls whether the generated source file should be written to disk.

If saveToFile is disabled, the source file is only kept in memory and passed directly to the converters.

options

Additional options that influence how files are discovered and processed.

converter

The converter property defines one or more converters that consume the generated source file.

Each converter consists of:

• a factory function that performs the conversion

• a config object that is passed to the converter

Multiple converters can be registered and will be executed sequentially

Example Configuration

import {myConverter} from "./src/docs/myConverter.ts"

export default {
  sourceFile: {
    inputDir: "src",
    meta: {
      projectName: "My API",
      description: "My API description",
      version: "1.0.0"
    },
    export: {
      saveToFile: true,
      fileName: "swerr-source.json",
      outputDir: "./dist/docs"
    },
    options: {
      ignoreDirs: ["node_modules", "dist"],
      whitelistExtensions: [".ts"]
    }
  },
  converter: [
    {
      factory: myConverter,
      config: {
        outputPath: "./dist/docs"
      }
    }
  ]
};