[prettier] Adds prettier-plugin-move #18405

damirka · 2024-06-25T16:18:56Z

Description

Upstreams the prettier plugin development.

Test plan

Features tests.

Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

vercel · 2024-06-25T16:18:59Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sui-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 28, 2024 4:10pm

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
multisig-toolkit	⬜️ Ignored (Inspect)	Visit Preview	Jul 28, 2024 4:10pm
sui-kiosk	⬜️ Ignored (Inspect)	Visit Preview	Jul 28, 2024 4:10pm
sui-typescript-docs	⬜️ Ignored (Inspect)	Visit Preview	Jul 28, 2024 4:10pm

awelc

In addition to additional tests requested in the PR's body, it would be great to see separate tests for more complicated (nested, breaking, etc.) imports (aka uses) and attributes

external-crates/move/crates/move-analyzer/prettier-move/src/cst/Common.ts

awelc · 2024-07-11T20:12:10Z

external-crates/move/crates/move-analyzer/prettier-move/tests/functions/expression.move

+
+    fun binary_expression_folding() {
+        // binary_expression
+        say_something_really_long && say_something_really_long || say_something_really_long;


Please add tests for parenthesized variants

I was hoping for something that will exercise breaks involving parenthesized conditions. Something like a couple of differently parenthesized variants of the following:

((say_something_really_long || say_something_really_long) && say_something_really_long) || (say_something_really_long && say_something_really_long) || (say_something_really_long || say_something_really_long)

It's not technically feasible today. I'm waiting on Tim to try and patch the structure of the binary_expression, so we know we're inside a binary expression. But overall these are the hardest to get and require special treatment.

Acknowledged. As suggested in the other comment, let's add some additional explanation and a test, and move on

It would be really good to get a bit more detailed explanation on the difficulty related to binary expressions, even if they are not fully handled as part of this PR, so that we know what's missing (if anything) and what kind of effort could be involved in getting this to completion

external-crates/move/crates/move-analyzer/prettier-move/tests/functions/expression.move

external-crates/move/crates/move-analyzer/prettier-move/tests/mega-test/misc.exp.move

awelc · 2024-07-15T17:38:18Z

external-crates/move/crates/move-analyzer/prettier-move/src/cst/Common.ts

+function printBindField(path: AstPath<Node>, options: ParserOptions, print: printFn): Doc {
+	const nonFormatting = path.node.nonFormattingChildren;
+	const isMut = !!path.node.children.find((c) => c.text === 'mut');
+	// const rename = nonFormatting.length == 2;


awelc · 2024-07-15T17:45:04Z

external-crates/move/crates/move-analyzer/prettier-move/tests/functions/expression.move

+
+    fun binary_expression_folding() {
+        // binary_expression
+        say_something_really_long && say_something_really_long || say_something_really_long;


I was hoping for something that will exercise breaks involving parenthesized conditions. Something like a couple of differently parenthesized variants of the following:

((say_something_really_long || say_something_really_long) && say_something_really_long) || (say_something_really_long && say_something_really_long) || (say_something_really_long || say_something_really_long)

external-crates/move/crates/move-analyzer/prettier-move/tests/sui-framework/package.exp.move

awelc · 2024-07-23T17:13:34Z

Here's a summary of testing that needs to happen either as part of this PR or a series of the following ones (in the latter case we should probably keep track of this via a series of opened issue):
Tests for:

more complicated (nested, breaking, etc.) imports (aka uses)

more complicated (nested, breaking, etc.) attributes

the case when function types need to break (both in the parameters and return type)
more complicated if conditions, in particular parenthesized in a nested fashion
index notation when a list of indexes is very long with both short and long index values
more complicated enum matches
binary expressions that exercise breaks involving parenthesized conditions. Something like a couple of differently parenthesized variants of the following:

((say_something_really_long || say_something_really_long) && say_something_really_long) || (say_something_really_long && say_something_really_long) || (say_something_really_long || say_something_really_long)

github-actions · 2024-09-27T02:02:01Z

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

tedks · 2024-11-18T19:51:17Z

Is this obsolete in favor of #20203?

damirka · 2024-11-18T19:52:08Z

@tedks correct! Closing!

damirka requested a review from ronny-mysten as a code owner June 25, 2024 16:18

damirka requested review from awelc, tnowacki and tzakian June 25, 2024 16:19

vercel bot deployed to Preview – sui-docs June 25, 2024 16:22 View deployment

vercel bot deployed to Preview – sui-docs June 25, 2024 19:16 View deployment

vercel bot deployed to Preview – sui-docs June 25, 2024 19:25 View deployment

vercel bot deployed to Preview – sui-docs June 26, 2024 21:57 View deployment

vercel bot deployed to Preview – sui-docs June 26, 2024 21:59 View deployment

vercel bot deployed to Preview – sui-docs June 26, 2024 22:11 View deployment

vercel bot deployed to Preview – sui-docs June 26, 2024 22:16 View deployment

vercel bot deployed to Preview – sui-docs June 27, 2024 13:14 View deployment

vercel bot deployed to Preview – sui-docs June 27, 2024 18:03 View deployment

vercel bot deployed to Preview – sui-docs July 2, 2024 13:04 View deployment

vercel bot deployed to Preview – sui-docs July 2, 2024 13:33 View deployment

vercel bot deployed to Preview – sui-docs July 2, 2024 14:55 View deployment

vercel bot deployed to Preview – sui-docs July 2, 2024 21:28 View deployment

awelc requested changes Jul 11, 2024

View reviewed changes

damirka force-pushed the ds/prettier-move branch from 08d5b54 to 990ac64 Compare July 13, 2024 14:15

vercel bot deployed to Preview – sui-docs July 13, 2024 14:19 View deployment

vercel bot deployed to Preview – sui-docs July 13, 2024 14:38 View deployment

damirka requested a review from awelc July 14, 2024 07:37

vercel bot deployed to Preview – sui-docs July 14, 2024 12:30 View deployment

vercel bot deployed to Preview – sui-docs July 14, 2024 14:54 View deployment

vercel bot deployed to Preview – sui-docs July 15, 2024 14:11 View deployment

vercel bot deployed to Preview – sui-docs July 15, 2024 15:19 View deployment

awelc requested changes Jul 15, 2024

View reviewed changes

damirka force-pushed the ds/prettier-move branch from 92518b9 to 4cd6bb4 Compare July 23, 2024 19:39

damirka requested review from emmazzz and suiwombat as code owners July 28, 2024 15:58

damirka requested review from pchrysochoidis and mystieanwaya and removed request for a team July 28, 2024 15:58

github-actions bot added the Type: Documentation Improvements or additions to documentation label Jul 28, 2024

damirka force-pushed the ds/prettier-move branch from 29fa35d to 9709700 Compare July 28, 2024 15:59

github-actions bot removed the Type: Documentation Improvements or additions to documentation label Jul 28, 2024

damirka removed request for ronny-mysten, tnowacki, tzakian, a team, bmwill, amnn, wlmyng, stefan-mysten, emmazzz, suiwombat, pchrysochoidis and mystieanwaya July 28, 2024 16:01

damirka added 2 commits July 28, 2024 19:03

module label support

08458af

remove debug lines

7c450c8

vercel bot deployed to Preview – sui-docs July 28, 2024 16:10 View deployment

github-actions bot added the Stale label Sep 27, 2024

damirka closed this Nov 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[prettier] Adds prettier-plugin-move #18405

[prettier] Adds prettier-plugin-move #18405

damirka commented Jun 25, 2024

vercel bot commented Jun 25, 2024 •

edited

Loading

awelc left a comment

awelc Jul 11, 2024

awelc Jul 15, 2024

damirka Jul 17, 2024

awelc Jul 17, 2024

awelc Jul 23, 2024

awelc Jul 15, 2024

awelc Jul 15, 2024

awelc commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Sep 27, 2024

tedks commented Nov 18, 2024

damirka commented Nov 18, 2024

[prettier] Adds prettier-plugin-move #18405

[prettier] Adds prettier-plugin-move #18405

Conversation

damirka commented Jun 25, 2024

Description

Test plan

Release notes

vercel bot commented Jun 25, 2024 • edited Loading

awelc left a comment

Choose a reason for hiding this comment

awelc Jul 11, 2024

Choose a reason for hiding this comment

awelc Jul 15, 2024

Choose a reason for hiding this comment

damirka Jul 17, 2024

Choose a reason for hiding this comment

awelc Jul 17, 2024

Choose a reason for hiding this comment

awelc Jul 23, 2024

Choose a reason for hiding this comment

awelc Jul 15, 2024

Choose a reason for hiding this comment

awelc Jul 15, 2024

Choose a reason for hiding this comment

awelc commented Jul 23, 2024 • edited Loading

github-actions bot commented Sep 27, 2024

tedks commented Nov 18, 2024

damirka commented Nov 18, 2024

vercel bot commented Jun 25, 2024 •

edited

Loading

awelc commented Jul 23, 2024 •

edited

Loading