Logo for jsDocs.io

@types/pretty-quick

  • Version 3.1.6
  • Published
  • 5.65 kB
  • 1 dependency
  • MIT license

Install

npm i @types/pretty-quick
yarn add @types/pretty-quick
pnpm add @types/pretty-quick

Overview

TypeScript definitions for pretty-quick

Index

Functions

Interfaces

Functions

function prettyQuick

prettyQuick: (
    currentDirectory: string,
    options?: prettyQuick.Options
) => prettyQuick.Results;

  • Runs Prettier on your changed files. Supported source control managers: * Git * Mercurial

Interfaces

interface Options

interface Options {}

    property bail

    bail?: boolean | undefined;

      property branch

      branch?: string | undefined;

      • 'master' | 'default'

      property check

      check?: boolean | undefined;

        property config

        config?: ResolveConfigOptions | undefined;

          property ignorePath

          ignorePath?: string | undefined;

            property onCheckFile

            onCheckFile?: ((file: string, isFormatted: boolean) => void) | undefined;

              property onExamineFile

              onExamineFile?: ((file: string) => void) | undefined;

                property onFoundChangedFiles

                onFoundChangedFiles?: ((changedFiles: string[]) => void) | undefined;

                  property onFoundSinceRevision

                  onFoundSinceRevision?: ((name: string, revision: string) => void) | undefined;

                    property onPartiallyStagedFile

                    onPartiallyStagedFile?: ((file: string) => void) | undefined;

                      property onWriteFile

                      onWriteFile?: ((file: string) => void) | undefined;

                        property pattern

                        pattern?: string | string[] | undefined;

                          property restage

                          restage?: boolean | undefined;

                          • true

                          property since

                          since?: string | undefined;

                            property staged

                            staged?: boolean | undefined;

                            • false

                            property verbose

                            verbose?: boolean | undefined;

                              index signature

                              [key: string]: any;

                                interface Results

                                interface Results {}

                                  property errors

                                  readonly errors: string[];

                                    property success

                                    readonly success: boolean;

                                      Package Files (1)

                                      Dependencies (1)

                                      Dev Dependencies (0)

                                      No dev dependencies.

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/pretty-quick.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/pretty-quick)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@types/pretty-quick"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>