Search code, repositories, users, issues, pull requests...

⚠ BREAKING CHANGES

upgrade to XO v1.0.0

Features

upgrade to XO v1.0.0 (b22919d)

`v5.3.0`

Features

disable default-case rule (663ded9)

`v5.2.0`

Features

enable @typescript-eslint/consistent-generic-constructors rule (76a2c10)

prettier/eslint-plugin-prettier (eslint-plugin-prettier)

`v5.5.6`

Patch Changes

#791 b5c96a3 Thanks @JounQin! - chore: bump all (dev)Dependencies

`v5.5.5`

Patch Changes

#772 7264ed0 Thanks @BPScott! - Bump prettier-linter-helpers dependency to v1.0.1
#776 77651a3 Thanks @aswils! - fix: bump synckit for yarn PnP ESM issue

`v5.5.4`

Patch Changes

#755 723f7a8 Thanks @kbrilla! - fix: add 'oxc', 'oxc-ts' and 'hermes' parsers to parserBlocklist
#751 cf52b30 Thanks @andreww2012! - fix: disallow extra properties in rule options

`v5.5.3`

republish the latest version

Full Changelog: prettier/eslint-plugin-prettier@v5.5.2...v5.5.3

`v5.5.2`

republish the latest version

Full Changelog: prettier/eslint-plugin-prettier@v5.5.1...v5.5.2

`v5.5.1`

Patch Changes

#748 bfd1e95 Thanks @JounQin! - fix: use prettierRcOptions directly for prettier 3.6+

`v5.5.0`

Minor Changes

#743 92f2c9c Thanks @dotcarmen! - feat: support non-js languages like css for @eslint/css and json for @eslint/json

`v5.4.1`

Patch Changes

#740 c21521f Thanks @JounQin! - fix(deps): bump synckit to v0.11.7 to fix potential TypeError: Cannot read properties of undefined (reading 'message') error

`v5.4.0`

Minor Changes

#736 59a0cae Thanks @yashtech00! - refactor: migrate worker.js to worker.mjs

`v5.3.1`

Patch Changes

#734 dcf2c80 Thanks @JounQin! - ci: enable NPM_CONFIG_PROVENANCE env

`v5.3.0`

Minor Changes

#674 6fe0c90 Thanks @irsooti! - feat(types): prefer Config over FlatConfig when they're equal

`v5.2.6`

Patch Changes

#723 1451176 Thanks @renovate! - fix(deps): bump synckit to v0.11.0

`v5.2.5`

Patch Changes

#721 4f5513d Thanks @JounQin! - fix: clarify correct eslint-config-prettier peer range

`v5.2.4`

Patch Changes

#715 b8cfe56 Thanks @JounQin! - chore: hourcekeeping, bump all (dev) deps

`v5.2.3`

Patch Changes

#703 9c6141f Thanks @BPScott! - Add name field to recommended flat config

`v5.2.2`

Patch Changes

#700 aa5b59f Thanks @ntnyq! - fix: report node when loc not found

`v5.2.1`

Patch Changes

#668 ac036cc Thanks @OrlovAlexei! - build(deps): Bump synckit from 0.8.6 to 0.9.1

`v5.1.3`

Patch Changes

#629 985b33c Thanks @JounQin! - chore: add package.json into exports map

`v5.1.2`

Patch Changes

#623 8210e44 Thanks @BPScott! - Add exports mapping to package.json, to allow import eslintPluginRecommended from 'eslint-plugin-prettier/recommended' to work as expected.

Strictly speaking this is a breaking change as it removes the ability for people to import from "eslint-plugin-prettier/eslint-plugin-prettier.js" and "eslint-plugin-prettier/recommended.js" but the former was never recommended in the first place and the latter has only been available for a few days.

#621 2b09e7f Thanks @JounQin! - feat: support parsing markdown via eslint-mdx natively

What means the following is unnecessary anymore when using with eslint-mdx/eslint-plugin-mdx!

[
  {
    files: ["**/*.md"],
    rules: { "prettier/prettier": ["error", { parser: "markdown" }] },
  },
  {
    files: ["**/*.mdx"],
    rules: { "prettier/prettier": ["error", { parser: "mdx" }] },
  },
]

