1 | # Installation
|
2 | > `npm install --save @types/pretty-quick`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for pretty-quick (https://github.com/azz/pretty-quick#readme).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pretty-quick.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pretty-quick/index.d.ts)
|
10 | ````ts
|
11 | // Type definitions for pretty-quick 3.1
|
12 | // Project: https://github.com/azz/pretty-quick#readme
|
13 | // Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
14 | // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
15 |
|
16 | import { ResolveConfigOptions } from 'prettier';
|
17 |
|
18 | declare namespace prettyQuick {
|
19 | interface Options {
|
20 | config?: ResolveConfigOptions | undefined;
|
21 | since?: string | undefined;
|
22 | /** @default false */
|
23 | staged?: boolean | undefined;
|
24 | pattern?: string | string[] | undefined;
|
25 | /** @default true */
|
26 | restage?: boolean | undefined;
|
27 | /**
|
28 | * @default 'master' | 'default'
|
29 | */
|
30 | branch?: string | undefined;
|
31 | bail?: boolean | undefined;
|
32 | check?: boolean | undefined;
|
33 | ignorePath?: string | undefined;
|
34 | verbose?: boolean | undefined;
|
35 | onFoundSinceRevision?: ((name: string, revision: string) => void) | undefined;
|
36 | onFoundChangedFiles?: ((changedFiles: string[]) => void) | undefined;
|
37 | onPartiallyStagedFile?: ((file: string) => void) | undefined;
|
38 | onExamineFile?: ((file: string) => void) | undefined;
|
39 | onCheckFile?: ((file: string, isFormatted: boolean) => void) | undefined;
|
40 | onWriteFile?: ((file: string) => void) | undefined;
|
41 | // ...args support
|
42 | [key: string]: any;
|
43 | }
|
44 |
|
45 | interface Results {
|
46 | readonly success: boolean;
|
47 | readonly errors: string[];
|
48 | }
|
49 | }
|
50 |
|
51 | /**
|
52 | * Runs Prettier on your changed files.
|
53 | * Supported source control managers:
|
54 | * * Git
|
55 | * * Mercurial
|
56 | */
|
57 | declare function prettyQuick(currentDirectory: string, options?: prettyQuick.Options): prettyQuick.Results;
|
58 |
|
59 | export = prettyQuick;
|
60 |
|
61 | ````
|
62 |
|
63 | ### Additional Details
|
64 | * Last updated: Thu, 28 Oct 2021 11:31:29 GMT
|
65 | * Dependencies: [@types/prettier](https://npmjs.com/package/@types/prettier)
|
66 | * Global values: none
|
67 |
|
68 | # Credits
|
69 | These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).
|
70 |
|
\ | No newline at end of file |