Simplify Testing in Codespaces #6

rcosta358 · web-flow · commit db87beab13fe · 2025-09-15T20:09:59.000+01:00
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,5 +1,5 @@
 {
-  "name": "LiquidJava Extension Dev",
+  "name": "LiquidJava Demo",
   "image": "mcr.microsoft.com/devcontainers/javascript-node:20",
   "customizations": {
     "vscode": {
@@ -13,5 +13,6 @@
       "version": "21"
     }
   },
-  "postAttachCommand": "bash ./setup.sh"
+  "workspaceFolder": "/workspaces/liquidjava-examples/examples/demo",
+  "postAttachCommand": "cd ../../ && bash setup.sh && cd ./examples/demo"
 }
diff --git a/README.md b/README.md
@@ -8,27 +8,21 @@ For more information about LiquidJava, visit our [website](https://catarinagambo
 
 ## Development Environment Setup
 🚀 Check the following video on the setup:
-![Video of the steps above](./figs/steps2.gif)
+![Video of the steps below](./figs/steps2.gif)
 
 ### Setup Instructions
 
-#### Option 1: Using Codespaces or Dev Containers (Recommended)
+#### Option 1: Using Codespaces (Recommended)
 
-1. Open the repository in GitHub Codespaces or use VS Code's "Remote-Containers: Open Folder in Container" command.
-2. Install the extension: View → Extensions →  Click on the "..." (More Actions) button → Install from VSIX → `/workspaces/liquidjava-examples/extension/liquid-java-0.0.15.vsix`.
-3. After the information that the extension is activated, do `Ctrl + Shift + P` and write `Developer: Reload Window `
-5. Open examples: File → Open Folder → `examples/demo/src/`.
-6. You can try changing the example to see an error appear.
-7. If needed, reload window again using `Developer: Reload Window `.
+- To use Codespaces, make sure you’re logged in to GitHub, click the button below, select `4-core`, and then press `Create codespace`. The codespace will open in your browser and will automatically install the LiquidJava extension shortly after.
 
+   [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/CatarinaGamboa/liquidjava-examples)
 
-#### Extension Activation
+#### Option 2: Using Dev Containers
 
-- The extension may take some time to be activated. While a small wheel in the bottom right of VS Code window is spinning, the extension is being loaded.
-- The extension will only activate when opening a Java project with the liquidjava-api.jar present.
-  
+- If you prefer to test it locally, you can use VS Code's Dev Containers. Make sure you have Docker and the Dev Containers extension installed in VS Code and use the "Remote-Containers: Open Folder in Container" command. Then, run the `setup.sh` script to install the extension.
 
-#### Option 2: Manual Setup
+#### Option 3: Manual Setup
 
 If the automatic setup didn't work correctly, follow these manual steps:
 
@@ -55,17 +49,22 @@ If the automatic setup didn't work correctly, follow these manual steps:
    code --install-extension extension/liquid-java-0.0.15.vsix
    ```
 
-4. Ensure the redhat extension for [Language Support for Java™](https://marketplace.visualstudio.com/items?itemName=redhat.java) is installed and enabled.
+4. Ensure the Red Hat extension for [Language Support for Java™](https://marketplace.visualstudio.com/items?itemName=redhat.java) is installed and enabled.
 
-5. Open examples:
-   - Go to File → Open Folder → examples/demo/src/
+5. Open the examples:
+   - Go to File → Open Folder → examples/demo
    - Or use the terminal:
    ```bash
    code examples/demo/src/
    ```
 
 ### Troubleshooting
 
+#### Extension Activation
+
+- The extension will only activate when opening a Java project with the `liquidjava-api.jar` present in the workspace.
+- If the extension doesn't activate properly, do `Ctrl + Shift + P` and run `Developer: Reload Window`.
+
 #### VSIX File Issues
 
 If you see "End of central directory record signature not found" or similar errors:
@@ -80,17 +79,16 @@ If you see "End of central directory record signature not found" or similar erro
    cat ./extension/liquid-java-0.0.15.vsix | head
    ```
 
-
 ## Working with the Extension
 
 1. Ensure your project is correctly set up with the `liquidjava-api.jar`.
 2. When opening a Java file, the extension will automatically verify your LiquidJava annotations.
 3. Errors will be highlighted directly in your code editor.
+4. An item in the status bar at the bottom left of the editor indicates the extension's current state. You can check the extension logs by clicking on it.
 
 ## Download JARs
 
-`examples/demo/lib` folder contains the api jar that you can use in your projects.
-
+`examples/demo/lib` folder contains the API jar necessary to run LiquidJava.
 
 ## Examples
 ```
diff --git a/extension/liquid-java-0.0.15.vsix b/extension/liquid-java-0.0.15.vsix
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:f50a6b69bba572d93307ad9b632a0bde81403191488add5507f09c20b496559e
-size 137035339
+oid sha256:64ef446a47ddf814049c569dbc11039ac5e08b005a8cf3a5a5bb909b75864c95
+size 209253467
diff --git a/setup.sh b/setup.sh
@@ -1,5 +1,11 @@
 #!/bin/bash
 
+# Check if extension is already installed
+if code --list-extensions | grep -q "liquid-java" 2>/dev/null; then
+    echo "✅ LiquidJava extension already installed!"
+    exit 0
+fi
+
 # Setup script for LiquidJava development environment
 echo "🚀 Starting LiquidJava development environment setup..."
 
@@ -38,6 +44,13 @@ else
     find . -type d -maxdepth 2 | sort
 fi
 
-echo "🎉 Setup complete! Please follow these manual steps:"
-echo "1. Install the extension: View → Extensions → ... → Install from VSIX → extension/liquid-java-0.0.15.vsix"
-echo "2. Open examples: File → Open Folder → examples/demo/src/"
+# Install extension
+echo "🔧 Installing LiquidJava VSCode extension..."
+code --install-extension ./extension/liquid-java-0.0.15.vsix
+if [ $? -eq 0 ]; then
+    echo "✅ Extension installed successfully"
+else
+    echo "❌ Failed to install the extension"
+fi
+
+echo "🎉 Setup complete!"

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "LiquidJava Extension Dev",`
	`2`	`+ "name": "LiquidJava Demo",`
`3`	`3`	`"image": "mcr.microsoft.com/devcontainers/javascript-node:20",`
`4`	`4`	`"customizations": {`
`5`	`5`	`"vscode": {`
`@@ -13,5 +13,6 @@`
`13`	`13`	`"version": "21"`
`14`	`14`	`}`
`15`	`15`	`},`
`16`		`- "postAttachCommand": "bash ./setup.sh"`
	`16`	`+ "workspaceFolder": "/workspaces/liquidjava-examples/examples/demo",`
	`17`	`+ "postAttachCommand": "cd ../../ && bash setup.sh && cd ./examples/demo"`
`17`	`18`	`}`