From 8fd6f0b4fcb1963f2f2520de52c284a5bfca7bc4 Mon Sep 17 00:00:00 2001 From: Kevin Bloch Date: Wed, 30 Apr 2025 15:43:27 +0200 Subject: [PATCH 1/5] Add track installation instructions --- docs/INSTALLATION.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index cd6ce85..244027a 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -1,15 +1,15 @@ # Installation - +## Using an IDE + +For syntax checking of GDScript files from, for example, [Visual Studio Code](https://code.visualstudio.com/download), you'll need to keep the Godot GUI running with a project open in order to activate the debug server, and an extension like [godot-tools](https://open-vsx.org/vscode/item?itemName=geequlim.godot-tools) installed and activated. From 07cdb3c84c6f2cee2b1c799fadd0e42f4dfcd6f3 Mon Sep 17 00:00:00 2001 From: Kevin Bloch Date: Thu, 1 May 2025 13:37:16 +0200 Subject: [PATCH 2/5] Inline refs and single-sentence-per-line --- docs/INSTALLATION.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 244027a..24f9c33 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -2,7 +2,8 @@ ## Installing Godot Engine -The GDScript track is built on top of [Godot Engine](https://godotengine.org/), which runs on Windows, Linux, macOS, and Android. This track requires Godot version 4.0 or greater. +The GDScript track is built on top of [Godot Engine][godot-engine], which runs on Windows, Linux, macOS, and Android. +This track requires Godot version 4.0 or greater. After completing the installation, you can verify if the CLI was installed successfully by running this command in a terminal: @@ -12,4 +13,8 @@ godot --version ## Using an IDE -For syntax checking of GDScript files from, for example, [Visual Studio Code](https://code.visualstudio.com/download), you'll need to keep the Godot GUI running with a project open in order to activate the debug server, and an extension like [godot-tools](https://open-vsx.org/vscode/item?itemName=geequlim.godot-tools) installed and activated. +For syntax checking of GDScript files from, for example, [Visual Studio Code][vscode], you'll need to keep the Godot GUI running with a project open in order to activate the debug server, and an extension like [godot-tools][godot-tools] installed and activated. + +[godot-engine]: https://godotengine.org/ +[vscode]: https://code.visualstudio.com/download +[godot-tools]: https://open-vsx.org/vscode/item?itemName=geequlim.godot-tools \ No newline at end of file From 444cd35c7eb4c655880fde8af32b4e55d78179d0 Mon Sep 17 00:00:00 2001 From: Kevin Bloch Date: Thu, 1 May 2025 16:57:56 +0200 Subject: [PATCH 3/5] Include test setup instructions --- docs/INSTALLATION.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 24f9c33..b804b6f 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -11,6 +11,39 @@ After completing the installation, you can verify if the CLI was installed succe godot --version ``` +## Installing the Exercism GDScript track test runner + +You'll need [Godot installed][installation] correctly to use the test runner. + +To build and test GDScript scripts for Exercism, Godot will be run in "headless" mode from the CLI. +These instructions currently require Linux and bash. + +### Step 1: Installing the overall test runner infrastructure + +To set up for testing, clone [https://github.com/exercism/gdscript-test-runner][gdscript-test-runner] and move its contents to `/opt/exercism/gdscript/test-runner/`: + +```sh +git clone https://github.com/exercism/gdscript-test-runner.git +sudo mv gdscript-test-runner/ /opt/exercism/gdscript/test-runner/ +``` + +### Step 2: Downloading the single-exercise test runner script + +Assuming you have the `exercism` tool set up and have downloaded at least one GDScript exercise, it should have created an `exercism/gdscript` folder to house the exercises. +Save [the test runner][test-local-gdscript-solution] in this folder and mark the file executable. + +## Running tests + +With the installation steps done, you should be able start from any exercise directory (e.g., `~/exercism/gdscript/two-fer`) and run the script (living one level up, in `../`) to test your local solution to that exercise: + +```sh +../test-local-gdscript-solution.sh +``` + +[installation]: https://exercism.org/docs/tracks/gdscript/installation +[gdscript-test-runner]: https://github.com/exercism/gdscript-test-runner +[test-local-gdscript-solution]: https://raw.githubusercontent.com/exercism/gdscript-test-runner/refs/heads/main/bin/test-local-gdscript-solution.sh + ## Using an IDE For syntax checking of GDScript files from, for example, [Visual Studio Code][vscode], you'll need to keep the Godot GUI running with a project open in order to activate the debug server, and an extension like [godot-tools][godot-tools] installed and activated. From 107e96190ff28fd802854eeb2d2b78567c4f6869 Mon Sep 17 00:00:00 2001 From: Kevin Bloch Date: Thu, 17 Jul 2025 14:48:25 +0200 Subject: [PATCH 4/5] Add clarifications: - Linux requirement for local test runner - Syntax highlighting "etc." - Requirements for keeping a debug server running --- docs/INSTALLATION.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index b804b6f..3d8bb00 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -3,6 +3,7 @@ ## Installing Godot Engine The GDScript track is built on top of [Godot Engine][godot-engine], which runs on Windows, Linux, macOS, and Android. +For the moment, the test runner for [working locally][working-locally] requires Linux. This track requires Godot version 4.0 or greater. After completing the installation, you can verify if the CLI was installed successfully by running this command in a terminal: @@ -46,8 +47,10 @@ With the installation steps done, you should be able start from any exercise dir ## Using an IDE -For syntax checking of GDScript files from, for example, [Visual Studio Code][vscode], you'll need to keep the Godot GUI running with a project open in order to activate the debug server, and an extension like [godot-tools][godot-tools] installed and activated. +For features like syntax highlighting of GDScript files from, for example, [Visual Studio Code][vscode], you'll need an extension like [godot-tools][godot-tools] installed and activated, and a running debug server. +When you open the Godot GUI and open a project, a debug server automatically runs in the background until you close the project or Godot. [godot-engine]: https://godotengine.org/ +[working-locally]: /docs/using/solving-exercises/working-locally.md [vscode]: https://code.visualstudio.com/download [godot-tools]: https://open-vsx.org/vscode/item?itemName=geequlim.godot-tools \ No newline at end of file From c82456fc08d9632c6e65fceac931951abe364d89 Mon Sep 17 00:00:00 2001 From: Kevin Bloch Date: Thu, 17 Jul 2025 18:17:36 +0200 Subject: [PATCH 5/5] Fix exercism workspace location --- docs/INSTALLATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 3d8bb00..c0bfcb0 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -30,7 +30,7 @@ sudo mv gdscript-test-runner/ /opt/exercism/gdscript/test-runner/ ### Step 2: Downloading the single-exercise test runner script -Assuming you have the `exercism` tool set up and have downloaded at least one GDScript exercise, it should have created an `exercism/gdscript` folder to house the exercises. +Assuming you have the `exercism` tool set up and have downloaded at least one GDScript exercise, it should have created a `gdscript` folder under your workspace (as shown by running `exercism configure`) to house the exercises. Save [the test runner][test-local-gdscript-solution] in this folder and mark the file executable. ## Running tests