retext-passive
Version:
retext plugin to check for passive voice
21 lines (20 loc) • 539 B
TypeScript
/**
* Check for passive voice.
*
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @returns
* Transform.
*/
export default function retextPassive(options?: Readonly<Options> | null | undefined): (tree: Root, file: VFile) => undefined;
export type Root = import('nlcst').Root;
export type VFile = import('vfile').VFile;
/**
* Configuration.
*/
export type Options = {
/**
* Phrases *not* to warn about (optional).
*/
ignore?: ReadonlyArray<string> | null | undefined;
};