@prettier/sync

Synchronous version of Prettier

Installation

1yarn add prettier @prettier/sync

Usage

1import synchronizedPrettier from "@prettier/sync";
2
3synchronizedPrettier.format("foo( )", { parser: "babel" });
4// => 'foo();\n'

This package is a simple wrapper of make-synchronized.

For more complex use cases, it's better to use make-synchronized directly:

Example:

1import * as fs from "node:fs/promises";
2import * as prettier from "prettier";
3import makeSynchronized from "make-synchronized";
4
5export default makeSynchronized(import.meta, async function formatFile(file) {
6  const config = await prettier.resolveConfig(file);
7  const content = await fs.readFile(file, "utf8");
8  const formatted = await prettier.format(content, {
9    ...config,
10    filepath: file,
11  });
12  await fs.writeFile(file, formatted);
13});

Alternatively you can also use synckit or make-synchronous.

createSynchronizedPrettier(options)

options

Type: object

prettierEntry

Type: string | URL

Path or URL to prettier entry.

1import { createSynchronizedPrettier } from "@prettier/sync";
2
3const synchronizedPrettier = createSynchronizedPrettier({
4  prettierEntry: "/path/to/prettier/index.js",
5});
6
7synchronizedPrettier.format("foo( )", { parser: "babel" });
8// => 'foo();\n'