| 1 | import { CursorOptions, CursorResult, Options, Plugin } from './';
|
| 2 |
|
| 3 | /**
|
| 4 | * formatWithCursor both formats the code, and translates a cursor position from unformatted code to formatted code.
|
| 5 | * This is useful for editor integrations, to prevent the cursor from moving when code is formatted
|
| 6 | *
|
| 7 | * The cursorOffset option should be provided, to specify where the cursor is. This option cannot be used with rangeStart and rangeEnd.
|
| 8 | *
|
| 9 | * ```js
|
| 10 | * prettier.formatWithCursor(" 1", { cursorOffset: 2, parser: "babel" });
|
| 11 | * ```
|
| 12 | * `-> { formatted: '1;\n', cursorOffset: 1 }`
|
| 13 | */
|
| 14 | export function formatWithCursor(source: string, options: CursorOptions): CursorResult;
|
| 15 |
|
| 16 | /**
|
| 17 | * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/en/options.html) may be provided to override the defaults.
|
| 18 | */
|
| 19 | export function format(source: string, options?: Options): string;
|
| 20 |
|
| 21 | /**
|
| 22 | * `check` checks to see if the file has been formatted with Prettier given those options and returns a `Boolean`.
|
| 23 | * This is similar to the `--list-different` parameter in the CLI and is useful for running Prettier in CI scenarios.
|
| 24 | */
|
| 25 | export function check(source: string, options?: Options): boolean;
|
| 26 |
|
| 27 | export as namespace prettier;
|