SUZUKI Sosukeandfisker Cheung
813df18df6
* Rename `types` to `thirs-party-types` * Copy `index.d.ts` from `@types/prettier` * Make public APIs async * Add missing `formatAST` * Fix `CustomParser` * Fix `Parser.parse` signature * Add comment * Add `standalonw.d.ts` * first implement * Fix path * Add missing parser `.d.ts` * Fix * Fix path * Introduce valid tests * Add unit tests for dts files * Add unit tests * Simplify unit testing * Tweaks structures * Revert needless change * Fix types path * Introduce `ts-expect` * Fix doc utils api * Add AstPath API * Fix API * Fix tests * Fix changelog * Move dts * Update module specifiers * Remove generate dts config file * Update build scripts * Fix type errors * Refactor with namespace imports * Update comments * Fix build script * Improve build script * `typing` -> `types` * Clean up * Minor tweak * Minor tweak * Modify `exports` field * Fix paths in builder * Refactor * Refactor * Address review * Update changelog * Address reviews * Remove `since` from tests * Improve utils type def * Mark deprecated methods * Address review * Move docs types * Address review * Update c8 config * Minor tweak --------- Co-authored-by: fisker Cheung <lionkay@gmail.com>
34 lines
1.4 KiB
TypeScript
34 lines
1.4 KiB
TypeScript
import { CursorOptions, CursorResult, Options, SupportInfo } from "./index.js";
|
|
|
|
/**
|
|
* 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
|
|
* await prettier.formatWithCursor(" 1", { cursorOffset: 2, parser: "babel" });
|
|
* ```
|
|
* `-> { formatted: "1;\n", cursorOffset: 1 }`
|
|
*/
|
|
export function formatWithCursor(
|
|
source: string,
|
|
options: CursorOptions
|
|
): Promise<CursorResult>;
|
|
|
|
/**
|
|
* `format` is used to format text using Prettier. [Options](https://prettier.io/docs/en/options.html) may be provided to override the defaults.
|
|
*/
|
|
export function format(source: string, options?: Options): Promise<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): Promise<boolean>;
|
|
|
|
/**
|
|
* Returns an object representing the parsers, languages and file types Prettier supports for the current version.
|
|
*/
|
|
export function getSupportInfo(): Promise<SupportInfo>;
|