diff options
Diffstat (limited to 'std/prettier/vendor/standalone.d.ts')
-rw-r--r-- | std/prettier/vendor/standalone.d.ts | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/std/prettier/vendor/standalone.d.ts b/std/prettier/vendor/standalone.d.ts new file mode 100644 index 000000000..9c2f73d69 --- /dev/null +++ b/std/prettier/vendor/standalone.d.ts @@ -0,0 +1,30 @@ +import { CursorOptions, CursorResult, Options, Plugin } from './index.d.ts'; + +/** + * formatWithCursor both formats the code, and translates a cursor position from unformatted code to formatted code. + * This is useful for editor integrations, to prevent the cursor from moving when code is formatted + * + * The cursorOffset option should be provided, to specify where the cursor is. This option cannot be used with rangeStart and rangeEnd. + * + * ```js + * prettier.formatWithCursor(" 1", { cursorOffset: 2, parser: "babel" }); + * ``` + * `-> { formatted: '1;\n', cursorOffset: 1 }` + */ +export function formatWithCursor( + source: string, + options: CursorOptions, +): CursorResult; + +/** + * `format` is used to format text using Prettier. [Options](https://github.com/prettier/prettier#options) may be provided to override the defaults. + */ +export function format(source: string, options?: Options): string; + +/** + * `check` checks to see if the file has been formatted with Prettier given those options and returns a `Boolean`. + * This is similar to the `--list-different` parameter in the CLI and is useful for running Prettier in CI scenarios. + */ +export function check(source: string, options?: Options): boolean; + +export as namespace prettier; |