Options
All
  • Public
  • Public/Protected
  • All
Menu

leasot

Index

Type aliases

Parser

Parser: function

receive the contents and file and return a list of parsed items

Type declaration

    • Parameters

      • contents: string
      • file: string

      Returns TodoComment[]

ParserFactory

ParserFactory: function

A factory to return a parser

Type declaration

ReportItems

ReportItems: function

Report the provided items

Type declaration

ReporterName

ReporterName: string

Tag

Tag: string

Sometimes referred to as kind, this is usually a TODO or FIXME but can be any custom string

TransformComment

TransformComment: function

Type declaration

    • (file: string, line: number, ref: string, tag: Tag, text: string): string | string[]
    • Parameters

      • file: string
      • line: number
      • ref: string
      • tag: Tag
      • text: string

      Returns string | string[]

TransformHeader

TransformHeader: function

Type declaration

    • (tag: Tag): string | string[]
    • Parameters

      Returns string | string[]

Functions

Const associateExtWithParser

  • Extend the extensions database at runtime, by either adding support for new extensions or overriding existing ones

    Parameters

    • extendedDb: ExtensionsDb

      The extension database to extend with

    Returns void

Const getRegex

  • getRegex(customTags?: Tag[]): string

Const isExtensionSupported

  • isExtensionSupported(extension: string): boolean
  • Check whether the provided extension is currently supported

    Parameters

    • extension: string

      the extension to check

    Returns boolean

Const loadReporter

Const parse

  • Parse the provided content and return an array of parsed items

    Parameters

    • content: string

      The contents to parse

    • config: ParseConfig

      The parse configuration

    Returns TodoComment[]

Const prepareComment

  • prepareComment(match: string[], line: number, filename?: string): TodoComment

Const report

Const reporter

Generated using TypeDoc