[FEATURE] GDScript Code Highlighting Support

[DarienMC]

Is your feature request related to a problem? Please describe.

When I use write my notes from game development tutorials, I notice that there is no support for the Godot Engine, which uses GDScript.

Describe the solution you'd like

I'd like to type gdscript at the start of a fenced code block to get syntax highlighting for GDScript like we get here on GitHub below.

# Everything after "#" is a comment.
# A file is a class!

# (optional) icon to show in the editor dialogs:
@icon("res://path/to/optional/icon.svg")

# (optional) class definition:
class_name MyClass

# Inheritance:
extends BaseClass

@export var my_scene : PackedScene = preload("res://scenes/my_scene.tscn")

# Member variables.
var a = 5
var s = "Hello"
var arr = [1, 2, 3]
var dict = {"key": "value", 2: 3}
var other_dict = {key = "value", other_key = 2}
var typed_var: int
var inferred_type := "String"

@onready var my_sprite_2d : Sprite2D = $Sprite2D
@onready var my_sub_viewport : SubViewport = %HandsViewport

# Constants.
const ANSWER = 42
const THE_NAME = "Charly"

# Enums.
enum {UNIT_NEUTRAL, UNIT_ENEMY, UNIT_ALLY}
enum Named {THING_1, THING_2, ANOTHER_THING = -1}

# Built-in vector types.
var v2 = Vector2(1, 2)
var v3 = Vector3(1, 2, 3)


# Functions.
func some_function(param1, param2, param3):
	const local_const = 5

	if param1 < local_const:
		print(param1)
	elif param2 > 5:
		print(param2)
	else:
		print("Fail!")

	for i in range(20):
		print(i)

	while param2 != 0:
		param2 -= 1

	match param3:
		3:
			print("param3 is 3!")
		_:
			print("param3 is not 3!")

	var local_var = param1 + 3
	return local_var


# Functions override functions with the same name on the base/super class.
# If you still want to call them, use "super":
func something(p1, p2):
	super(p1, p2)


# It's also possible to call another function in the super class:
func other_something(p1, p2):
	super.something(p1, p2)


# Inner class
class Something:
	var a = 10


# Constructor
func _init():
	print("Constructed!")
	var lv = Something.new()
	print(lv.a)

Describe alternatives you've considered

Using another note app or using screenshots from within the engine to paste inside my notes, but this adds friction to my workflow.

Additional context

I've actually already pulled the repository and attempted to implement this feature myself. Here is a screenshot below:

With permission, I can create then push a branch called feature/gdscript_highlighting for review.

Output from the debug section in the settings dialog

Expand

[pbek]

Sure, go on! Create a pull request! 👍️

[DarienMC]

Awesome, I will do so after work, within 12 hours from now.

[pbek]

25.2.0

• Added GDScript support to the note edit code block syntax highlighter
  (for #3222, thank you, @DarienMC)

[pbek]

There now is a new release, could you please test it and report if it works for you?

[DarienMC]

Sure thing!

Pulling from the release branch to get version 25.2.0, then building and running it through Qt Creator. Everything seems to work as intended.

Some nitpicks, but not dealbreakers.

How it is supposed to be highlighted below through the Godot VSCode extension:

How the current implementation highlights these same lines:

These are nitpicks though, and not even the GitHub markdown support does this. But, I'm sure this is an easy fix for anyone who wants to adjust some things.

I use the FlatPak version of QOwnNotes (through FlatHub), and I'll be making use of this feature somewhat frequently.

[pbek]

Great, thank you for testing!

How the current implementation highlights these same lines:

What was the difference that was relevant for you?

[DarienMC]

Thank you,

The difference that is relevant for me is the following:

Both $NodePath constructs and %UniqueNode are supposed to be highlighted as literals.

In the Godot game engine, everything within a scene is organized into a tree of "Nodes" that you can then reference in GDScript using these constructs.

A common example: say we have a scene with three nodes:

1. a root node named CharacterBody2D of type CharacterBody2D
2. a child node HurtBox of type Area2D
3. its child node is a node named CollisonShape2D of type CollisionShape2D

If we were to attach a script to the root node, then wanted to reference its child node HurtBox anywhere in that script, we can use the construct $HurtBox. It would be all highlighted as a literal.

If we were to then try to reference the CollisionShape2D node, we can use the forward slash '/' in a similar way to how file systems work. Therefore, we can use the construct $HurtBox/CollisionShape2D. It would be all highlighted as a literal, including the forward slash '/'.

Say the NodePath above is deemed to long. Some scenes will have modules nested deep within their node tree that we want the root node to reference. We can then use a %UniqueNode construct to reference any node in a scene tree a that was given a unique identifier in the scene tree editor.

If we were to assign the CollisionShape2D node a unique name "ThisIsAUniqueName", we can then reference this node in our script as %ThisIsAUniqueName, highlighted as a literal.

[pbek]

Is there anything you can change in the highlighting?

[DarienMC]

I should be able to work on it by next weekend, as I've just been busy lately (currently at work, away from home). I never coded in C++, let alone used Qt Creator before so I've used this as a learning experience over the weekend. Everything I did in my contribution was just from recognizing patterns in the existing code and going from there.

I know this problem should be easy as it's a matter of iterating over characters and checking whether or not a space, newline, or period is found.

[pbek]

Everything I did in my contribution was just from recognizing patterns in the existing code and going from there.

That's how we can learn! 😁👍️
Have fun! 😉