`v5.1.1`

Patch Changes

#619 b5c0dc5 Thanks @JounQin! - chore: skip formatting inline scripts in pug files

`v5.1.0`

Minor Changes

#616 3856413 Thanks @BPScott! - Add recommended config for the flat config format.

If you are using flat config, import the recommended config from eslint-plugin-prettier/recommended. Like the legacy format recommended config, this automatically includes the contents of eslint-config-prettier.
```
// eslint.config.js
const eslintPluginPrettierRecommended = require("eslint-plugin-prettier/recommended");

module.exports = [
  // Any other config imports go at the top
  eslintPluginPrettierRecommended,
];
```

Patch Changes

#614 5270877 Thanks @BPScott! - Add meta block to plugin. This improves debugging and cachebusting when using the new flat config
#603 a63a570 Thanks @filiptammergard! - fix: specify eslint-config-prettier as peer dependency

It's already added to peerDependenciesMeta as optional, which means it should also be specified in peerDependencies.

`v5.0.1`

Patch Changes

#588 21a7146 Thanks @krist7599555! - fix: parserPath type might be undefined on Eslint Falt Config

`v5.0.0`

Major Changes

#508 910aeb6 Thanks @JounQin! - feat!: bump peer eslint to ">=8.0.0" and node to "^14.18.0 || >=16.0.0"
#508 910aeb6 Thanks @JounQin! - feat!: upgrade to prettier v3

Minor Changes

#508 910aeb6 Thanks @JounQin! - feat: add typings support

Patch Changes

#548 82a3db8 Thanks @fisker! - fix: add missing dependency synckit
#564 ae7a73c Thanks @auvred! - fix: compatibility with prettier@3 without plugins

`v4.2.5`

republish the v4 version

Full Changelog: prettier/eslint-plugin-prettier@v4.2.4...v4.2.5

`v4.2.4`

republish the v4 version

Full Changelog: prettier/eslint-plugin-prettier@v4.2.1...v4.2.4

`v4.2.1`

Patch Changes

#485 5736ed5 Thanks @JounQin! - chore: reuse prettierRcOptions instead of resolveConfig again

`v4.2.0`

Minor Changes

#483 7bd70b6 Thanks @JounQin! - feat: support svelte out of box

close #472, close #482

We recommend to use eslint-plugin-svelte instead of eslint-plugin-svelte3.

`v4.1.0`

