Update to Godot 4 and highlight.js 11

[Calinou]

Note that I couldn't get the ES module build to work in the browser, so maybe we should remove it.

• This closes update package.json #9 and Made it work the way it works with other languages. (Edited module.exports) #10 by superseding them.

Testing project: highlightjs-gdscript-test.zip
Change the path to dist/gdscript.min.js in index.html to match a location on disk, then open index.html in a web browser. No build step needed.

Preview

Using vs2015 theme and the test project linked above.

[joshgoebel]

Please do the "upgrade" work in an isolated commit (that doesn't move the file around) so I can properly review the changes.

[Calinou]

Please do the "upgrade" work in an isolated commit (that doesn't move the file around) so I can properly review the changes.

Done (it turns out we don't need to move any files after rebasing on master).

[Calinou]

For context, GDScript does not actually have multiline comments, but only multiline strings. Multiline strings on their own line are standalone expressions, so they have no effect if you use them as comments.

The style guide recommends using ## for documentation comments, as this makes them display in the inspector when hovering the property.

[akien-mga]

Looks good to me overall.

Regarding my comments to document the source of the lists of keywords/built-ins, if it's not suitable to include in gdscript.js as comments, maybe this could go in a README.

[akien-mga]

Seems like we lost the Godot 3 Pool*Arrays here.

[akien-mga]

Shouldn't we also include the old Godot 3 math types?

Rect3 Quat Transform

[akien-mga]

Might be worth documenting where to find those for future syncs.
Maybe use modules/gdscript/gdscript.cpp GDScriptLanguage::get_reserved_words() as reference?

BTW Godot 4.5 is adding abstract too.

There's also namespace and trait which are reserved for future use and thus highlighted by Godot, so we should include them too.

[akien-mga]

For assert, gdscript.cpp has:

                // Functions (highlighter uses global function color instead).
                "assert",
                "preload",

So maybe it should be moved to built_in like preload?

[akien-mga]

Actually I see it is also listed under built_in already, so the one here should probably be removed.

[akien-mga]

Would be good to document how to retrieve/update that list in case it changes in the future.

I've got the list for Godot 4 with:

grep "method name=" doc/classes/@GlobalScope.xml | sed 's/.*name="\([^"]*\)".*/\1/'

and

grep "method name=" modules/gdscript/doc_classes/@GDScript.xml | sed 's/.*name="\([^"]*\)".*/\1/'

And confirmed that it matches the list you have here. But that also means we're missing 3.x built-ins.

Assuming we can include comments between lines in this long string, I'd suggest prefacing the blocks like this:

# Godot 4 @GlobalScope methods
# `grep "method name=" doc/classes/@GlobalScope.xml | sed 's/.*name="\([^"]*\)".*/\1/'`

# Godot 4 @GDScript built-ins
# `grep "method name=" modules/gdscript/doc_classes/@GDScript.xml | sed 's/.*name="\([^"]*\)".*/\1/'`

# Godot 3 @GDScript built-ins not in Godot 4
# `grep "method name=" modules/gdscript/doc_classes/@GDScript.xml | sed 's/.*name="\([^"]*\)".*/\1/'``

(there's no @GlobalScope methods in 3.x, they're all in @GDScript)

I found the following Godot 3 built-ins missing here:

ColorN
bytes2var
cartesian2polar
db2linear
dectime
deep_equal
deg2rad
dict2inst
funcref
inst2dict
linear2db
ord
parse_json
polar2cartesian
rad2deg
rand_range
rand_seed
range_lerp
stepify
str2var
to_json
validate_json
var2bytes
var2str
yield

(yield is already a reserved keyword listed above for Godot 4 so it doesn't need to be re-listed here)

[akien-mga]

I confirmed the list of annotations is accurate for Godot 4 with:

grep "register_annotation(MethodInfo" gdscript_parser.cpp | sed 's/.*MethodInfo("\([^"]*\)".*/\1/' | sort

Could be documented too for future syncs.