Adds formatting capabilities to vs-code extension #402

simonthuresson · 2025-03-11T09:08:09Z

Description

This PR adds a document formatting endpoint to the language server package, allowing clients to request document formatting. It also sets the flag that the server is capable of formatting a document.

Updates the vs-code extension README to include the added formatting feature.

Initially, we investigated implementing cursor position tracking using our internal cursor tracking, but discovered that VS Code already handles cursor position updates automatically. Therefore, no additional logic was needed for cursor position management.

changeset-bot · 2025-03-11T09:08:14Z

⚠️ No Changeset found

Latest commit: 456f1bb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

OskarDamkjaer · 2025-03-11T09:44:00Z

packages/vscode-extension/README.md

@@ -12,6 +12,7 @@ Our extension preview provides a rich set of features for working with Cypher, t
 - Syntax checking - both simple and semantic errors (e.g. type errors, unknown labels, etc)
 - Autocompletion for Cypher keywords, functions, labels, properties, database names and more
 - Signature help for functions - shows the signature of the function while typing
+- Formatting - format the document according to the Cypher styleguide


OskarDamkjaer · 2025-03-11T09:49:39Z

Really cool to see the queries get automatically formatted on save, however I couldn't get this one to work and I don't understand why (since i get no syntax errors):

CALL {
  CALL {
      UNWIND range(1,4) AS direction
      MATCH p = (start:Cell)(()-[r WHERE r.direction = direction]->()){4}(end)
      OPTIONAL MATCH (before_start)-[r0]->(start)
          WHERE r0.direction = direction
      OPTIONAL MATCH (end)-[r5]->(after_end)
          WHERE r5.direction = direction
      RETURN p, before_start, start, end, after_end, direction
  } // -- all valid paths

  WITH *
      WHERE all(node IN nodes(p) WHERE node.state IS NULL OR node.state = $symbol) OR 
            all(node IN nodes(p) WHERE node.state IS NULL OR node.state <> $symbol) // -- exclude all paths that include both symbols since they cannot lead to victory

  WITH *,
      CASE
      WHEN before_start IS NOT NULL AND before_start.state IS NULL AND end.state IS NULL THEN 1
      WHEN start.state IS NULL AND after_end IS NOT NULL AND after_end.state IS NULL THEN 2
      ELSE 0
      END AS openEnded

  WITH *, 
      size([node IN nodes(p) WHERE node.state = $symbol]) AS myScore, 
      size([node IN nodes(p) WHERE node.state <> $symbol]) AS otherScore
      // -- the two size filters above are enough, since any path including both symbols have already been excluded above

  UNWIND nodes(p) AS candidate 
  WITH * WHERE candidate.state IS NULL

  WITH *,
  CASE
      WHEN myScore = 4 THEN 2
      WHEN otherScore = 4 THEN 1
      ELSE 0
  END AS isWinningMove, // -- 2 means it is my win, 1 means that opponent could win in next move
  CASE
      WHEN myScore = 3 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 2     
      WHEN otherScore = 3 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isThreeWinningMove,  
  CASE
      WHEN myScore = 3 THEN 1
      ELSE 0
  END AS isMyThreeMove,
  CASE
      WHEN otherScore = 3 THEN 1
      ELSE 0
  END AS isOtherThreeMove, 
  CASE
      WHEN myScore = 2 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isMyTwoMove,
  CASE
      WHEN otherScore = 2 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isOtherTwoMove

  WITH candidate, 
      direction,
      max(isWinningMove) AS maxIsWinningMove,
      max(isThreeWinningMove) AS maxIsThreeWinningMove,
      max(isMyThreeMove) AS maxIsMyThreeMove,
      max(isOtherThreeMove) AS maxIsOtherThreeMove,
      max(isMyTwoMove) AS maxIsMyTwoMove,
      max(isOtherTwoMove) AS maxIsOtherTwoMove,
      sum((myScore + otherScore + toInteger(openEnded > 0))) AS candidateScore // -- give an additional point for open-ended paths, as a heuristic

  WITH candidate, 
      sum(maxIsWinningMove) AS isWinningMove,
      sum(maxIsThreeWinningMove) AS isThreeWinningMove,
      sum(maxIsMyThreeMove) AS isMyThreeMoveSum,
      sum(maxIsOtherThreeMove) AS isOtherThreeMoveSum,
      sum(maxIsMyTwoMove) AS isMyTwoMoveSum,
      sum(maxIsOtherTwoMove) AS isOtherTwoMoveSum,
      sum(candidateScore) + count(*) AS score // -- give one point extra for each direction that a candidate advances play in, as a heuristic

  WITH *,
  CASE
      WHEN isMyThreeMoveSum >= 2 THEN 2
      WHEN isOtherThreeMoveSum >= 2 THEN 1
      WHEN isMyThreeMoveSum > 0 AND isMyTwoMoveSum > 0 THEN 2
      WHEN isOtherThreeMoveSum > 0 AND isOtherTwoMoveSum > 0 THEN 1
      WHEN isMyTwoMoveSum  >= 2 THEN 2
      WHEN isOtherTwoMoveSum  >= 2 THEN 1
      ELSE 0
  END AS isFork

  WITH * ORDER BY isWinningMove DESC, isThreeWinningMove DESC, isFork DESC, score DESC 
  LIMIT 1
  RETURN candidate, isWinningMove
  
  UNION 

  // -- When the game will for sure end in a tie we still need to update the game

  MATCH (candidate) WHERE candidate.state IS NULL
  RETURN candidate, -1 AS isWinningMove LIMIT 1
}