feat: skip processing code blocks on specific languages like stylelint-prettier (#415) (52eec48)
build(deps): Bump minimist from 1.2.5 to 1.2.6 (#464) (42bfe88)
build(deps-dev): Bump graphql from 15.5.1 to 15.7.2 (#442) (0158640)
build(deps-dev): Bump @graphql-eslint/eslint-plugin from 2.3.0 to 2.4.0 (#444) (4bcaca2)
chore(CI): add tests for ESLint 8 (#428) (f3713be)
README.md: HTTP => HTTPS (#443) (44e1478)

prettier/prettier (prettier)

`v3.8.4`

Markdown: Fix blank lines between list items and nested sub-lists being removed in Markdown/MDX (#17746 by @byplayer)

Prettier was removing blank lines between list items and their nested sub-lists, converting loose lists into tight lists and changing their semantic meaning.

<!-- Input -->
- a

  - b

- c

  - d

<!-- Prettier 3.8.3 -->
- a
  - b
- c
  - d

<!-- Prettier 3.8.4 -->
- a

  - b

- c

  - d

`v3.8.3`

SCSS: Prevent trailing comma in `if()` function (#18471 by @kovsu)

// Input
$value: if(sass(false): 1; else: -1);

// Prettier 3.8.2
$value: if(
  sass(false): 1; else: -1,
);

// Prettier 3.8.3
$value: if(sass(false): 1; else: -1);

`v3.8.2`

Angular: Support Angular v21.2 (#18722, #19034 by @fisker)

Exhaustive typechecking with @default never;

<!-- Input -->
@&#8203;switch (foo) {
  @&#8203;case (1) {}
  @&#8203;default never;
}

<!-- Prettier 3.8.1 -->
SyntaxError: Incomplete block "default never". If you meant to write the @&#8203; character, you should use the "&#&#8203;64;" HTML entity instead. (3:3)

<!-- Prettier 3.8.2 -->
@&#8203;switch (foo) {
  @&#8203;case (1) {}
  @&#8203;default never;
}

arrow function and instanceof expressions.

<!-- Input -->
@&#8203;let fn = (a) =>        a?    1:2;

{{ fn ( a         instanceof b)}}

<!-- Prettier 3.8.1 -->
@&#8203;let fn = (a) =>        a?    1:2;

{{ fn ( a         instanceof b)}}

<!-- Prettier 3.8.2 -->
@&#8203;let fn = (a) => (a ? 1 : 2);

{{ fn(a instanceof b) }}

`v3.8.1`

Include available `printers` in plugin type declarations (#18706 by @porada)

// Input
import * as prettierPluginEstree from "prettier/plugins/estree";

// Prettier 3.8.0
// Property 'printers' does not exist on type 'typeof import("prettier/plugins/estree")'. ts(2339)
prettierPluginEstree.printers.estree; //=> any

// Prettier 3.8.1
prettierPluginEstree.printers.estree; //=> Printer
prettierPluginEstree.printers["estree-json"]; //=> Printer

`v3.8.0`

`v3.7.4`

LWC: Avoid quote around interpolations (#18383 by @kovsu)

<!-- Input -->
<div foo={bar}>   </div>

<!-- Prettier 3.7.3 (--embedded-language-formatting off) -->
<div foo="{bar}"></div>

<!-- Prettier 3.7.4 (--embedded-language-formatting off) -->
<div foo={bar}></div>

TypeScript: Fix comment inside union type gets duplicated (#18393 by @fisker)

// Input
type Foo = (/** comment */ a | b) | c;

// Prettier 3.7.3
type Foo = /** comment */ (/** comment */ a | b) | c;

// Prettier 3.7.4
type Foo = /** comment */ (a | b) | c;

TypeScript: Fix unstable comment print in union type comments (#18395 by @fisker)

// Input
type X = (A | B) & (
  // comment
  A | B
);

// Prettier 3.7.3 (first format)
type X = (A | B) &
  (// comment
  A | B);

// Prettier 3.7.3 (second format)
type X = (
  | A
  | B // comment
) &
  (A | B);

// Prettier 3.7.4
type X = (A | B) &
  // comment
  (A | B);

`v3.7.3`

API: Fix `prettier.getFileInfo()` change that breaks VSCode extension (#18375 by @fisker)

An internal refactor accidentally broke the VSCode extension plugin loading.

`v3.7.2`

JavaScript: Fix string print when switching quotes (#18351 by @fisker)

// Input
console.log("A descriptor\\'s .kind must be \"method\" or \"field\".")

// Prettier 3.7.1
console.log('A descriptor\\'s .kind must be "method" or "field".');

// Prettier 3.7.2
console.log('A descriptor\\\'s .kind must be "method" or "field".');

JavaScript: Preserve quote for embedded HTML attribute values (#18352 by @kovsu)

// Input
const html = /* HTML */ ` <div class="${styles.banner}"></div> `;

// Prettier 3.7.1
const html = /* HTML */ ` <div class=${styles.banner}></div> `;

// Prettier 3.7.2
const html = /* HTML */ ` <div class="${styles.banner}"></div> `;

TypeScript: Fix comment in empty type literal (#18364 by @fisker)

// Input
export type XXX = {
  // tbd
};

// Prettier 3.7.1
export type XXX = { // tbd };

// Prettier 3.7.2
export type XXX = {
  // tbd
};

`v3.7.1`

API: Fix performance regression in doc printer (#18342 by @fisker)

Prettier 3.7.0 can be very slow when formatting big files, the regression has been fixed.

`v3.7.0`

`v3.6.2`

Markdown: Add missing blank line around code block (#17675 by @fisker)

<!-- Input -->
1. Some text, and code block below, with newline after code block

   ```yaml
   ---
   foo: bar
   ```

   1. Another
   2. List

<!-- Prettier 3.6.1 -->
1. Some text, and code block below, with newline after code block

   ```yaml
   ---
   foo: bar
   ```
   1. Another
   2. List

<!-- Prettier 3.6.2 -->
1. Some text, and code block below, with newline after code block

   ```yaml
   ---
   foo: bar
   ```

   1. Another
   2. List

`v3.6.1`

TypeScript: Allow const without initializer (#17650, #17654 by @fisker)

// Input
export const version: string;

// Prettier 3.6.0 (--parser=babel-ts)
SyntaxError: Unexpected token (1:21)
> 1 | export const version: string;
    |                     ^

// Prettier 3.6.0 (--parser=oxc-ts)
SyntaxError: Missing initializer in const declaration (1:14)
> 1 | export const version: string;
    |              ^^^^^^^^^^^^^^^

// Prettier 3.6.1
export const version: string;

Miscellaneous: Avoid closing files multiple times (#17665 by @43081j)

When reading a file to infer the interpreter from a shebang, we use the
n-readlines library to read the first line in order to get the shebang.

This library closes files when it reaches EOF, and we later try close the same
files again. We now close files only if n-readlines did not already close
them.

`v3.6.0`

`v3.5.3`

Flow: Fix missing parentheses in `ConditionalTypeAnnotation` (#17196 by @fisker)

// Input
type T<U> = 'a' | ('b' extends U ? 'c' : empty);
type T<U> = 'a' & ('b' extends U ? 'c' : empty);

// Prettier 3.5.2
type T<U> = "a" | "b" extends U ? "c" : empty;
type T<U> = "a" & "b" extends U ? "c" : empty;

// Prettier 3.5.3
type T<U> = "a" | ("b" extends U ? "c" : empty);
type T<U> = "a" & ("b" extends U ? "c" : empty);

`v3.5.2`

Remove `module-sync` condition (#17156 by @fisker)

In Prettier 3.5.0, we added module-sync condition to package.json, so that require("prettier") can use ESM version, but turns out it doesn't work if CommonJS and ESM plugins both imports builtin plugins. To solve this problem, we decide simply remove the module-sync condition, so require("prettier") will still use the CommonJS version, we'll revisit until require(ESM) feature is more stable.

`v3.5.1`

Fix CLI crash when cache for old version exists (#17100 by @sosukesuzuki)

Prettier 3.5 uses a different cache format than previous versions, Prettier 3.5.0 crashes when reading existing cache file, Prettier 3.5.1 fixed the problem.

Support dockercompose and github-actions-workflow in VSCode (#17101 by @remcohaszing)

Prettier now supports the dockercompose and github-actions-workflow languages in Visual Studio Code.

`v3.5.0`

`v3.4.2`

Treat U+30A0 & U+30FB in Katakana Block as CJK (#16796 by @tats-u)

Prettier doesn't treat U+30A0 & U+30FB as Japanese. U+30FB is commonly used in Japanese to represent the delimitation of first and last names of non-Japanese people or “and”. The following “C言語・C++・Go・Rust” means “C language & C++ & Go & Rust” in Japanese.

<!-- Input (--prose-wrap=never) -->

C言
語
・
C++
・
Go
・
Rust

<!-- Prettier 3.4.1 -->
C言語・ C++ ・ Go ・ Rust

<!-- Prettier 3.4.2 -->
C言語・C++・Go・Rust

U+30A0 can be used as the replacement of the - in non-Japanese names (e.g. “Saint-Saëns” (Charles Camille Saint-Saëns) can be represented as “サン゠サーンス” in Japanese), but substituted by ASCII hyphen (U+002D) or U+FF1D (full width hyphen) in many cases (e.g. “サン=サーンス” or “サン＝サーンス”).

Fix comments print on class methods with decorators (#16891 by @fisker)

// Input
class A {
  @&#8203;decorator
  /** 
   * The method description
   *
  */
  async method(foo: Foo, bar: Bar) {
    console.log(foo);
  }
}

// Prettier 3.4.1
class A {
  @&#8203;decorator
  async /**
   * The method description
   *
   */
  method(foo: Foo, bar: Bar) {
    console.log(foo);
  }
}

// Prettier 3.4.2
class A {
  @&#8203;decorator
  /**
   * The method description
   *
   */
  async method(foo: Foo, bar: Bar) {
    console.log(foo);
  }
}

Fix non-idempotent formatting (#16899 by @seiyab)

This bug fix is not language-specific. You may see similar change in any languages. This fixes regression in 3.4.0 so change caused by it should yield same formatting as 3.3.3.

// Input
<div>
  foo
  <span>longlonglonglonglonglonglonglonglonglonglonglonglonglonglongl foo</span>
  , abc
</div>;

// Prettier 3.4.1 (first)
<div>
  foo
  <span>
    longlonglonglonglonglonglonglonglonglonglonglonglonglonglongl foo
  </span>, abc
</div>;

// Prettier 3.4.1 (second)
<div>
  foo
  <span>longlonglonglonglonglonglonglonglonglonglonglonglonglonglongl foo</span>
  , abc
</div>;

// Prettier 3.4.2
<div>
  foo
  <span>longlonglonglonglonglonglonglonglonglonglonglonglonglonglongl foo</span>
  , abc
</div>;

`v3.4.1`

Remove unnecessary parentheses around assignment in `v-on` (#16887 by @fisker)

<!-- Input -->
<template>
  <button @&#8203;click="foo += 2">Click</button>
</template>

<!-- Prettier 3.4.0 -->
<template>
  <button @&#8203;click="(foo += 2)">Click</button>
</template>

<!-- Prettier 3.4.1 -->
<template>
  <button @&#8203;click="foo += 2">Click</button>
</template>

`v3.4.0`

`v3.3.3`

Add parentheses for nullish coalescing in ternary (#16391 by @cdignam-segment)

This change adds clarity to operator precedence.

// Input
foo ? bar ?? foo : baz;
foo ?? bar ? a : b;
a ? b : foo ?? bar;

// Prettier 3.3.2
foo ? bar ?? foo : baz;
foo ?? bar ? a : b;
a ? b : foo ?? bar;

// Prettier 3.3.3
foo ? (bar ?? foo) : baz;
(foo ?? bar) ? a : b;
a ? b : (foo ?? bar);

Add parentheses for decorator expressions (#16458 by @y-schneider)

Prevent parentheses around member expressions or tagged template literals from being removed to follow the stricter parsing rules of TypeScript 5.5.

// Input
@&#8203;(foo`tagged template`)
class X {}

// Prettier 3.3.2
@&#8203;foo`tagged template`
class X {}

// Prettier 3.3.3
@&#8203;(foo`tagged template`)
class X {}

Support `@let` declaration syntax (#16474 by @sosukesuzuki)

Adds support for Angular v18 @let declaration syntax.

Please see the following code example. The @let declaration allows you to define local variables within the template:

@&#8203;let name = 'Frodo';

<h1>Dashboard for {{name}}</h1>
Hello, {{name}}

For more details, please refer to the excellent blog post by the Angular Team: Introducing @let in Angular.

We also appreciate the Angular Team for kindly answering our questions to implement this feature.

`v3.3.2`

Fix handlebars path expressions starts with `@` (#16358 by @Princeyadav05)

{{! Input }}
<div>{{@&#8203;x.y.z}}</div>

{{! Prettier 3.3.1 }}
<div>{{@&#8203;x}}</div>

{{! Prettier 3.3.2 }}
<div>{{@&#8203;x.y.z}}</div>

`v3.3.1`

Preserve empty lines in front matter (#16347 by @fisker)

<!-- Input -->
---
foo:
  - bar1

  - bar2

  - bar3
---
Markdown

<!-- Prettier 3.3.0 -->

---
foo:
  - bar1
  - bar2
  - bar3
---

Markdown

<!-- Prettier 3.3.1 -->
---
foo:
  - bar1

  - bar2

  - bar3
---

Markdown

Preserve explicit language in front matter (#16348 by @fisker)

<!-- Input -->
---yaml
title: Hello
slug: home
---

<!-- Prettier 3.3.0 -->
---
title: Hello
slug: home
---

<!-- Prettier 3.3.1 -->
---yaml
title: Hello
slug: home
---

Avoid line breaks in import attributes (#16349 by @fisker)

// Input
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type: "json" };

// Prettier 3.3.0
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type:
  "json" };

// Prettier 3.3.1
import something from "./some-very-very-very-very-very-very-very-very-long-path.json" with { type: "json" };

`v3.3.0`

`v3.2.5`

Support Angular inline styles as single template literal (#15968 by @sosukesuzuki)

Angular v17 supports single string inline styles.

// Input
@&#8203;Component({
  template: `<div>...</div>`,
  styles: `h1 { color: blue; }`,
})
export class AppComponent {}

// Prettier 3.2.4
@&#8203;Component({
  template: `<div>...</div>`,
  styles: `h1 { color: blue; }`,
})
export class AppComponent {}

// Prettier 3.2.5
@&#8203;Component({
  template: `<div>...</div>`,
  styles: `
    h1 {
      color: blue;
    }
  `,
})
export class AppComponent {}

Unexpected embedded formatting for Angular template (#15969 by @JounQin)

Computed template should not be considered as Angular component template

// Input
const template = "foobar";

@&#8203;Component({
  [template]: `<h1>{{       hello }}</h1>`,
})
export class AppComponent {}

// Prettier 3.2.4
const template = "foobar";

@&#8203;Component({
  [template]: `<h1>{{ hello }}</h1>`,
})
export class AppComponent {}

// Prettier 3.2.5
const template = "foobar";

@&#8203;Component({
  [template]: `<h1>{{       hello }}</h1>`,
})
export class AppComponent {}

Use `"json"` parser for `tsconfig.json` by default (#16012 by @sosukesuzuki)

In v3.2.0, we introduced "jsonc" parser which adds trailing comma by default.

When adding a new parser we also define how it will be used based on the linguist-languages data.

tsconfig.json is a special file used by TypeScript, it uses .json file extension, but it actually uses the JSON with Comments syntax. However, we found that there are many third-party tools not recognize it correctly because of the confusing .json file extension.

We decide to treat it as a JSON file for now to avoid the extra configuration step.

To keep using the "jsonc" parser for your tsconfig.json files, add the following to your .prettierrc file

{
  "overrides": [
    {
      "files": ["tsconfig.json", "jsconfig.json"],
      "options": {
        "parser": "jsonc"
      }
    }
  ]
}


# Prettier 3.2.4
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "jsonc" }

# Prettier 3.2.5
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "json" }

`v3.2.4`

Fix incorrect parser inference (#15947 by @fisker)

Files like .eslintrc.json were incorrectly formatted as JSONC files.

// Input
prettier --file-info .eslintrc.json
{ "ignored": false, "inferredParser": "jsonc" }

// Prettier 3.2.4
prettier --file-info .eslintrc.json
{ "ignored": false, "inferredParser": "json" }

`v3.2.3`

Throw errors for invalid code (#15881 by @fisker, @Josh-Cena, @auvred)

// Input
1++;

// Prettier 3.2.2
1++;

// Prettier 3.2.3
SyntaxError: Invalid left-hand side expression in unary operation (1:1)
> 1 | 1++;
    | ^

// Input
try {} catch (error = 1){}

// Prettier 3.2.2
try {
} catch (error) {}

// Prettier 3.2.3
SyntaxError: Catch clause variable cannot have an initializer. (1:23)
> 1 | try {} catch (error = 1){}
    |                       ^

Fix parser inference (#15927 by @fisker)

// Prettier 3.2.2
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "json" }

// Prettier 3.2.3
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "jsonc" }

`v3.2.2`

Fix crash when parsing template literal CSS in a JSX style tag using a spread attribute (#15896 by @eelco)

For example this code would crash before:

<style {...spread}>{`.{}`}</style>

Fix formatting error on optional call expression and member chain (#15920 by @sosukesuzuki)

// Input
a(() => {}, c?.d());

// Prettier 3.2.1
TypeError: Cannot read properties of undefined (reading 'type')

// Prettier 3.2.2
a(() => {}, c?.d());

`v3.2.1`

Fix formatting error on member chain (#15915 by @sosukesuzuki)

// Input
test().test2().test2(thing?.something);

// Prettier 3.2.0
TypeError: Cannot read properties of undefined (reading 'type')

// Prettier 3.2.1
test().test2().test2(thing?.something);

`v3.2.0`

`v3.1.1`