@dovenv/todo - API documentation

Classes

Todo

Constructors

new Todo()

new Todo(__namedParameters: {
  opts: Config;
  utils: CommandSuper;
 }): Todo

Parameters

Parameter	Type
__namedParameters	object
__namedParameters.opts?	Config
__namedParameters.utils	CommandSuper

Returns

Todo

Methods

run()

run(pattern?: string[]): Promise<undefined | TodoComment[]>

Parameters

Parameter	Type
pattern?	string[]

Returns

Promise<undefined | TodoComment[]>

Properties

Property	Type
opts	undefined | Config
utils	CommandSuper

Functions

todoPlugin()

function todoPlugin(params?: Config): Config

A plugin for dovenv to get TODOs in a workspace.

Parameters

Parameter	Type	Description
params?	Config	Configuration for the plugin.

Returns

Config

• The plugin.

Example

import { defineConfig } from '@dovenv/core'
import { todoPlugin } from '@dovenv/todo'
export default defineConfig( todoPlugin( {
    example : {
      input : [ 'src/*.{ts,tsx,js,jsx,md}' ],
    },
 } )).

Type Aliases

Config

type Config: { [key in string]: Object };

References

default

Renames and re-exports todoPlugin