Skip to content

FormatOptions

Parameters for the format function.

Import:

import type { FormatOptions } from '@mnaoumov/typescript-dev-toolkit/formatters/auto';

Signature:

export interface FormatOptions

Properties

PropertyTypeDescription
defaultConfigFilePath?string | undefinedThe configuration file used when the project has none of its own, as the chosen formatter's own format takes it.
formatter?Formatter | undefinedThe formatter to run. Omitted, detectFormatter chooses it.
paths?string[] | undefinedOptional file paths to format. If omitted, formats the entire project.
rewrite?boolean | undefinedWhether to rewrite the source code.

Links to this page: