# @types/pretty-quick

> TypeScript definitions for pretty-quick

Latest version **3.1.6** (published 2024-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/pretty-quick
pnpm add @types/pretty-quick
yarn add @types/pretty-quick
bun add @types/pretty-quick
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.1.6 |
| Published | 2024-02-27 |
| First published | 2020-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/pretty-quick
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pretty-quick
- npm.io page: https://npm.io/package/@types/pretty-quick

## Dependencies (1)

- [@types/prettier](https://npm.io/package/@types/prettier.md) ^2.0.0

## Recent versions

- 3.1.6 (latest) — 2024-02-27
- 3.1.5 (ts4.5) — 2023-11-07
- 3.1.2 (ts4.3) — 2023-07-29
- 3.1.1 (ts4.2) — 2022-05-12
- 3.1.0 (ts3.7) — 2021-10-28
- 2.0.0 (ts2.8) — 2020-04-13
- 3.1.4 — 2023-10-18
- 3.1.3 — 2023-09-24
- 2.0.2 — 2021-07-08
- 2.0.1 — 2021-06-11

## README

# Installation
> `npm install --save @types/pretty-quick`

# Summary
This package contains type definitions for pretty-quick (https://github.com/azz/pretty-quick#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pretty-quick.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pretty-quick/index.d.ts)
````ts
import { ResolveConfigOptions } from "prettier";

declare namespace prettyQuick {
    interface Options {
        config?: ResolveConfigOptions | undefined;
        since?: string | undefined;
        /** @default false */
        staged?: boolean | undefined;
        pattern?: string | string[] | undefined;
        /** @default true */
        restage?: boolean | undefined;
        /**
         * @default 'master' | 'default'
         */
        branch?: string | undefined;
        bail?: boolean | undefined;
        check?: boolean | undefined;
        ignorePath?: string | undefined;
        verbose?: boolean | undefined;
        onFoundSinceRevision?: ((name: string, revision: string) => void) | undefined;
        onFoundChangedFiles?: ((changedFiles: string[]) => void) | undefined;
        onPartiallyStagedFile?: ((file: string) => void) | undefined;
        onExamineFile?: ((file: string) => void) | undefined;
        onCheckFile?: ((file: string, isFormatted: boolean) => void) | undefined;
        onWriteFile?: ((file: string) => void) | undefined;
        // ...args support
        [key: string]: any;
    }

    interface Results {
        readonly success: boolean;
        readonly errors: string[];
    }
}

/**
 * Runs Prettier on your changed files.
 * Supported source control managers:
 * * Git
 * * Mercurial
 */
declare function prettyQuick(currentDirectory: string, options?: prettyQuick.Options): prettyQuick.Results;

export = prettyQuick;

````

### Additional Details
 * Last updated: Tue, 27 Feb 2024 18:07:37 GMT
 * Dependencies: [@types/prettier](https://npmjs.com/package/@types/prettier)

# Credits
These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).

---
_Source: https://npm.io/package/@types/pretty-quick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._