Class DocMakerAbstract

Abstract base class for generating wiki files. Please make sure to register your WikiMaker implementation in the CLI wiki tool to have it executed: src/cli/wiki.ts.

If this wiki page produces multiple pages ("sub files"), you can use writeSubFile inside the text method to write those additional files.

Hierarchy (View Summary)

Implements

Hierarchy-Diagram

UML class diagram of DocMaker

Constructors

constructor

Methods

didUpdate getProducer getTarget getWrittenSubfiles make normalizeText text writeSubFile

Constructors

Protectedconstructor

  • new DocMaker(
        target: PathLike,
        filename: string,
        purpose: string,
        printHeader?: boolean,
    ): DocMaker
    Protected

    Creates a new WikiMaker instance.

    Parameters

    • target: PathLike

      The target path where the wiki file will be generated.

    • filename: string

      The name of the file being generated. Probably use module.filename.

    • purpose: string

      The purpose of the file, e.g., 'wiki context for types'.

    • printHeader: boolean = true

      Whether to print the auto-generation header. Default is true. Only mark this false if you plan to add it yourself.

    Returns DocMaker

Methods

ProtecteddidUpdate

getProducer

getTarget

getWrittenSubfiles

make

ProtectednormalizeText

Protected Abstracttext

ProtectedwriteSubFile

  • writeSubFile(path: PathLike, data: string): boolean

    Please note that for subfiles you have to always add your own header

    Parameters

    • path: PathLike
    • data: string

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Methods