Fix bad formatting on several operators (#605)

Many, many formatter and syntax highlighting improvements.

Author: DaelonSuzuka

package.json

@@ -271,6 +271,24 @@
 					"default": true,
 					"description": "Whether to reveal the terminal when launching the Godot Editor"
 				},
+				"godotTools.formatter.emptyLinesBeforeFunctions": {
+					"type": "string",
+					"enum": [
+						"one",
+						"two"
+					],
+					"enumDescriptions": [
+						"One line before functions. A more compact style.",
+						"Two lines before functions. Conforms to the official GDScript style guide."
+					],
+					"default": "two",
+					"description": "Number of blank lines to leave before functions."
+				},
+				"godotTools.formatter.denseFunctionDeclarations": {
+					"type": "boolean",
+					"default": false,
+					"description": "Whether extra space should be removed from function declarations"
+				},
 				"godotTools.lsp.serverProtocol": {
 					"type": [
 						"string"

src/extension.ts

@@ -1,4 +1,4 @@
-import * as path from "path";
+import * as path from "node:path";
 import * as vscode from "vscode";
 import { attemptSettingsUpdate, get_extension_uri, clean_godot_path } from "./utils";
 import {
@@ -81,6 +81,10 @@ export function activate(context: vscode.ExtensionContext) {
 
 async function initial_setup() {
 	const projectVersion = await get_project_version();
+	if (projectVersion === undefined) {
+		// TODO: actually handle this?
+		return;
+	}
 	const settingName = `editorPath.godot${projectVersion[0]}`;
 	const result = verify_godot_version(get_configuration(settingName), projectVersion[0]);
 	const godotPath = result.godotPath;

src/formatter/formatter.test.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
-import * as path from "path";
-import * as fs from "fs";
+import * as path from "node:path";
+import * as fs from "node:fs";
 
 import { format_document } from "./textmate";
 

src/formatter/snapshot_template/in.gd

@@ -26,6 +26,9 @@ func f():
 	a= 1.0* .2
 	a =1.0 * 2.
 
+	a = 10**10
+	a = min(10, 10**10)
+
 	a= a%  b
 	a =1%2
 
@@ -36,3 +39,16 @@ func f():
 
 	var v = Vector2(  1  ,  -   1  )
 	var w = Vector2(1,10-1)
+
+	print( - 1  )
+	print( 1 - 1 )
+
+	print(  - 1 + (1-1))
+	print(  - 1 + (-1-1))
+
+	if a > - 1:
+		if a < - 1:
+			if  a  == -  1:
+				pass
+
+	return  -  1

src/formatter/snapshot_template/out.gd

@@ -26,6 +26,9 @@ func f():
 	a = 1.0 * .2
 	a = 1.0 * 2.
 
+	a = 10 ** 10
+	a = min(10, 10 ** 10)
+
 	a = a % b
 	a = 1 % 2
 
@@ -36,3 +39,16 @@ func f():
 
 	var v = Vector2(1, -1)
 	var w = Vector2(1, 10 - 1)
+
+	print(-1)
+	print(1 - 1)
+
+	print(-1 + (1 - 1))
+	print(-1 + (-1 - 1))
+
+	if a > -1:
+		if a < -1:
+			if a == -1:
+				pass
+
+	return -1

src/formatter/snapshots/arithmetic/in.gd

@@ -0,0 +1,15 @@
+func f():
+	# arithmetic
+    x += 1
+	x -= 1
+	x *= 1
+	x /= 1
+	x %= 1
+	
+    # bitwise
+    x |= 1
+	x &= 1
+	x ~= 1
+	x /= 1
+	x >>= 1
+	x <<= 1

src/formatter/snapshots/arithmetic/out.gd

@@ -0,0 +1,15 @@
+func f():
+	# arithmetic
+    x += 1
+	x -= 1
+	x *= 1
+	x /= 1
+	x %= 1
+	
+    # bitwise
+    x |= 1
+	x &= 1
+	x ~= 1
+	x /= 1
+	x >>= 1
+	x <<= 1

src/formatter/snapshots/assignment-operators/in.gd

@@ -0,0 +1,5 @@
+func f():
+	collision_mask = 1 << 1 | 1 << 3
+	collision_mask = 1 << 1 & 1 << 3
+	collision_mask = ~1
+	collision_mask = 1  ^  ~    1

src/formatter/snapshots/assignment-operators/out.gd

@@ -0,0 +1,5 @@
+func f():
+	collision_mask = 1 << 1 | 1 << 3
+	collision_mask = 1 << 1 & 1 << 3
+	collision_mask = ~1
+	collision_mask = 1 ^ ~1

src/formatter/snapshots/bitwise-operators/in.gd

@@ -8,3 +8,7 @@ func f():
 func g():
 	print(true and (  not false ) or (  true))
 	print(true and not false or not (true)  )
+
+func h():
+	print(true && (  not false ) || (  true))
+	print(true && not false || not (true)  )

src/formatter/snapshots/bitwise-operators/out.gd

@@ -8,3 +8,7 @@ func f():
 func g():
 	print(true and (not false) or (true))
 	print(true and not false or not (true))
+
+func h():
+	print(true && (not false) || (true))
+	print(true && not false || not (true))

src/formatter/snapshots/boolean-operators/in.gd

@@ -1,6 +1,27 @@
 
 
+
+class Test:
+
+
+
+
+	func _ready():
+	
+	
+		pass
+
+
+
 func test():
 
+
 	pass
 
+
+
+
+# comments
+func with_comments():
+
+	pass

src/formatter/snapshots/boolean-operators/out.gd

@@ -1,3 +1,17 @@
+class Test:
+
+
+	func _ready():
+	
+		pass
+
+
 func test():
 
 	pass
+
+
+# comments
+func with_comments():
+
+	pass

src/formatter/snapshots/consecutive-empty-lines-are-removed/in.gd

@@ -2,14 +2,14 @@ var a = 10
 var b := 10
 var c: int = 10
 
-func f(b:=10):
-	return func(c:=10):
+func f(b := 10):
+	return func(c := 10):
 		pass
 
-func f(b: int=10):
-	return func(c: int=10):
+func f(b: int = 10):
+	return func(c: int = 10):
 		pass
 
-func f(b=10):
-	return func(c=10):
+func f(b = 10):
+	return func(c = 10):
 		pass

src/formatter/snapshots/consecutive-empty-lines-are-removed/out.gd

@@ -0,0 +1,10 @@
+func f():
+	const a = preload("res://a.gd")
+	const b = load("res://b.gd")
+
+	var origin: Vector2 = Vector2.ZERO
+	origin.x = 1
+	var andigin: Vector2 = Vector2.ZERO
+	andigin.x = 1
+
+	print(a)

src/formatter/snapshots/initialization/out.gd

@@ -0,0 +1,10 @@
+func f():
+	const a = preload("res://a.gd")
+	const b = load("res://b.gd")
+
+	var origin: Vector2 = Vector2.ZERO
+	origin.x = 1
+	var andigin: Vector2 = Vector2.ZERO
+	andigin.x = 1
+
+	print(a)

src/formatter/snapshots/keywords/in.gd

@@ -0,0 +1,4 @@
+func f(x):
+    match x:
+        var   y   when y>20:
+            pass

src/formatter/snapshots/keywords/out.gd

@@ -0,0 +1,4 @@
+func f(x):
+    match x:
+        var y when y > 20:
+            pass

src/formatter/snapshots/match/in.gd

@@ -69,3 +69,6 @@ var a = $"%Child/GrandChild".some_method()
 var a = $Child.get_node('GrandChild').some_method()
 var a = $"Child".get_node('GrandChild').some_method()
 var a = $"%Child".get_node('GrandChild').some_method()
+
+func f():
+	$Child.add_child(%Unique)

src/formatter/snapshots/match/out.gd

@@ -69,3 +69,6 @@ var a = $"%Child/GrandChild".some_method()
 var a = $Child.get_node('GrandChild').some_method()
 var a = $"Child".get_node('GrandChild').some_method()
 var a = $"%Child".get_node('GrandChild').some_method()
+
+func f():
+	$Child.add_child(%Unique)

src/formatter/snapshots/nodepaths/in.gd

@@ -21,6 +21,7 @@ export const keywords = [
 	"master",
 	"mastersync",
 	"match",
+	"when",
 	"not",
 	"onready",
 	"or",
@@ -58,10 +59,14 @@ export const symbols = [
 	"&=",
 	"^=",
 	"|=",
+	"~=",
 	"<<=",
 	">>=",
 	":=",
 	"->",
+	"&",
+	"|",
+	"^",
 	"-",
 	"+",
 	"/",