Skip to content

Commit 5566648

Browse files
committed
Add instructions on how to use the formatter in VSCode to the readme
Close #137
1 parent 04c08ee commit 5566648

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,22 @@ obj._private_method() # gdlint-ignore
159159
> [!NOTE]
160160
> If you managed to make the formatter work in a code editor that isn't listed here, consider contributing to this section or sharing your findings in [this](https://github.com/GDQuest/GDScript-formatter/issues/26) issue.
161161
162+
In this section, you'll find instructions for setting up the formatter in several code editors.
163+
164+
As a reminder: **don't turn this on when working on an important project without using a version control system like Git!**.
165+
166+
### VSCode
167+
168+
1. Install the [godot-format extension](https://marketplace.visualstudio.com/items?itemName=DoHe.godot-format) in VSCode. Press `Ctrl+P` and run:
169+
170+
```
171+
ext install DoHe.godot-format
172+
```
173+
174+
2. This extension ships with the formatter binary pre-installed, so you don't need to download the formatter separately.
175+
176+
Once installed, visit the [extension page](https://marketplace.visualstudio.com/items?itemName=DoHe.godot-format) to see the available settings and set your preferences.
177+
162178
### Zed
163179

164180
1. Install the formatter (see instructions above).
@@ -214,8 +230,6 @@ Keep in mind, using gdscript with Helix [requires more configuration](https://gi
214230
auto-format = true
215231
```
216232

217-
As a reminder: **don't leave this on when working on an important project without using a VCS!**.
218-
219233
### JetBrains Rider
220234

221235
1. First, install the formatter on your computer.
@@ -232,7 +246,6 @@ As a reminder: **don't leave this on when working on an important project withou
232246
- You can optionally check any of the checkboxes for auto-save and triggering the watcher when files change outside the editor.
233247
- Keep the box for `Create output file from stdout` unchecked.
234248

235-
As a reminder: **don't turn this on when working on an important project without using a VCS like Git!**.
236249

237250
If you lose work because of the formatter, you can usually get it back with a simple "undo" (Cmd/Ctrl + Z). This will show you the "undo reload from disk" popup. You can also check the local history by right-clicking on the file in the project explorer and selecting `Local History > Show History`.
238251

0 commit comments

Comments
 (0)