prettier/prettier (prettier)
Compare Source
diff
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
Compare Source
diff
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.
Compare Source
diff
🔗 Release Notes
Compare Source
Compare Source
diff
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.
Compare Source
diff
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.
Compare Source
diff
🔗 Release Notes
Compare Source
diff
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 {
@​decorator
/**
* The method description
*
*/
async method(foo: Foo, bar: Bar) {
console.log(foo);
}
}
// Prettier 3.4.1
class A {
@​decorator
async /**
* The method description
*
*/
method(foo: Foo, bar: Bar) {
console.log(foo);
}
}
// Prettier 3.4.2
class A {
@​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>;
Compare Source
diff
Remove unnecessary parentheses around assignment in v-on
(#16887 by @fisker)
<!-- Input -->
<template>
<button @​click="foo += 2">Click</button>
</template>
<!-- Prettier 3.4.0 -->
<template>
<button @​click="(foo += 2)">Click</button>
</template>
<!-- Prettier 3.4.1 -->
<template>
<button @​click="foo += 2">Click</button>
</template>
Compare Source
diff
🔗 Release Notes
Compare Source
diff
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
@​(foo`tagged template`)
class X {}
// Prettier 3.3.2
@​foo`tagged template`
class X {}
// Prettier 3.3.3
@​(foo`tagged template`)
class X {}
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:
@​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.
Compare Source
diff
Fix handlebars path expressions starts with @
(#16358 by @Princeyadav05)
{{! Input }}
<div>{{@​x.y.z}}</div>
{{! Prettier 3.3.1 }}
<div>{{@​x}}</div>
{{! Prettier 3.3.2 }}
<div>{{@​x.y.z}}</div>
Compare Source
diff
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" };
Compare Source
diff
🔗 Release Notes
Compare Source
diff
Support Angular inline styles as single template literal (#15968 by @sosukesuzuki)
Angular v17 supports single string inline styles.
// Input
@​Component({
template: `<div>...</div>`,
styles: `h1 { color: blue; }`,
})
export class AppComponent {}
// Prettier 3.2.4
@​Component({
template: `<div>...</div>`,
styles: `h1 { color: blue; }`,
})
export class AppComponent {}
// Prettier 3.2.5
@​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";
@​Component({
[template]: `<h1>{{ hello }}</h1>`,
})
export class AppComponent {}
// Prettier 3.2.4
const template = "foobar";
@​Component({
[template]: `<h1>{{ hello }}</h1>`,
})
export class AppComponent {}
// Prettier 3.2.5
const template = "foobar";
@​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"
}
}
]
}
Compare Source
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "jsonc" }
Compare Source
diff
// 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){}
| ^
// 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" }
Compare Source
diff
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());
Compare Source
diff
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);
Compare Source
diff
🔗 Release Notes
Compare Source
diff
Previously, we start search for config files from the filePath as a directory, if it happened to be a directory and contains config file, it will be used by mistake.
├─ .prettierrc
└─ test.js (A directory)
└─ .prettierrc
// Prettier 3.1.0
await prettier.resolveConfigFile(new URL("./test.js", import.meta.url));
// <CWD>/test.js/.prettierrc
// Prettier 3.1.1
await prettier.resolveConfigFile(new URL("./test.js", import.meta.url));
// <CWD>/.prettierrc
Skip explicitly passed symbolic links with --no-error-on-unmatched-pattern
(#15533 by @sanmai-NL)
Since Prettier v3, we stopped following symbolic links, however in some use cases, the symbolic link patterns can't be filtered out, and there is no way to prevent Prettier from throwing errors.
In Prettier 3.1.1, you can use --no-error-on-unmatched-pattern
to simply skip symbolic links.
Consistently use tabs in ternaries when useTabs
is true
(#15662 by @auvred)
// Input
aaaaaaaaaaaaaaa
? bbbbbbbbbbbbbbbbbb
: ccccccccccccccc
? ddddddddddddddd
: eeeeeeeeeeeeeee
? fffffffffffffff
: gggggggggggggggg;
// Prettier 3.1.0
aaaaaaaaaaaaaaa
? bbbbbbbbbbbbbbbbbb
: ccccccccccccccc
? ddddddddddddddd
: eeeeeeeeeeeeeee
? fffffffffffffff
: gggggggggggggggg;
// Prettier 3.1.1
aaaaaaaaaaaaaaa
? bbbbbbbbbbbbbbbbbb
: ccccccccccccccc
? ddddddddddddddd
: eeeeeeeeeeeeeee
? fffffffffffffff
: gggggggggggggggg;
Improve config file search (#15663 by @fisker)
The Prettier config file search performance has been improved by more effective cache strategy.
Fix unstable and ugly formatting for comments in destructuring patterns (#15708 by @sosukesuzuki)
// Input
const {
foo,
// bar
// baz
}: Foo = expr;
// Prettier 3.1.0
const {
foo1,
} // bar
// baz
: Foo = expr;
// Prettier 3.1.0 second output
const {
foo1, // bar
} // baz
: Foo = expr;
// Prettier 3.1.1
const {
foo1,
// bar
// baz
}: Foo = expr;
Support "Import Attributes" (#15718 by @fisker)
TypeScript 5.3 supports the latest updates to the import attributes proposal.
import something from "./something.json" with { type: "json" };
Fix false claim in docs that cursorOffset is incompatible with rangeStart/rangeEnd (#15750 by @ExplodingCabbage)
The cursorOffset option has in fact been compatible with rangeStart/rangeEnd for over 5 years, thanks to work by @ds300. However, Prettier's documentation (including the CLI --help
text) continued to claim otherwise, falsely. The documentation is now fixed.
Keep curly braces and from
keyword in empty import
statements (#15756 by @fisker)
// Input
import { } from 'foo';
import { /* comment */ } from 'bar';
// Prettier 3.1.0
import {} from "foo";
import /* comment */ "bar";
// Prettier 3.1.1
import {} from "foo";
import {} from /* comment */ "bar";
Keep empty import attributes and assertions (#15757 by @fisker)
// Input
import foo from "foo" with {};
import bar from "bar" assert {};
// Prettier 3.1.0
import foo from "foo";
import bar from "bar";
// Prettier 3.1.1
import foo from "foo" with {};
import bar from "bar" assert {};
Compare Source
diff
🔗 Release Notes
Compare Source
diff
Add preferUnplugged: true
to package.json
(#15169 by @fisker and @so1ve)
Prettier v3 uses dynamic imports, user will need to unplug Prettier when Yarn's PnP mode is enabled, add preferUnplugged: true
to package.json
, so Yarn will install Prettier as unplug by default.
Support shared config that forbids require()
(#15233 by @fisker)
If an external shared config package is used, and the package exports
don't have require
or default
export.
In Prettier 3.0.2 Prettier fails when attempt to require()
the package, and throws an error.
Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: No "exports" main defined in <packageName>/package.json
Allow argument of require()
to break (#15256 by @fisker)
// Input
const plugin = require(
global.STANDALONE
? path.join(__dirname, "../standalone.js")
: path.join(__dirname, "..")
);
// Prettier 3.0.2
const plugin = require(global.STANDALONE
? path.join(__dirname, "../standalone.js")
: path.join(__dirname, ".."));
// Prettier 3.0.3
const plugin = require(
global.STANDALONE
? path.join(__dirname, "../standalone.js")
: path.join(__dirname, "..")
);
Do not print trailing commas in arrow function type parameter lists in ts
code blocks (#15286 by @sosukesuzuki)
<!-- Input -->
```ts
const foo = <T>() => {}
```
<!-- Prettier 3.0.2 -->
```ts
const foo = <T,>() => {}
```
<!-- Prettier 3.0.3 -->
```ts
const foo = <T>() => {}
```
Support TypeScript 5.2 using
/ await using
declaration (#15321 by @sosukesuzuki)
Support for the upcoming Explicit Resource Management feature in ECMAScript. using
/ await using
declaration
{
using foo = new Foo();
await using bar = new Bar();
}
Compare Source
diff
Break after =
of assignment if RHS is poorly breakable AwaitExpression or YieldExpression (#15204 by @seiyab)
// Input
const { section, rubric, authors, tags } = await utils.upsertCommonData(mainData);
// Prettier 3.0.1
const { section, rubric, authors, tags } = await utils.upsertCommonData(
mainData,
);
// Prettier 3.0.2
const { section, rubric, authors, tags } =
await utils.upsertCommonData(mainData);
Do not add trailing comma for grouped scss comments (#15217 by @auvred)
/* Input */
$foo: (
'property': (),
// comment 1
// comment 2
)
/* Prettier 3.0.1 */
$foo: (
"property": (),
// comment 1
// comment 2,
);
/* Prettier 3.0.2 */
$foo: (
"property": (),
// comment 1
// comment 2
);
Print declare
and export
keywords for nested namespace (#15249 by @sosukesuzuki)
// Input
declare namespace abc1.def {}
export namespace abc2.def {}
// Prettier 3.0.1
namespace abc1.def {}
namespace abc2.def {}
// Prettier 3.0.2
declare namespace abc1.def {}
export namespace abc2.def {}
Compare Source
diff
Fix cursor positioning for a special case (#14812 by @fisker)
// <|> is the cursor position
/* Input */
// All messages are represented in JSON.
// So, the prettier.py controls a subprocess which spawns "node {this_file}".
import {<|> } from "fs"
/* Prettier 3.0.0 */
// All messages are represented in JSON.
// So, the prettier.py <|>controls a subprocess which spawns "node {this_file}".
import {} from "fs"
/* Prettier 3.0.1 */
// All messages are represented in JSON.
// So, the prettier.py controls a subprocess which spawns "node {this_file}".
import {<|>} from "fs"
Fix plugins/estree.d.ts to make it a module (#15018 by @kingyue737)
Add export {}
in plugins/estree.d.ts
to fix the "File is not a module" error
Add parenthesis around leading multiline comment in return statement (#15037 by @auvred)
// Input
function fn() {
return (
/**
* @​type {...}
*/ expression
)
}
// Prettier 3.0.0
function fn() {
return /**
* @​type {...}
*/ expression;
}
// Prettier 3.0.1
function fn() {
return (
/**
* @​type {...}
*/ expression
);
}
Add support for Vue "Generic Components" (#15066 by @auvred)
https://blog.vuejs.org/posts/vue-3-3#generic-components
<!-- Input -->
<script setup lang="ts" generic="T extends Type1 & Type2 & (Type3 | Type4), U extends string | number | boolean"></script>
<!-- Prettier 3.0.0 -->
<script
setup
lang="ts"
generic="T extends Type1 & Type2 & (Type3 | Type4), U extends string | number | boolean"
></script>
<!-- Prettier 3.0.1 -->
<script
setup
lang="ts"
generic="
T extends Type1 & Type2 & (Type3 | Type4),
U extends string | number | boolean
"
></script>
Fix comments print in IfStatement
(#15076 by @fisker)
function a(b) {
if (b) return 1; // comment
else return 2;
}
/* Prettier 3.0.0 */
Error: Comment "comment" was not printed. Please report this error!
/* Prettier 3.0.1 */
function a(b) {
if (b) return 1; // comment
else return 2;
}
Add missing type definition for printer.preprocess
(#15123 by @so1ve)
export interface Printer<T = any> {
// ...
+ preprocess?:
+ | ((ast: T, options: ParserOptions<T>) => T | Promise<T>)
+ | undefined;
}
Add missing getVisitorKeys
method type definition for Printer
(#15125 by @auvred)
const printer: Printer = {
print: () => [],
getVisitorKeys(node, nonTraversableKeys) {
return ["body"];
},
};
Add typing to support readonly
array properties of AST Node (#15127 by @auvred)
// Input
interface TestNode {
readonlyArray: readonly string[];
}
declare const path: AstPath<TestNode>;
path.map(() => "", "readonlyArray");
// Prettier 3.0.0
interface TestNode {
readonlyArray: readonly string[];
}
declare const path: AstPath<TestNode>;
path.map(() => "", "readonlyArray");
// ^ Argument of type '"readonlyArray"' is not assignable to parameter of type '"regularArray"'. ts(2345)
// Prettier 3.0.1
interface TestNode {
readonlyArray: readonly string[];
}
declare const path: AstPath<TestNode>;
path.map(() => "", "readonlyArray");
Add space before unary minus followed by a function call (#15129 by @pamelalozano)
// Input
div {
margin: - func();
}
// Prettier 3.0.0
div {
margin: -func();
}
// Prettier 3.0.1
div {
margin: - func();
}
Compare Source
diff
🔗 Release Notes
Compare Source
This version is a republished version of v2.8.7.
A bad version was accidentally published and it can't be unpublished, apologies for the churn.
Compare Source
diff
Allow multiple decorators on same getter/setter (#14584 by @fisker)
// Input
class A {
@​decorator()
get foo () {}
@​decorator()
set foo (value) {}
}
// Prettier 2.8.6
SyntaxError: Decorators cannot be applied to multiple get/set accessors of the same name. (5:3)
3 | get foo () {}
4 |
> 5 | @​decorator()
| ^^^^^^^^^^^^
6 | set foo (value) {}
7 | }
// Prettier 2.8.7
class A {
@​decorator()
get foo() {}
@​decorator()
set foo(value) {}
}
Compare Source
diff
Allow decorators on private members and class expressions (#14548 by @fisker)
// Input
class A {
@​decorator()
#privateMethod () {}
}
// Prettier 2.8.5
SyntaxError: Decorators are not valid here. (2:3)
1 | class A {
> 2 | @​decorator()
| ^^^^^^^^^^^^
3 | #privateMethod () {}
4 | }
// Prettier 2.8.6
class A {
@​decorator()
#privateMethod() {}
}
Compare Source
diff
TypeScript 5.0 introduces two new syntactic features:
const
modifiers for type parameters
export type *
declarations
Add missing parentheses for decorator (#14393 by @fisker)
// Input
class Person {
@​(myDecoratorArray[0])
greet() {}
}
// Prettier 2.8.4
class Person {
@​myDecoratorArray[0]
greet() {}
}
// Prettier 2.8.5
class Person {
@​(myDecoratorArray[0])
greet() {}
}
Add parentheses for TypeofTypeAnnotation
to improve readability (#14458 by @fisker)
// Input
type A = (typeof node.children)[];
// Prettier 2.8.4
type A = typeof node.children[];
// Prettier 2.8.5
type A = (typeof node.children)[];
Support max_line_length=off
when parsing .editorconfig
(#14516 by @josephfrazier)
If an .editorconfig file is in your project and it sets max_line_length=off
for the file you're formatting,
it will be interpreted as a printWidth
of Infinity
rather than being ignored
(which previously resulted in the default printWidth
of 80 being applied, if not overridden by Prettier-specific configuration).
<!-- Input -->
<div className='HelloWorld' title={`You are visitor number ${ num }`} onMouseOver={onMouseOver}/>
<!-- Prettier 2.8.4 -->
<div
className="HelloWorld"
title={`You are visitor number ${num}`}
onMouseOver={onMouseOver}
/>;
<!-- Prettier 2.8.5 -->
<div className="HelloWorld" title={`You are visitor number ${num}`} onMouseOver={onMouseOver} />;
Compare Source
diff
Fix leading comments in mapped types with readonly
(#13427 by @thorn0, @sosukesuzuki)
// Input
type Type = {
// comment
readonly [key in Foo];
};
// Prettier 2.8.3
type Type = {
readonly // comment
[key in Foo];
};
// Prettier 2.8.4
type Type = {
// comment
readonly [key in Foo];
};
Group params in opening block statements (#14067 by @jamescdavis)
This is a follow-up to #13930 to establish wrapping consistency between opening block statements and else blocks by
grouping params in opening blocks. This causes params to break to a new line together and not be split across lines
unless the length of params exceeds the print width. This also updates the else block wrapping to behave exactly the
same as opening blocks.
{{! Input }}
{{#block param param param param param param param param param param as |blockParam|}}
Hello
{{else block param param param param param param param param param param as |blockParam|}}
There
{{/block}}
{{! Prettier 2.8.3 }}
{{#block
param
param
param
param
param
param
param
param
param
param
as |blockParam|
}}
Hello
{{else block param
param
param
param
param
param
param
param
param
param}}
There
{{/block}}
{{! Prettier 2.8.4 }}
{{#block
param param param param param param param param param param
as |blockParam|
}}
Hello
{{else block
param param param param param param param param param param
as |blockParam|
}}
There
{{/block}}
In Sapling SCM, .sl/
is the folder where it stores its state, analogous to .git/
in Git. It should be ignored in Prettier like the other SCM folders.
Recognize @satisfies
in Closure-style type casts (#14262 by @fisker)
// Input
const a = /** @​satisfies {Record<string, string>} */ ({hello: 1337});
const b = /** @​type {Record<string, string>} */ ({hello: 1337});
// Prettier 2.8.3
const a = /** @​satisfies {Record<string, string>} */ { hello: 1337 };
const b = /** @​type {Record<string, string>} */ ({ hello: 1337 });
// Prettier 2.8.4
const a = /** @​satisfies {Record<string, string>} */ ({hello: 1337});
const b = /** @​type {Record<string, string>} */ ({hello: 1337});
Fix parens in inferred function return types with extends
(#14279 by @fisker)
// Input
type Foo<T> = T extends ((a) => a is infer R extends string) ? R : never;
// Prettier 2.8.3 (First format)
type Foo<T> = T extends (a) => a is infer R extends string ? R : never;
// Prettier 2.8.3 (Second format)
SyntaxError: '?' expected.
// Prettier 2.8.4
type Foo<T> = T extends ((a) => a is infer R extends string) ? R : never;
Compare Source
diff
Allow self-closing tags on custom elements (#14170 by @fisker)
See Angular v15.1.0 release note for details.
// Input
<app-test/>
// Prettier 2.8.2
SyntaxError: Only void and foreign elements can be self closed "app-test" (1:1)
> 1 | <app-test/>
| ^^^^^^^^^
2 |
// Prettier 2.8.3
<app-test />
Compare Source
diff
<!-- Input -->
We now don't strictly follow the release notes format suggested by [Keep a Changelog].
[Keep a Changelog]: https://example.com/
<!-- Prettier 2.8.1 -->
We now don't strictly follow the release notes format suggested by [Keep a Changelog].
[keep a changelog]: https://example.com/
<!--
^^^^^^^^^^^^^^^^^^ lowercased
-->
<!-- Prettier 2.8.2 -->
<Same as input>
{{! Input }}
<div />
<div></div>
<custom-component />
<custom-component></custom-component>
<i />
<i></i>
<Component />
<Component></Component>
{{! Prettier 2.8.1 }}
<div></div>
<div></div>
<custom-component></custom-component>
<custom-component></custom-component>
<i></i>
<i></i>
<Component />
<Component />
{{! Prettier 2.8.2 }}
<div />
<div></div>
<custom-component />
<custom-component></custom-component>
<i />
<i></i>
<Component />
<Component />
Allow custom "else if"-like blocks with block params (#13930 by @jamescdavis)
#13507 added support for custom block keywords used with else
, but failed to allow block params. This updates printer-glimmer to allow block params with custom "else if"-like blocks.
{{! Input }}
{{#when isAtWork as |work|}}
Ship that
{{work}}!
{{else when isReading as |book|}}
You can finish
{{book}}
eventually...
{{else}}
Go to bed!
{{/when}}
{{! Prettier 2.8.1 }}
{{#when isAtWork as |work|}}
Ship that
{{work}}!
{{else when isReading}}
You can finish
{{book}}
eventually...
{{else}}
Go to bed!
{{/when}}
{{! Prettier 2.8.2 }}
{{#when isAtWork as |work|}}
Ship that
{{work}}!
{{else when isReading as |book|}}
You can finish
{{book}}
eventually...
{{else}}
Go to bed!
{{/when}}
Preserve empty lines between nested SCSS maps (#13931 by @jneander)
/* Input */
$map: (
'one': (
'key': 'value',
),
'two': (
'key': 'value',
),
)
/* Prettier 2.8.1 */
$map: (
'one': (
'key': 'value',
),
'two': (
'key': 'value',
),
)
/* Prettier 2.8.2 */
$map: (
'one': (
'key': 'value',
),
'two': (
'key': 'value',
),
)
Fix missing parentheses when an expression statement starts with let[
(#14000, #14044 by @fisker, @thorn0)
// Input
(let[0] = 2);
// Prettier 2.8.1
let[0] = 2;
// Prettier 2.8.1 (second format)
SyntaxError: Unexpected token (1:5)
> 1 | let[0] = 2;
| ^
2 |
// Prettier 2.8.2
(let)[0] = 2;
Fix semicolon duplicated at the end of LESS file (#14007 by @mvorisek)
// Input
@​variable: {
field: something;
};
// Prettier 2.8.1
@​variable: {
field: something;
}; ;
// Prettier 2.8.2
@​variable: {
field: something;
};
Fix no space after unary minus when followed by opening parenthesis in LESS (#14008 by @mvorisek)
// Input
.unary_minus_single {
margin: -(@​a);
}
.unary_minus_multi {
margin: 0 -(@​a);
}
.binary_minus {
margin: 0 - (@​a);
}
// Prettier 2.8.1
.unary_minus_single {
margin: - (@​a);
}
.unary_minus_multi {
margin: 0 - (@​a);
}
.binary_minus {
margin: 0 - (@​a);
}
// Prettier 2.8.2
.unary_minus_single {
margin: -(@​a);
}
.unary_minus_multi {
margin: 0 -(@​a);
}
.binary_minus {
margin: 0 - (@​a);
}
Do not change case of property name if inside a variable declaration in LESS (#14034 by @mvorisek)
// Input
@​var: {
preserveCase: 0;
};
// Prettier 2.8.1
@​var: {
preservecase: 0;
};
// Prettier 2.8.2
@​var: {
preserveCase: 0;
};
Fix formatting for auto-accessors with comments (#14038 by @fisker)
// Input
class A {
@​dec()
// comment
accessor b;
}
// Prettier 2.8.1
class A {
@​dec()
accessor // comment
b;
}
// Prettier 2.8.1 (second format)
class A {
@​dec()
accessor; // comment
b;
}
// Prettier 2.8.2
class A {
@​dec()
// comment
accessor b;
}
Add parentheses for TSTypeQuery to improve readability (#14042 by @onishi-kohei)
// Input
a as (typeof node.children)[number]
a as (typeof node.children)[]
a as ((typeof node.children)[number])[]
// Prettier 2.8.1
a as typeof node.children[number];
a as typeof node.children[];
a as typeof node.children[number][];
// Prettier 2.8.2
a as (typeof node.children)[number];
a as (typeof node.children)[];
a as (typeof node.children)[number][];
Fix displacing of comments in default switch case (#14047 by @thorn0)
It was a regression in Prettier 2.6.0.
// Input
switch (state) {
default:
result = state; // no change
break;
}
// Prettier 2.8.1
switch (state) {
default: // no change
result = state;
break;
}
// Prettier 2.8.2
switch (state) {
default:
result = state; // no change
break;
}
Support type annotations on auto accessors via babel-ts
(#14049 by @sosukesuzuki)
The bug that @babel/parser
cannot parse auto accessors with type annotations has been fixed. So we now support it via babel-ts
parser.
class Foo {
accessor prop: number;
}
Fix formatting of empty type parameters (#14073 by @fisker)
// Input
const foo: bar</* comment */> = () => baz;
// Prettier 2.8.1
Error: Comment "comment" was not printed. Please report this error!
// Prettier 2.8.2
const foo: bar</* comment */> = () => baz;
Add parentheses to head of ExpressionStatement
instead of the whole statement (#14077 by @fisker)
// Input
({}).toString.call(foo) === "[object Array]"
? foo.forEach(iterateArray)
: iterateObject(foo);
// Prettier 2.8.1
({}.toString.call(foo) === "[object Array]"
? foo.forEach(iterateArray)
: iterateObject(foo));
// Prettier 2.8.2
({}).toString.call(foo.forEach) === "[object Array]"
? foo.forEach(iterateArray)
: iterateObject(foo);
Fix comments after directive (#14081 by @fisker)
// Input
"use strict" /* comment */;
// Prettier 2.8.1 (with other js parsers except `babel`)
Error: Comment "comment" was not printed. Please report this error!
// Prettier 2.8.2
<Same as input>
Fix formatting for comments inside JSX attribute (#14082 by @fisker)
// Input
function MyFunctionComponent() {
<button label=/*old*/"new">button</button>
}
// Prettier 2.8.1
Error: Comment "old" was not printed. Please report this error!
// Prettier 2.8.2
function MyFunctionComponent() {
<button label=/*old*/ "new">button</button>;
}
Quote numeric keys for json-stringify parser (#14083 by @fisker)
// Input
{0: 'value'}
// Prettier 2.8.1
{
0: "value"
}
// Prettier 2.8.2
{
"0": "value"
}
Fix removing commas from function arguments in maps (#14089 by @sosukesuzuki)
/* Input */
$foo: map-fn(
(
"#{prop}": inner-fn($first, $second),
)
);
/* Prettier 2.8.1 */
$foo: map-fn(("#{prop}": inner-fn($first $second)));
/* Prettier 2.8.2 */
$foo: map-fn(
(
"#{prop}": inner-fn($first, $second),
)
);
Do not insert space in LESS property access (#14103 by @fisker)
// Input
a {
color: @​colors[@​white];
}
// Prettier 2.8.1
a {
color: @​colors[ @​white];
}
// Prettier 2.8.2
<Same as input>
Compare Source
diff
// Input
$display-breakpoints: map-deep-merge(
(
"print-only": "only print",
"screen-only": "only screen",
"xs-only": "only screen and (max-width: #{map-get($grid-breakpoints, "sm")-1})",
),
$display-breakpoints
);
// Prettier 2.8.0
$display-breakpoints: map-deep-merge(
(
"print-only": "only print",
"screen-only": "only screen",
"xs-only": "only screen and (max-width: #{map-get($grid-breakpoints, " sm
")-1})",
),
$display-breakpoints
);
// Prettier 2.8.1
$display-breakpoints: map-deep-merge(
(
"print-only": "only print",
"screen-only": "only screen",
"xs-only": "only screen and (max-width: #{map-get($grid-breakpoints, "sm")-1})",
),
</details>
---
### Configuration
📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM, only on Monday ( * 0-3 * * 1 ) (UTC), Automerge - At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box
---
This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/react-bootstrap/code-sandbox-examples).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS41OC4xIiwidXBkYXRlZEluVmVyIjoiNDEuOTEuMSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6WyJyZW5vdmF0ZWJvdCJdfQ==-->
Uh oh!
There was an error while loading. Please reload this page.
This PR contains the following updates:
^2.7.1
->^3.6.2
Release Notes
prettier/prettier (prettier)
v3.6.2
Compare Source
diff
Markdown: Add missing blank line around code block (#17675 by @fisker)
v3.6.1
Compare Source
diff
TypeScript: Allow const without initializer (#17650, #17654 by @fisker)
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 closethem.
v3.6.0
Compare Source
diff
🔗 Release Notes
v3.5.3
Compare Source
v3.5.2
Compare Source
diff
Remove
module-sync
condition (#17156 by @fisker)In Prettier 3.5.0, we added
module-sync
condition topackage.json
, so thatrequire("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 themodule-sync
condition, sorequire("prettier")
will still use the CommonJS version, we'll revisit untilrequire(ESM)
feature is more stable.v3.5.1
Compare Source
diff
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
andgithub-actions-workflow
languages in Visual Studio Code.v3.5.0
Compare Source
diff
🔗 Release Notes
v3.4.2
Compare Source
diff
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.
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)
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.
v3.4.1
Compare Source
diff
Remove unnecessary parentheses around assignment in
v-on
(#16887 by @fisker)v3.4.0
Compare Source
diff
🔗 Release Notes
v3.3.3
Compare Source
diff
Add parentheses for nullish coalescing in ternary (#16391 by @cdignam-segment)
This change adds clarity to operator precedence.
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.
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: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
Compare Source
diff
Fix handlebars path expressions starts with
@
(#16358 by @Princeyadav05)v3.3.1
Compare Source
diff
Preserve empty lines in front matter (#16347 by @fisker)
Preserve explicit language in front matter (#16348 by @fisker)
Avoid line breaks in import attributes (#16349 by @fisker)
v3.3.0
Compare Source
diff
🔗 Release Notes
v3.2.5
Compare Source
diff
Support Angular inline styles as single template literal (#15968 by @sosukesuzuki)
Angular v17 supports single string inline styles.
Unexpected embedded formatting for Angular template (#15969 by @JounQin)
Computed template should not be considered as Angular component template
Use
"json"
parser fortsconfig.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 yourtsconfig.json
files, add the following to your.prettierrc
filev3.2.4
Compare Source
prettier --file-info tsconfig.json
{ "ignored": false, "inferredParser": "jsonc" }
v3.2.3
Compare Source
diff
Throw errors for invalid code (#15881 by @fisker, @Josh-Cena, @auvred)
Fix parser inference (#15927 by @fisker)
v3.2.2
Compare Source
diff
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:
Fix formatting error on optional call expression and member chain (#15920 by @sosukesuzuki)
v3.2.1
Compare Source
diff
Fix formatting error on member chain (#15915 by @sosukesuzuki)
v3.2.0
Compare Source
diff
🔗 Release Notes
v3.1.1
Compare Source
diff
Fix config file search (#15363 by @fisker)
Previously, we start search for config files from the filePath as a directory, if it happened to be a directory and contains config file, it will be used by mistake.
Skip explicitly passed symbolic links with
--no-error-on-unmatched-pattern
(#15533 by @sanmai-NL)Since Prettier v3, we stopped following symbolic links, however in some use cases, the symbolic link patterns can't be filtered out, and there is no way to prevent Prettier from throwing errors.
In Prettier 3.1.1, you can use
--no-error-on-unmatched-pattern
to simply skip symbolic links.Consistently use tabs in ternaries when
useTabs
istrue
(#15662 by @auvred)Improve config file search (#15663 by @fisker)
The Prettier config file search performance has been improved by more effective cache strategy.
Fix unstable and ugly formatting for comments in destructuring patterns (#15708 by @sosukesuzuki)
Support "Import Attributes" (#15718 by @fisker)
TypeScript 5.3 supports the latest updates to the import attributes proposal.
Fix false claim in docs that cursorOffset is incompatible with rangeStart/rangeEnd (#15750 by @ExplodingCabbage)
The cursorOffset option has in fact been compatible with rangeStart/rangeEnd for over 5 years, thanks to work by @ds300. However, Prettier's documentation (including the CLI
--help
text) continued to claim otherwise, falsely. The documentation is now fixed.Keep curly braces and
from
keyword in emptyimport
statements (#15756 by @fisker)Keep empty import attributes and assertions (#15757 by @fisker)
v3.1.0
Compare Source
diff
🔗 Release Notes
v3.0.3
Compare Source
diff
Add
preferUnplugged: true
topackage.json
(#15169 by @fisker and @so1ve)Prettier v3 uses dynamic imports, user will need to unplug Prettier when Yarn's PnP mode is enabled, add
preferUnplugged: true
topackage.json
, so Yarn will install Prettier as unplug by default.Support shared config that forbids
require()
(#15233 by @fisker)If an external shared config package is used, and the package
exports
don't haverequire
ordefault
export.In Prettier 3.0.2 Prettier fails when attempt to
require()
the package, and throws an error.Allow argument of
require()
to break (#15256 by @fisker)Do not print trailing commas in arrow function type parameter lists in
ts
code blocks (#15286 by @sosukesuzuki)Support TypeScript 5.2
using
/await using
declaration (#15321 by @sosukesuzuki)Support for the upcoming Explicit Resource Management feature in ECMAScript.
using
/await using
declarationv3.0.2
Compare Source
diff
Break after
=
of assignment if RHS is poorly breakable AwaitExpression or YieldExpression (#15204 by @seiyab)Do not add trailing comma for grouped scss comments (#15217 by @auvred)
Print
declare
andexport
keywords for nested namespace (#15249 by @sosukesuzuki)v3.0.1
Compare Source
diff
Fix cursor positioning for a special case (#14812 by @fisker)
Fix plugins/estree.d.ts to make it a module (#15018 by @kingyue737)
Add
export {}
inplugins/estree.d.ts
to fix the "File is not a module" errorAdd parenthesis around leading multiline comment in return statement (#15037 by @auvred)
Add support for Vue "Generic Components" (#15066 by @auvred)
https://blog.vuejs.org/posts/vue-3-3#generic-components
Fix comments print in
IfStatement
(#15076 by @fisker)Add missing type definition for
printer.preprocess
(#15123 by @so1ve)Add missing
getVisitorKeys
method type definition forPrinter
(#15125 by @auvred)Add typing to support
readonly
array properties of AST Node (#15127 by @auvred)Add space before unary minus followed by a function call (#15129 by @pamelalozano)
v3.0.0
Compare Source
diff
🔗 Release Notes
v2.8.8
Compare Source
This version is a republished version of v2.8.7.
A bad version was accidentally published and it can't be unpublished, apologies for the churn.
v2.8.7
Compare Source
diff
Allow multiple decorators on same getter/setter (#14584 by @fisker)
v2.8.6
Compare Source
diff
Allow decorators on private members and class expressions (#14548 by @fisker)
v2.8.5
Compare Source
diff
Support TypeScript 5.0 (#14391 by @fisker, #13819 by @fisker, @sosukesuzuki)
TypeScript 5.0 introduces two new syntactic features:
const
modifiers for type parametersexport type *
declarationsAdd missing parentheses for decorator (#14393 by @fisker)
Add parentheses for
TypeofTypeAnnotation
to improve readability (#14458 by @fisker)Support
max_line_length=off
when parsing.editorconfig
(#14516 by @josephfrazier)If an .editorconfig file is in your project and it sets
max_line_length=off
for the file you're formatting,it will be interpreted as a
printWidth
ofInfinity
rather than being ignored(which previously resulted in the default
printWidth
of 80 being applied, if not overridden by Prettier-specific configuration).v2.8.4
Compare Source
diff
Fix leading comments in mapped types with
readonly
(#13427 by @thorn0, @sosukesuzuki)Group params in opening block statements (#14067 by @jamescdavis)
This is a follow-up to #13930 to establish wrapping consistency between opening block statements and else blocks by
grouping params in opening blocks. This causes params to break to a new line together and not be split across lines
unless the length of params exceeds the print width. This also updates the else block wrapping to behave exactly the
same as opening blocks.
Ignore files in
.sl/
(#14206 by @bolinfest)In Sapling SCM,
.sl/
is the folder where it stores its state, analogous to.git/
in Git. It should be ignored in Prettier like the other SCM folders.Recognize
@satisfies
in Closure-style type casts (#14262 by @fisker)Fix parens in inferred function return types with
extends
(#14279 by @fisker)v2.8.3
Compare Source
diff
Allow self-closing tags on custom elements (#14170 by @fisker)
See Angular v15.1.0 release note for details.
v2.8.2
Compare Source
diff
Don't lowercase link references (#13155 by @DerekNonGeneric & @fisker)
Preserve self-closing tags (#13691 by @dcyriller)
Allow custom "else if"-like blocks with block params (#13930 by @jamescdavis)
#13507 added support for custom block keywords used with
else
, but failed to allow block params. This updates printer-glimmer to allow block params with custom "else if"-like blocks.Preserve empty lines between nested SCSS maps (#13931 by @jneander)
Fix missing parentheses when an expression statement starts with
let[
(#14000, #14044 by @fisker, @thorn0)Fix semicolon duplicated at the end of LESS file (#14007 by @mvorisek)
Fix no space after unary minus when followed by opening parenthesis in LESS (#14008 by @mvorisek)
Do not change case of property name if inside a variable declaration in LESS (#14034 by @mvorisek)
Fix formatting for auto-accessors with comments (#14038 by @fisker)
Add parentheses for TSTypeQuery to improve readability (#14042 by @onishi-kohei)
Fix displacing of comments in default switch case (#14047 by @thorn0)
It was a regression in Prettier 2.6.0.
Support type annotations on auto accessors via
babel-ts
(#14049 by @sosukesuzuki)The bug that
@babel/parser
cannot parse auto accessors with type annotations has been fixed. So we now support it viababel-ts
parser.Fix formatting of empty type parameters (#14073 by @fisker)
Add parentheses to head of
ExpressionStatement
instead of the whole statement (#14077 by @fisker)Fix comments after directive (#14081 by @fisker)
Fix formatting for comments inside JSX attribute (#14082 by @fisker)
Quote numeric keys for json-stringify parser (#14083 by @fisker)
Fix removing commas from function arguments in maps (#14089 by @sosukesuzuki)
Do not insert space in LESS property access (#14103 by @fisker)
v2.8.1
Compare Source
diff
Fix SCSS map in arguments (#9184 by @agamkrbit)