leasot

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

Parser

Parser: function

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

Type declaration

- (contents: string, file: string): TodoComment[]
- Parameters
  - contents: string
  - file: string
  Returns TodoComment[]

ParserFactory

ParserFactory: function

A factory to return a parser

Type declaration

- (config: ParserFactoryConfig): Parser
- Parameters
  - config: ParserFactoryConfig
  Returns Parser

ReportItems

ReportItems: function

Report the provided items

Type declaration

- (comments: TodoComment[], config: any): any
- Parameters
  - comments: TodoComment[]
  - config: any
  Returns any

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
  - tag: Tag
  Returns string | string[]

Functions

Const associateExtWithParser

associateExtWithParser(extendedDb: ExtensionsDb): void

- Defined in lib/parsers.ts:74
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

- Defined in lib/utils/comments.ts:5
Parameters
- Default value customTags: Tag[] = []
Returns string

Const isExtensionSupported

isExtensionSupported(extension: string): boolean

- Defined in lib/parsers.ts:97
Check whether the provided extension is currently supported

Parameters
- extension: string
  
  the extension to check
Returns boolean

Const loadReporter

loadReporter(reporter: ReporterName | ReportItems): ReportItems | void

- Defined in lib/reporters.ts:7
Load the given reporter

Parameters
- reporter: ReporterName | ReportItems
Returns ReportItems | void

Const parse

parse(content: string, config: ParseConfig): TodoComment[]

- Defined in lib/parsers.ts:122
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

- Defined in lib/utils/comments.ts:36
Parameters
- match: string[]
- line: number
- Default value filename: string = "unknown"
Returns TodoComment

Const report

report(items: TodoComment[], reporter?: BuiltinReporters | ReporterName | ReportItems, config?: ReporterConfig): any

- Defined in lib/reporters.ts:36
Report the provided items

Parameters
- items: TodoComment[]
  
  The items to report
- Default value reporter: BuiltinReporters | ReporterName | ReportItems = BuiltinReporters.raw
  
  The reporter to use
- Default value config: ReporterConfig = {}
  
  Reporter configuration
Returns any

Const reporter

reporter(todos: TodoComment[], config?: ReporterConfig): string
reporter(todos: TodoComment[], config?: JsonReporterConfig): string
reporter(todos: TodoComment[], config?: ReporterConfig): string
reporter(todos: TodoComment[]): TodoComment[]
reporter(todos: TodoComment[]): string
reporter(todos: TodoComment[], config?: ReporterConfig): string
reporter(todos: TodoComment[], config?: XMLReporterConfig): string

- Defined in lib/reporters/custom.ts:93
Parameters
- todos: TodoComment[]
- Optional config: ReporterConfig
Returns string
- Defined in lib/reporters/json.ts:7
Parameters
- todos: TodoComment[]
- Default value config: JsonReporterConfig = { spacing: 2 }
Returns string
- Defined in lib/reporters/markdown.ts:16
Parameters
- todos: TodoComment[]
- Optional config: ReporterConfig
Returns string
- Defined in lib/reporters/raw.ts:3
Parameters
- todos: TodoComment[]
Returns TodoComment[]
- Defined in lib/reporters/table.ts:57
Parameters
- todos: TodoComment[]
Returns string
- Defined in lib/reporters/vscode.ts:16
Parameters
- todos: TodoComment[]
- Optional config: ReporterConfig
Returns string
- Defined in lib/reporters/xml.ts:12
Parameters
- todos: TodoComment[]
- Default value config: XMLReporterConfig = { header: true }
Returns string

Generated using TypeDoc