Release 3.0.1
This commit is contained in:
Sosuke Suzuki committed
1 parent
c3d53dce7e
commit
afee0db664
7 files changed
+217
-36
No files matched your search
@@ -26,7 +26,7 @@ Don't fill the form below manually! Let a program create a report for you:
|
||||
|
||||
-->
|
||||
|
||||
**Prettier 3.0.0**
|
||||
**Prettier 3.0.1**
|
||||
[Playground link](https://prettier.io/playground/#.....)
|
||||
|
||||
```sh
|
||||
|
||||
@@ -20,7 +20,7 @@ BEFORE SUBMITTING AN ISSUE:
|
||||
|
||||
**Environments:**
|
||||
|
||||
- Prettier Version: 3.0.0
|
||||
- Prettier Version: 3.0.1
|
||||
- Running Prettier via: <!-- CLI, Node.js API, Browser API, etc. -->
|
||||
- Runtime: <!-- Node.js v14, Chrome v83, etc. -->
|
||||
- Operating System: <!-- Windows, Linux, macOS, etc. -->
|
||||
|
||||
+181
@@ -1,3 +1,184 @@
|
||||
# 3.0.1
|
||||
|
||||
[diff](https://github.com/prettier/prettier/compare/3.0.0...3.0.1)
|
||||
|
||||
#### Fix cursor positioning for a special case ([#14812](https://github.com/prettier/prettier/pull/14812) by [@fisker](https://github.com/fisker))
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```js
|
||||
// <|> 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](https://github.com/prettier/prettier/pull/15018) by [@kingyue737](https://github.com/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](https://github.com/prettier/prettier/pull/15037) by [@auvred](https://github.com/auvred))
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```jsx
|
||||
// Input
|
||||
function fn() {
|
||||
return (
|
||||
/**
|
||||
* @type {...}
|
||||
*/ expresssion
|
||||
)
|
||||
}
|
||||
|
||||
// Prettier 3.0.0
|
||||
function fn() {
|
||||
return /**
|
||||
* @type {...}
|
||||
*/ expresssion;
|
||||
}
|
||||
|
||||
// Prettier 3.0.1
|
||||
function fn() {
|
||||
return (
|
||||
/**
|
||||
* @type {...}
|
||||
*/ expresssion
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
#### Add support for Vue "Generic Components" ([#15066](https://github.com/prettier/prettier/pull/15066) by [@auvred](https://github.com/auvred))
|
||||
|
||||
https://blog.vuejs.org/posts/vue-3-3#generic-components
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```vue
|
||||
<!-- 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](https://github.com/prettier/prettier/pull/15076) by [@fisker](https://github.com/fisker))
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```js
|
||||
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](https://github.com/prettier/prettier/pull/15123) by [@so1ve](https://github.com/so1ve))
|
||||
|
||||
```diff
|
||||
export interface Printer<T = any> {
|
||||
// ...
|
||||
+ preprocess?:
|
||||
+ | ((ast: T, options: ParserOptions<T>) => T | Promise<T>)
|
||||
+ | undefined;
|
||||
}
|
||||
```
|
||||
|
||||
#### Add missing `getVisitorKeys` method type definition for `Printer` ([#15125](https://github.com/prettier/prettier/pull/15125) by [@auvred](https://github.com/auvred))
|
||||
|
||||
```tsx
|
||||
const printer: Printer = {
|
||||
print: () => [],
|
||||
getVisitorKeys(node, nonTraversableKeys) {
|
||||
return ["body"];
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
#### Add typing to support `readonly` array properties of AST Node ([#15127](https://github.com/prettier/prettier/pull/15127) by [@auvred](https://github.com/auvred))
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```tsx
|
||||
// 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](https://github.com/prettier/prettier/pull/15129) by [@pamelalozano](https://github.com/pamelalozano))
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```less
|
||||
// Input
|
||||
div {
|
||||
margin: - func();
|
||||
}
|
||||
|
||||
// Prettier 3.0.0
|
||||
div {
|
||||
margin: -func();
|
||||
}
|
||||
|
||||
// Prettier 3.0.1
|
||||
div {
|
||||
margin: - func();
|
||||
}
|
||||
```
|
||||
|
||||
# 3.0.0
|
||||
|
||||
[diff](https://github.com/prettier/prettier/compare/3.0.0-alpha.6...3.0.0)
|
||||
|
||||
+16
-16
@@ -18,7 +18,7 @@ Required options:
|
||||
|
||||
- **[`parser`](options.md#parser) (or [`filepath`](options.md#file-path))**: One of these options has to be specified for Prettier to know which parser to use.
|
||||
|
||||
- **`plugins`**: Unlike the `format` function from the [Node.js-based API](api.md#prettierformatsource--options), this function doesn’t load plugins automatically. The `plugins` option is required because all the parsers included in the Prettier package come as plugins (for reasons of file size). These plugins are files in <https://unpkg.com/browse/prettier@3.0.0/plugins/>. Note that `estree` plugin should be loaded when printing JavaScript, TypeScript, Flow, or JSON.
|
||||
- **`plugins`**: Unlike the `format` function from the [Node.js-based API](api.md#prettierformatsource--options), this function doesn’t load plugins automatically. The `plugins` option is required because all the parsers included in the Prettier package come as plugins (for reasons of file size). These plugins are files in <https://unpkg.com/browse/prettier@3.0.1/plugins/>. Note that `estree` plugin should be loaded when printing JavaScript, TypeScript, Flow, or JSON.
|
||||
|
||||
You need to load the ones that you’re going to use and pass them to `prettier.format` using the `plugins` option.
|
||||
|
||||
@@ -29,8 +29,8 @@ See below for examples.
|
||||
### Global
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/prettier@3.0.0/standalone.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.0/plugins/graphql.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.1/standalone.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.1/plugins/graphql.js"></script>
|
||||
<script>
|
||||
(async () => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
@@ -47,8 +47,8 @@ Note that the [`unpkg` field](https://unpkg.com/#examples) in Prettier’s `pack
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginGraphql from "https://unpkg.com/prettier@3.0.0/plugins/graphql.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginGraphql from "https://unpkg.com/prettier@3.0.1/plugins/graphql.mjs";
|
||||
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
parser: "graphql",
|
||||
@@ -61,8 +61,8 @@ Note that the [`unpkg` field](https://unpkg.com/#examples) in Prettier’s `pack
|
||||
|
||||
```js
|
||||
define([
|
||||
"https://unpkg.com/prettier@3.0.0/standalone.js",
|
||||
"https://unpkg.com/prettier@3.0.0/plugins/graphql.js",
|
||||
"https://unpkg.com/prettier@3.0.1/standalone.js",
|
||||
"https://unpkg.com/prettier@3.0.1/plugins/graphql.js",
|
||||
], async (prettier, ...plugins) => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
parser: "graphql",
|
||||
@@ -90,8 +90,8 @@ This syntax doesn’t necessarily work in the browser, but it can be used when b
|
||||
### Worker
|
||||
|
||||
```js
|
||||
importScripts("https://unpkg.com/prettier@3.0.0/standalone.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.0/plugins/graphql.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.1/standalone.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.1/plugins/graphql.js");
|
||||
|
||||
(async () => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
@@ -107,9 +107,9 @@ If you want to format [embedded code](options.md#embedded-language-formatting),
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.0/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.0/plugins/estree.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.1/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.1/plugins/estree.mjs";
|
||||
|
||||
console.log(
|
||||
await prettier.format("const html=/* HTML */ `<DIV> </DIV>`", {
|
||||
@@ -125,10 +125,10 @@ The HTML code embedded in JavaScript stays unformatted because the `html` parser
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.0/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.0/plugins/estree.mjs";
|
||||
import prettierPluginHtml from "https://unpkg.com/prettier@3.0.0/plugins/html.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.1/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.1/plugins/estree.mjs";
|
||||
import prettierPluginHtml from "https://unpkg.com/prettier@3.0.1/plugins/html.mjs";
|
||||
|
||||
console.log(
|
||||
await prettier.format("const html=/* HTML */ `<DIV> </DIV>`", {
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "prettier",
|
||||
"version": "3.1.0-dev",
|
||||
"version": "3.0.1",
|
||||
"description": "Prettier is an opinionated code formatter",
|
||||
"bin": "./bin/prettier.cjs",
|
||||
"repository": "prettier/prettier",
|
||||
|
||||
@@ -19,7 +19,7 @@ Required options:
|
||||
|
||||
- **[`parser`](options.md#parser) (or [`filepath`](options.md#file-path))**: One of these options has to be specified for Prettier to know which parser to use.
|
||||
|
||||
- **`plugins`**: Unlike the `format` function from the [Node.js-based API](api.md#prettierformatsource--options), this function doesn’t load plugins automatically. The `plugins` option is required because all the parsers included in the Prettier package come as plugins (for reasons of file size). These plugins are files in <https://unpkg.com/browse/prettier@3.0.0/plugins/>. Note that `estree` plugin should be loaded when printing JavaScript, TypeScript, Flow, or JSON.
|
||||
- **`plugins`**: Unlike the `format` function from the [Node.js-based API](api.md#prettierformatsource--options), this function doesn’t load plugins automatically. The `plugins` option is required because all the parsers included in the Prettier package come as plugins (for reasons of file size). These plugins are files in <https://unpkg.com/browse/prettier@3.0.1/plugins/>. Note that `estree` plugin should be loaded when printing JavaScript, TypeScript, Flow, or JSON.
|
||||
|
||||
You need to load the ones that you’re going to use and pass them to `prettier.format` using the `plugins` option.
|
||||
|
||||
@@ -30,8 +30,8 @@ See below for examples.
|
||||
### Global
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/prettier@3.0.0/standalone.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.0/plugins/graphql.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.1/standalone.js"></script>
|
||||
<script src="https://unpkg.com/prettier@3.0.1/plugins/graphql.js"></script>
|
||||
<script>
|
||||
(async () => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
@@ -48,8 +48,8 @@ Note that the [`unpkg` field](https://unpkg.com/#examples) in Prettier’s `pack
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginGraphql from "https://unpkg.com/prettier@3.0.0/plugins/graphql.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginGraphql from "https://unpkg.com/prettier@3.0.1/plugins/graphql.mjs";
|
||||
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
parser: "graphql",
|
||||
@@ -62,8 +62,8 @@ Note that the [`unpkg` field](https://unpkg.com/#examples) in Prettier’s `pack
|
||||
|
||||
```js
|
||||
define([
|
||||
"https://unpkg.com/prettier@3.0.0/standalone.js",
|
||||
"https://unpkg.com/prettier@3.0.0/plugins/graphql.js",
|
||||
"https://unpkg.com/prettier@3.0.1/standalone.js",
|
||||
"https://unpkg.com/prettier@3.0.1/plugins/graphql.js",
|
||||
], async (prettier, ...plugins) => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
parser: "graphql",
|
||||
@@ -91,8 +91,8 @@ This syntax doesn’t necessarily work in the browser, but it can be used when b
|
||||
### Worker
|
||||
|
||||
```js
|
||||
importScripts("https://unpkg.com/prettier@3.0.0/standalone.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.0/plugins/graphql.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.1/standalone.js");
|
||||
importScripts("https://unpkg.com/prettier@3.0.1/plugins/graphql.js");
|
||||
|
||||
(async () => {
|
||||
const formatted = await prettier.format("type Query { hello: String }", {
|
||||
@@ -108,9 +108,9 @@ If you want to format [embedded code](options.md#embedded-language-formatting),
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.0/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.0/plugins/estree.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.1/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.1/plugins/estree.mjs";
|
||||
|
||||
console.log(
|
||||
await prettier.format("const html=/* HTML */ `<DIV> </DIV>`", {
|
||||
@@ -126,10 +126,10 @@ The HTML code embedded in JavaScript stays unformatted because the `html` parser
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.0/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.0/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.0/plugins/estree.mjs";
|
||||
import prettierPluginHtml from "https://unpkg.com/prettier@3.0.0/plugins/html.mjs";
|
||||
import * as prettier from "https://unpkg.com/prettier@3.0.1/standalone.mjs";
|
||||
import prettierPluginBabel from "https://unpkg.com/prettier@3.0.1/plugins/babel.mjs";
|
||||
import prettierPluginEstree from "https://unpkg.com/prettier@3.0.1/plugins/estree.mjs";
|
||||
import prettierPluginHtml from "https://unpkg.com/prettier@3.0.1/plugins/html.mjs";
|
||||
|
||||
console.log(
|
||||
await prettier.format("const html=/* HTML */ `<DIV> </DIV>`", {
|
||||
|
||||
@@ -115,7 +115,7 @@ If you don’t have a configuration file, or want to ignore it if it does exist,
|
||||
|
||||
## `--ignore-path`
|
||||
|
||||
Path to a file containing patterns that describe files to ignore. By default, Prettier looks for `./.prettierignore`.\
|
||||
Path to a file containing patterns that describe files to ignore. By default, Prettier looks for `./.gitignore` and `./.prettierignore`.\
|
||||
Multiple values are accepted.
|
||||
|
||||
## `--list-different`
|
||||
|
||||
Reference in new issue
Block a user