WITH * ORDER BY isWinningMove DESC
LIMIT 1

SET candidate.state = $symbol

Logs say:

[Error - 10:49:51] Request textDocument/formatting failed.
  Message: Request textDocument/formatting failed with message: Cannot read properties of null (reading 'getText')
  Code: -32603

simonthuresson · 2025-03-11T09:59:32Z

Really cool to see the queries get automatically formatted on save, however I couldn't get this one to work and I don't understand why (since i get no syntax errors):

CALL {
  CALL {
      UNWIND range(1,4) AS direction
      MATCH p = (start:Cell)(()-[r WHERE r.direction = direction]->()){4}(end)
      OPTIONAL MATCH (before_start)-[r0]->(start)
          WHERE r0.direction = direction
      OPTIONAL MATCH (end)-[r5]->(after_end)
          WHERE r5.direction = direction
      RETURN p, before_start, start, end, after_end, direction
  } // -- all valid paths

  WITH *
      WHERE all(node IN nodes(p) WHERE node.state IS NULL OR node.state = $symbol) OR 
            all(node IN nodes(p) WHERE node.state IS NULL OR node.state <> $symbol) // -- exclude all paths that include both symbols since they cannot lead to victory

  WITH *,
      CASE
      WHEN before_start IS NOT NULL AND before_start.state IS NULL AND end.state IS NULL THEN 1
      WHEN start.state IS NULL AND after_end IS NOT NULL AND after_end.state IS NULL THEN 2
      ELSE 0
      END AS openEnded

  WITH *, 
      size([node IN nodes(p) WHERE node.state = $symbol]) AS myScore, 
      size([node IN nodes(p) WHERE node.state <> $symbol]) AS otherScore
      // -- the two size filters above are enough, since any path including both symbols have already been excluded above

  UNWIND nodes(p) AS candidate 
  WITH * WHERE candidate.state IS NULL

  WITH *,
  CASE
      WHEN myScore = 4 THEN 2
      WHEN otherScore = 4 THEN 1
      ELSE 0
  END AS isWinningMove, // -- 2 means it is my win, 1 means that opponent could win in next move
  CASE
      WHEN myScore = 3 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 2     
      WHEN otherScore = 3 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isThreeWinningMove,  
  CASE
      WHEN myScore = 3 THEN 1
      ELSE 0
  END AS isMyThreeMove,
  CASE
      WHEN otherScore = 3 THEN 1
      ELSE 0
  END AS isOtherThreeMove, 
  CASE
      WHEN myScore = 2 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isMyTwoMove,
  CASE
      WHEN otherScore = 2 AND ((openEnded = 1 AND candidate <> end) OR (openEnded = 2 AND candidate <> start)) THEN 1
      ELSE 0
  END AS isOtherTwoMove

  WITH candidate, 
      direction,
      max(isWinningMove) AS maxIsWinningMove,
      max(isThreeWinningMove) AS maxIsThreeWinningMove,
      max(isMyThreeMove) AS maxIsMyThreeMove,
      max(isOtherThreeMove) AS maxIsOtherThreeMove,
      max(isMyTwoMove) AS maxIsMyTwoMove,
      max(isOtherTwoMove) AS maxIsOtherTwoMove,
      sum((myScore + otherScore + toInteger(openEnded > 0))) AS candidateScore // -- give an additional point for open-ended paths, as a heuristic

  WITH candidate, 
      sum(maxIsWinningMove) AS isWinningMove,
      sum(maxIsThreeWinningMove) AS isThreeWinningMove,
      sum(maxIsMyThreeMove) AS isMyThreeMoveSum,
      sum(maxIsOtherThreeMove) AS isOtherThreeMoveSum,
      sum(maxIsMyTwoMove) AS isMyTwoMoveSum,
      sum(maxIsOtherTwoMove) AS isOtherTwoMoveSum,
      sum(candidateScore) + count(*) AS score // -- give one point extra for each direction that a candidate advances play in, as a heuristic

  WITH *,
  CASE
      WHEN isMyThreeMoveSum >= 2 THEN 2
      WHEN isOtherThreeMoveSum >= 2 THEN 1
      WHEN isMyThreeMoveSum > 0 AND isMyTwoMoveSum > 0 THEN 2
      WHEN isOtherThreeMoveSum > 0 AND isOtherTwoMoveSum > 0 THEN 1
      WHEN isMyTwoMoveSum  >= 2 THEN 2
      WHEN isOtherTwoMoveSum  >= 2 THEN 1
      ELSE 0
  END AS isFork

  WITH * ORDER BY isWinningMove DESC, isThreeWinningMove DESC, isFork DESC, score DESC 
  LIMIT 1
  RETURN candidate, isWinningMove
  
  UNION 

  // -- When the game will for sure end in a tie we still need to update the game

  MATCH (candidate) WHERE candidate.state IS NULL
  RETURN candidate, -1 AS isWinningMove LIMIT 1
}

WITH * ORDER BY isWinningMove DESC
LIMIT 1

SET candidate.state = $symbol

Logs say:

[Error - 10:49:51] Request textDocument/formatting failed.
  Message: Request textDocument/formatting failed with message: Cannot read properties of null (reading 'getText')
  Code: -32603

Hmm I can not get it to work either, will look into it before merge!

simonthuresson · 2025-03-11T10:22:31Z

Really cool to see the queries get automatically formatted on save, however I couldn't get this one to work and I don't understand why (since i get no syntax errors):

I traced this to a issue with the formatter itself, I am getting the same issue running this in codemirror. I have added a Trello card for this. So I dont think this is related to this PR.

tomasnyberg · 2025-03-11T11:16:38Z

The query above errors because of an issue in visitQuantifier, fix here #403

ncordon · 2025-03-12T13:20:59Z

packages/language-support/src/formatting/formatting.ts

  visitMergeClause = (ctx: MergeClauseContext) => {
-    handleMergeClause(
-      ctx,
-      (node) => this.visit(node),
-      () => this.startGroupAlsoOnComment(),
-      (id) => this.endGroup(id),
-      () => this.avoidBreakBetween(),
-    );
+    this.visit(ctx.MERGE());
+    this.avoidBreakBetween();
+    const patternGrp = this.startGroupAlsoOnComment();
+    this.visit(ctx.pattern());
+    this.endGroup(patternGrp);
+    const n = ctx.mergeAction_list().length;
+    for (let i = 0; i < n; i++) {
+      this.visit(ctx.mergeAction(i));
+    }
  };


