Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix to add parentheses for TSTypeQuery in some case #14042

Merged
merged 13 commits into from
Dec 30, 2022
Merged

Fix to add parentheses for TSTypeQuery in some case #14042

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4357463
add TSTypeQuery to needsParens
onishi-kohei Dec 21, 2022
8bd1d57
fix to lint prettier
onishi-kohei Dec 23, 2022
6075690
add test
onishi-kohei Dec 25, 2022
13d63c2
remove comment
onishi-kohei Dec 25, 2022
20e5a29
add changelog
onishi-kohei Dec 25, 2022
2fa910b
fix lint
onishi-kohei Dec 28, 2022
338124e
remove template comments at top in changelog
onishi-kohei Dec 28, 2022
15096f1
Fix changelog
fisker Dec 29, 2022
57d3a18
Add new line
fisker Dec 29, 2022
59a7a56
check objectType
onishi-kohei Dec 29, 2022
f3f7503
remove fallthrough comment
onishi-kohei Dec 29, 2022
7035317
check property name
onishi-kohei Dec 29, 2022
7ea60a6
Simplify changelog
fisker Dec 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions changelog_unreleased/typescript/14042.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#### Add parentheses for TSTypeQuery to improve readability (#14042 by @onishi-kohei)

<!-- prettier-ignore -->
```tsx
// Input
a as (typeof node.children)[number]
a as (typeof node.children)[]
a as ((typeof node.children)[number])[]

// Prettier stable
a as typeof node.children[number];
a as typeof node.children[];
a as typeof node.children[number][];

// Prettier main
a as (typeof node.children)[number];
a as (typeof node.children)[];
a as (typeof node.children)[number][];
```
9 changes: 8 additions & 1 deletion src/language-js/needs-parens.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,14 @@ function needsParens(path, options) {
(parent.type === "TSTypeAnnotation" &&
path.getParentNode(1).type.startsWith("TSJSDoc"))
);

case "TSTypeQuery":
if (
parent.type === "TSIndexedAccessType" ||
parent.type === "TSArrayType"
) {
return true;
}
Copy link
Member

@fisker fisker Dec 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need check the property name here, in this case name === "objectType".

Prettier pr-14042
Playground link

--parser typescript

Input:

a as (typeof node.children)[number]
a as (number)[typeof node.children]

Output:

a as (typeof node.children)[number];
a as number[(typeof node.children)];

Copy link
Contributor Author

@onishi-kohei onishi-kohei Dec 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

a as (typeof node.children)[]

this property name was elementType
May I add a case like the code below?

return (
        name === "objectType" || name === "elementType"   &&
        (parent.type === "TSIndexedAccessType" || parent.type === "TSArrayType")
      )

Copy link
Member

@fisker fisker Dec 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, should be

return (
        (name === "objectType" && parent.type === "TSIndexedAccessType") ||
        (name === "elementType" && parent.type === "TSArrayType")
      )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in this commit.　7035317

// fallthrough
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think TSTypeQuery(TypeScript node type) can be a child of NullableTypeAnnotation(flow node type). This should not fallthrough.

case "ArrayTypeAnnotation":
return parent.type === "NullableTypeAnnotation";

Expand Down
19 changes: 19 additions & 0 deletions tests/format/typescript/typeof/__snapshots__/jsfmt.spec.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`typeof.ts format 1`] = `
====================================options=====================================
parsers: ["typescript"]
printWidth: 80
| printWidth
=====================================input======================================
a as (typeof node.children)[number]
a as (typeof node.children)[]
a as ((typeof node.children)[number])[]

=====================================output=====================================
a as (typeof node.children)[number];
a as (typeof node.children)[];
a as (typeof node.children)[number][];

================================================================================
`;
1 change: 1 addition & 0 deletions tests/format/typescript/typeof/jsfmt.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
run_spec(__dirname, ["typescript"]);
3 changes: 3 additions & 0 deletions tests/format/typescript/typeof/typeof.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
a as (typeof node.children)[number]
a as (typeof node.children)[]
a as ((typeof node.children)[number])[]