Lightnews — Scholar-powered news

Nathan (GDQuest) @gdquest.bsky.social · 8d

Currently the Godot addon can update the formatter to the latest version, but there is nothing built into the formatter itself for that.

2

Nathan (GDQuest) @gdquest.bsky.social · 9d

GDScript Formatter can reorder your GDScript code for you!

Signals and variables first, then built-in Godot functions, then public and private custom functions, etc.

It's open source, written in Rust, and runs fast.

Give it a try: www.gdquest.com/library/gdsc...

2 18 74

Nathan (GDQuest) @gdquest.bsky.social · 9d

By making an external program with this rust technology, we already have a more reliable, fast formatter for the community right now that we can use in production with less work and maintenance though (much more accessible to contributors to collab on too).

1

Nathan (GDQuest) @gdquest.bsky.social · 9d

You can use this with Nvim, no problem. And sure for the LSP, I'm all for it; that's just outside of our control.

See github.com/godotengine/..., a project GDQuest sponsored, a built-in formatter that does provide LSP support. It lays down a lot of code to build upon/reuse but needs work.

Add script formatter, comment parsing in parser, and editor settings by RolandMarchand · Pull Request #76211 · godotengine/godot

This PR builds upon and finalizes the work done in godotengine/godot/pull/55835. This PR introduces a GDScript formatter in Godot's script editor. Users can access it through Edit/Format Code, ...

github.com

1

Nathan (GDQuest) @gdquest.bsky.social · 9d

No, this is an add-on which unfortunately has no access to the language server. But it's compatible with all code editors and we have configuration info for multiple code editors here: www.gdquest.com/library/gdsc...

VSCode setup guide coming soon.

GDScript Formatter: The fast formatter for Godot 4 | GDQuest Library

Learn how to install and use GDScript Formatter, a fast-running formatter for GDScript in Godot 4. Format and reorder your code according to the official style guide.

www.gdquest.com

1 2

Nathan (GDQuest) @gdquest.bsky.social · 9d

If you'd like to help contribute this, here's the source code: github.com/GDQuest/GDSc...

The Godot add-on is in the addons/ folder.

GitHub - GDQuest/GDScript-formatter: A fast code formatter for GDScript and Godot 4, written in Rust

A fast code formatter for GDScript and Godot 4, written in Rust - GDQuest/GDScript-formatter

github.com

1 3

Nathan (GDQuest) @gdquest.bsky.social · 9d

Yes, it's bound to a predefined shortcut by default, or can run automatically on save. Now a limitation of Godot is that you cannot integrate an add-on with the editor shortcuts yet. So we'd have to code something custom to allow you to change the shortcut.

1 1

Nathan (GDQuest) @gdquest.bsky.social · 11d

Saw that, thanks much!

2

Nathan (GDQuest) @gdquest.bsky.social · 11d

Note that this could certainly be addressed in GDFormat. In part I didn't want to weigh on the open source project of a busy dev. with our unique use cases. Then initially this was just a quick test but well it ends up helping with speed + helps improve GDScript support in 3rd parties so here we are

1 5

Nathan (GDQuest) @gdquest.bsky.social · 11d

We use them in our curriculum to always pull in up-to-date code and use the source code files as a source of truth. They go through a custom parser that picks up the regions + main code definitions and hides the gdquest markup from the output.

1 4

Nathan (GDQuest) @gdquest.bsky.social · 11d

The main thing is lots of custom code regions, typically delineated with comments, at all kinds of indent levels, sometimes dedented compared to the function, sometimes indented with the code, that get hit by vertical spacing rules.

1 3

Nathan (GDQuest) @gdquest.bsky.social · 11d

Then I asked the team about having an option in Godot to use an external formatter. For auto-install, they recommended building an add-on.

An option to give a path to the external formatter could be added but not all other features, so now I think we might as well just have the addon.

1 2

Nathan (GDQuest) @gdquest.bsky.social · 11d

A Rust program like this would not make it into the engine. For a built-in formatter we sponsored this instead a few years back: github.com/godotengine/...

But it's a ton more work and the core team hasn't had the bandwidth to closely follow up on or pick it back up.

Add script formatter, comment parsing in parser, and editor settings by RolandMarchand · Pull Request #76211 · godotengine/godot

This PR builds upon and finalizes the work done in godotengine/godot/pull/55835. This PR introduces a GDScript formatter in Godot's script editor. Users can access it through Edit/Format Code, ...

github.com

1

Nathan (GDQuest) @gdquest.bsky.social · 11d

At the same time, there is this rust technology that makes building and maintaining a code formatter much easier. So I went with that, initially just to try, and within maybe 15-20h of work we had a formatter that handled almost all our code. We could also have features like code reordering.

1 3

Nathan (GDQuest) @gdquest.bsky.social · 11d

As far as formatting goes, it aims to follow the official style guide in both cases.

At GDQuest, we have special markup in our code that wouldn't work well with GDFormat in ways that are not super easy to address.

2 4

Nathan (GDQuest) @gdquest.bsky.social · 11d

The most noticeable difference is speed: it's around 10x faster on a modern computer (with room to make it faster in the future).

Yes, there is a VSCode extension already by a contributor: marketplace.visualstudio.com/items?itemNa...

godot-format - Visual Studio Marketplace

Extension for Visual Studio Code - A formatter for Godot/GDScript using GDQuest's gdscript formatter

marketplace.visualstudio.com

2 2

Nathan (GDQuest) @gdquest.bsky.social · 12d

GDScript code formatting in an instant coming soon in a Godot editor near you.

Works automatically on save too.

4 26 190

Nathan (GDQuest) @gdquest.bsky.social · 14d

Right now the config is through the command line - it's mainly tabs vs spaces for indentation. If there's more configuration you rely on in your work or the editorconfig format, don't hesitate to open an issue.

Note the formatter doesn't support line length and auto-wrapping at the moment.

1

Nathan (GDQuest) @gdquest.bsky.social · 15d

There are multiple people interested in contributing, so if we document potential refactors and improvements, these can be picked up by fellow devs if I can't get to it personally.

1 5

Nathan (GDQuest) @gdquest.bsky.social · 15d

The top priority is making sure the formatter itself is reliable but anything we can easily change or improve along the way or even just note down for later is really welcome.

1 6

Nathan (GDQuest) @gdquest.bsky.social · 15d

Thanks! I have nearly no prior experience in Rust so any feedback an experience rust dev has on the code is most welcome.

1 1 4

Nathan (GDQuest) @gdquest.bsky.social · 15d

The major plus is that instead of requiring hundreds of hours of work it took dozens, for a program that is reliable enough and runs fast enough for production use.

Precompiling and serializing these queries is a planned item on the technology's roadmap, but they still haven't gotten to it.

4

Nathan (GDQuest) @gdquest.bsky.social · 15d

The formatter uses a parser technology called tree-sitter as the backbone, which allows us to run queries on the syntax tree and easily apply formatting rules. The bulk of the runtime in the program is actually that these queries are compiled at runtime and cannot be cached.

1 3

Nathan (GDQuest) @gdquest.bsky.social · 15d

Still, there's room for making it 2 to 4 times faster down the line (some dependent on the libraries we use, some on us).

2 6

Nathan (GDQuest) @gdquest.bsky.social · 15d

It's because while it's fast, it's far from being as fast as a formatter could be - we're trading some speed for the ability to build and maintain a solid formatter for the community without it eating other work.

1 8