Merge pull request #1 from AleixMT/main

Automatic GitHub releases and minor quality of life updates

Author: ininavicode

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Build and Release VSCode Extension in GitHub
+
+on:
+  push:
+    branches:
+      - main  # Trigger on pushes to the main branch
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    outputs:
+      current_version: ${{ steps.compute_version.outputs.current_version }}
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install vsce
+        run: npm install -g @vscode/vsce
+
+      - name: Bump Version
+        id: compute_version
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"1
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          echo "Current version: $CURRENT_VERSION"
+          echo "current_version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Build VSIX Package
+        run: vsce package --out arm-syntax-vscode-extension-${{ env.current_version }}.vsix
+        
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: arm-syntax-vscode-extension-${{ needs.build.outputs.current_version }}.vsix
+          tag: v${{ needs.build.outputs.current_version }}
+          name: "Release v${{ needs.build.outputs.current_version }}"
+          body: "Automated release of version v${{ needs.build.outputs.current_version }}"
+          allowUpdates: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+
+

.gitignore

@@ -1,3 +1,5 @@
 TODO.md
 .vscode/
-images/
+
+*.vsix
+

.vscodeignore

@@ -2,3 +2,6 @@
 .vscode-test/**
 .gitignore
 vsc-extension-quickstart.md
+makefile
+.github/
+

README.md

@@ -1,3 +1,5 @@
+[![VSCode extensions marketplace][vscode-shield]][vscode-url]
+
 # ARM Syntax README
 
 ## Author
@@ -10,7 +12,7 @@ Javier Mejias Reverté
 ## Features
 
 Color Syntax Highlighting for ARM Assembly (keywords from **The ARM Instruction Set - ARM University Program - V1.0</**)
-Instruction Set is adapted for **URV - ETSE - DEIM - Computadors**
+Instruction Set is adapted for **URV - ETSE - DEIM - Fonaments de Computadors - Computadors - Estructura de Sistemes Operatius**
 
 Color Syntax Highlighting is applied to the following file extensions:
 - .s
@@ -24,18 +26,64 @@ Configurable color, bold, italic for each keyword type.
 
 ## Installing
 
+### Requirements
+
+None required.
+
 ### From VSCode
 
 1. Open **Extensions** in VSCode
 2. Click the **"..."** button at the top right of the Extensions window
 3. Select **Install from VSIX**
 4. Choose your **.vsix file**
 
+### From shell
+
+1. Open terminal with `Ctrl` + `Alt` + `T` or by opening the Terminal application.
+2. Type the following commands:
+```shell
+LATEST_VERSION=$(curl -s https://api.github.com/repos/ininavicode/arm-syntax-vscode-extension/releases/latest | grep "tag_name" | cut -d '"' -f 4)
+LATEST_VERSION=${VERSION:1}
+wget -O arm-syntax-vscode-extension.vsix \
+  https://github.com/ininavicode/arm-syntax-vscode-extension/releases/download/v${LATEST_VERSION}/arm-syntax-vscode-extension-${LATEST_VERSION}.vsix  # Download latest release
+code --install-extension arm-syntax-vscode-extension.vsix  # Install extension
+```
+
 ---
 
-## Requirements
+## Building
 
-None required.
+### Requirements
+
+* [![nodejs][nodejs-shield]][nodejs-url]
+* [![vsce][vsce-shield]][vsce-url]
+
+### Install build requirements
+
+```shell
+# Install node version manager
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash  
+
+# Set up nvm to use nodeJS 20.x.x
+nvm install 20
+nvm use 20
+
+# Install vsce
+npm install -g @vscode/vsce
+```
+
+### Build instructions
+
+```shell
+# Clone repo
+git clone https://github.com/ininavicode/arm-syntax-vscode-extension
+
+# Navigate inside the folder
+cd arm-syntax-vscode-extension
+
+# Build extension
+vsce package --out arm-syntax-vscode-extension.vsix
+```
 
 ---
 
@@ -76,3 +124,13 @@ Changed default colors
 
 ### V0.0.5
 Fixed error detecting inmediate values.
+
+
+
+[nodejs-shield]: https://img.shields.io/badge/nodeJS-20.x.x-orange?style=for-the-badge&logo=nodedotjs&logoColor=white
+[nodejs-url]: https://nodejs.org/en
+[vsce-shield]: https://img.shields.io/badge/vsce-3.2.1-white?style=for-the-badge&logo=vscodium&logoColor=black
+[vsce-url]: https://github.com/microsoft/vscode-vsce
+[vscode-shield]: https://img.shields.io/visual-studio-marketplace/i/ininavicode.arm-syntax?label=VSCode%20marketplace%20installations
+[vscode-url]: https://marketplace.visualstudio.com/items?itemName=ininavicode.arm-syntax
+

images/logo.png

@@ -0,0 +1,36 @@
+# Variables
+EXTENSION_NAME := arm-syntax-vscode-extension
+VSIX_FILE := $(EXTENSION_NAME).vsix
+
+# Default target
+.PHONY: all
+all: $(VSIX_FILE)
+
+
+# Build the VSCode extension (only if VSIX does not exist)
+$(VSIX_FILE): package.json CHANGELOG.md extension.js language-configuration.json LICENSE README.md images/logo.png syntaxes/arm.tmLanguage.json
+	@echo "🔨 Building the VSCode extension..."
+	@npm install
+	@vsce package --out $(VSIX_FILE)
+	@echo "✅ Build complete: $(VSIX_FILE)"
+
+## Install the VSCode extension
+.PHONY: install
+install: $(VSIX_FILE)
+	@echo "🚀 Installing the VSCode extension..."
+	@code --install-extension $(VSIX_FILE) --force
+	@echo "✅ Extension installed."
+
+## Uninstall the VSCode extension
+.PHONY: uninstall
+uninstall: $(VSIX_FILE)
+	@echo "🗑️ Uninstalling the VSCode extension..."
+	@code --uninstall-extension $(VSIX_FILE)
+	@echo "✅ Extension uninstalled."
+
+## Clean generated files
+.PHONY: clean
+clean:
+	@echo "🧹 Cleaning build artifacts..."
+	@rm -f $(VSIX_FILE)
+	@echo "✅ Clean complete."