I assume this is not part of this pr right? Not sure why it's still showing in the diff if it was merged to main

No it is definitely not. Not sure why this is here at all. I merged main into this PR and after that it dissapeared. So i guess I was just not up to date with main.

ncordon · 2025-03-12T13:21:51Z

packages/vscode-extension/tests/specs/api/syntaxValidation.spec.ts

@@ -69,7 +69,7 @@ export async function testSyntaxValidation({
  );
 }

-suite.only('Syntax validation spec', () => {


ncordon

It'd make sense to clean up the history if you could before merge so the diff shows only the relevant changes

simonthuresson · 2025-03-12T13:29:21Z

It'd make sense to clean up the history if you could before merge so the diff shows only the relevant changes

Will definitely do that. Merge main into this branch sorted things out.

simonthuresson added 4 commits March 10, 2025 17:11

can change document

3f7699a

refactores format document

04d0cb4

uses non deprecated type

69eced7

changed import order back to original

6cfe084

updates readme for vs-code extension

c7f9a3e

OskarDamkjaer reviewed Mar 11, 2025

View reviewed changes

simonthuresson and others added 4 commits March 11, 2025 11:25

Updates changelog

8f15e30

bumps vs-code extension version

a112798

Removes reordering of ON CREATE/MATCH clauses in formatter (neo4j#399)

f5553ac

Fixes IS CONNECTED concatenate bug in formatter (neo4j#401)

de01d1f

tomasnyberg mentioned this pull request Mar 11, 2025

Fixes QPP with no comma bug in formatter #403

Merged

ncordon self-assigned this Mar 11, 2025

simonthuresson added 2 commits March 12, 2025 09:49

adds e2e tests for extension

a2d7973

modified test

b3cae14

ncordon reviewed Mar 12, 2025

View reviewed changes

ncordon approved these changes Mar 12, 2025

View reviewed changes

Merge branch 'main' into vs-code-formatterv2

0e869d9

deletes unused file

456f1bb

simonthuresson merged commit e2c47b7 into neo4j:main Mar 12, 2025
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds formatting capabilities to vs-code extension #402

Adds formatting capabilities to vs-code extension #402

simonthuresson commented Mar 11, 2025 •

edited

Loading

changeset-bot bot commented Mar 11, 2025 •

edited

Loading

OskarDamkjaer Mar 11, 2025

OskarDamkjaer commented Mar 11, 2025 •

edited

Loading

simonthuresson commented Mar 11, 2025

simonthuresson commented Mar 11, 2025

tomasnyberg commented Mar 11, 2025 •

edited

Loading

ncordon Mar 12, 2025

simonthuresson Mar 12, 2025

ncordon Mar 12, 2025

ncordon left a comment

simonthuresson commented Mar 12, 2025

Adds formatting capabilities to vs-code extension #402

Adds formatting capabilities to vs-code extension #402

Conversation

simonthuresson commented Mar 11, 2025 • edited Loading

Description

changeset-bot bot commented Mar 11, 2025 • edited Loading

⚠️ No Changeset found

OskarDamkjaer Mar 11, 2025

Choose a reason for hiding this comment

OskarDamkjaer commented Mar 11, 2025 • edited Loading

simonthuresson commented Mar 11, 2025

simonthuresson commented Mar 11, 2025

tomasnyberg commented Mar 11, 2025 • edited Loading

ncordon Mar 12, 2025

Choose a reason for hiding this comment

simonthuresson Mar 12, 2025

Choose a reason for hiding this comment

ncordon Mar 12, 2025

Choose a reason for hiding this comment

ncordon left a comment

Choose a reason for hiding this comment

simonthuresson commented Mar 12, 2025

simonthuresson commented Mar 11, 2025 •

edited

Loading

changeset-bot bot commented Mar 11, 2025 •

edited

Loading

OskarDamkjaer commented Mar 11, 2025 •

edited

Loading

tomasnyberg commented Mar 11, 2025 •

edited

Loading