Documentation for Simbo's Packages
    Preparing search index...

    Interface Options

    Options for calling Prettier.

    interface Options {
        binPath?: string;
        disableIgnores?: boolean;
        mode?: "write" | "check";
        throwIfNotFound?: boolean;
        workingDir?: string;
    }
    Index

    Properties

    binPath? disableIgnores? mode? throwIfNotFound? workingDir?

    Properties

    binPath?: string

    The path to the Prettier binary. If not specified, it will be found using findBin.

    await findBin('prettier', { workingDir })
    disableIgnores?: boolean

    Whether to disable ignore patterns defined in the respective context. If not specified, ignore patterns will be respected.

    false
    mode?: "write" | "check"

    The mode to run Prettier in. If not specified, 'write' mode will be used.

    'write'
    throwIfNotFound?: boolean

    Whether to throw an error if the Prettier binary is not found.

    true
    workingDir?: string

    The working directory to run Prettier in. If not specified, the current working directory will be used.

    process.cwd()

    Settings

    Member Visibility

    On This Page

    Properties