[DRAFT] VSCode Plugin

.github/PUBLISHING.md

@@ -3,6 +3,8 @@
 This document explains how to publish ISL artifacts to Maven Central and GitHub Packages.
 
 ## Prerequisites
+https://intuit-teams.slack.com/archives/C044PJN2NDR/p1749599979127989?thread_ts=1749145553.673049&cid=C044PJN2NDR
+
 
 ### 1. Maven Central (Sonatype OSSRH) Setup
 
@@ -16,24 +18,38 @@ To publish to Maven Central, you need:
 
 ```bash
 # Generate key
-gpg --gen-key
+gpg --full-generate-key
+# Choose RSA (option 1), key size 3072 or 4096, and set a strong passphrase
+
+# List keys to get the key ID
+gpg --list-secret-keys --keyid-format=long
+
+# Export the ASCII-armored secret key (replace KEY_ID with your key ID)
+gpg --export-secret-keys --armor KEY_ID
+```
+
+**For Windows (PowerShell):**
+```powershell
+# Generate key
+gpg --full-generate-key
 
-# List keys to get the key ID (last 8 characters of the fingerprint)
-gpg --list-keys
+# List keys
+gpg --list-secret-keys --keyid-format=long
 
-# Export the key (replace KEY_ID with your key ID)
-gpg --export-secret-keys KEY_ID | base64
+# Export and copy to clipboard
+gpg --export-secret-keys --armor YOUR_KEY_ID | Set-Clipboard
 ```
 
+**Note:** You can use the ASCII-armored key directly in the `SIGNING_KEY` secret (starts with `-----BEGIN PGP PRIVATE KEY BLOCK-----`). Base64 encoding is optional.
+
 ### 2. GitHub Repository Secrets
 
 Configure the following secrets in your GitHub repository (Settings → Secrets and variables → Actions):
 
 #### Maven Central Secrets:
 - `OSSRH_USERNAME`: Your Sonatype JIRA username
 - `OSSRH_PASSWORD`: Your Sonatype JIRA password
-- `SIGNING_KEY_ID`: Your GPG key ID (last 8 characters)
-- `SIGNING_KEY`: Your base64-encoded GPG private key
+- `SIGNING_KEY`: Your ASCII-armored GPG private key (or base64-encoded)
 - `SIGNING_PASSWORD`: Your GPG key passphrase
 
 #### GitHub Packages:
@@ -68,7 +84,7 @@ Configure the following secrets in your GitHub repository (Settings → Secrets
 **Manual Trigger:**
 ```bash
 # Go to Actions → Publish to Maven Central → Run workflow
-# Specify the version (e.g., 2.4.20)
+# Specify the version (e.g., 1.1.2)
 ```
 
 ### 3. Performance Benchmarks (`benchmark.yml`)
@@ -87,8 +103,8 @@ Configure the following secrets in your GitHub repository (Settings → Secrets
 
 1. **Create a Git tag:**
    ```bash
-   git tag -a v2.4.20 -m "Release version 2.4.20"
-   git push origin v2.4.20
+   git tag -a v1.1.0 -m "Release version 1.1.0"
+   git push origin v1.1.0
    ```
 
 2. **Create a GitHub Release:**
@@ -105,7 +121,7 @@ Configure the following secrets in your GitHub repository (Settings → Secrets
 
 1. **Update version in `build.gradle.kts`:**
    ```kotlin
-   version = "2.4.20"  // Remove -SNAPSHOT for releases
+   version = "1.1.0"  // Remove -SNAPSHOT for releases
    ```
 
 2. **Trigger workflow manually:**
@@ -118,12 +134,12 @@ Configure the following secrets in your GitHub repository (Settings → Secrets
 
 The project uses semantic versioning: `MAJOR.MINOR.PATCH`
 
-- **SNAPSHOT versions** (e.g., `2.4.20-SNAPSHOT`):
+- **SNAPSHOT versions** (e.g., `1.1.0-SNAPSHOT`):
   - Published to Sonatype Snapshots repository
   - Used for development builds
   - Automatically overwritten with each publish
 
-- **Release versions** (e.g., `2.4.20`):
+- **Release versions** (e.g., `1.1.0`):
   - Published to Maven Central Staging
   - Requires manual promotion in Sonatype OSSRH
   - Immutable once published
@@ -167,6 +183,17 @@ signing.secretKeyRingFile=/path/to/.gnupg/secring.gpg
 
 ## Troubleshooting
 
+### Issue: "Could not read PGP secret key" or "checksum mismatch"
+**Solution:** 
+1. Use the ASCII-armored format directly (recommended):
+   ```bash
+   gpg --export-secret-keys --armor YOUR_KEY_ID
+   ```
+   Copy the entire output (including BEGIN/END markers) into the `SIGNING_KEY` secret
+2. Ensure `SIGNING_PASSWORD` matches your GPG key passphrase
+3. Verify the key exports correctly before adding to GitHub secrets
+4. If using base64 encoding, ensure no extra whitespace or line breaks are introduced
+
 ### Issue: "Could not find signing key"
 **Solution:** Ensure GPG key is properly exported and base64 encoded. Check `SIGNING_KEY` secret.
 
@@ -186,14 +213,14 @@ Once published to Maven Central, users can add the dependency:
 ### Gradle (Kotlin DSL)
 ```kotlin
 dependencies {
-    implementation("com.intuit.isl:isl-transform:2.4.20")
+    implementation("com.intuit.isl:isl-transform:1.1.0")
 }
 ```
 
 ### Gradle (Groovy)
 ```groovy
 dependencies {
-    implementation 'com.intuit.isl:isl-transform:2.4.20'
+    implementation 'com.intuit.isl:isl-transform:1.1.0'
 }
 ```
 
@@ -202,7 +229,7 @@ dependencies {
 <dependency>
     <groupId>com.intuit.isl</groupId>
     <artifactId>isl-transform</artifactId>
-    <version>2.4.20</version>
+    <version>1.1.0</version>
 </dependency>
 ```
 

.github/workflows/plugin-ci.yml

@@ -0,0 +1,64 @@
+name: Plugin CI
+
+on:
+  push:
+    branches: [ main, plugin ]
+    paths:
+      - 'plugin/**'
+      - '.github/workflows/plugin-ci.yml'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'plugin/**'
+      - '.github/workflows/plugin-ci.yml'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [18.x, 20.x]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        cache-dependency-path: plugin/package-lock.json
+
+    - name: Install dependencies
+      working-directory: plugin
+      run: npm ci
+
+    - name: Lint code
+      working-directory: plugin
+      run: npm run lint || echo "No lint script configured"
+      continue-on-error: true
+
+    - name: Compile TypeScript
+      working-directory: plugin
+      run: npm run compile
+
+    - name: Run tests
+      working-directory: plugin
+      run: npm test || echo "No tests configured"
+      continue-on-error: true
+
+    - name: Package extension
+      working-directory: plugin
+      run: npx vsce package
+
+    - name: Upload build artifact
+      if: matrix.os == 'ubuntu-latest' && matrix.node-version == '18.x'
+      uses: actions/upload-artifact@v4
+      with:
+        name: isl-language-support-build
+        path: plugin/*.vsix
+        retention-days: 7
+

.github/workflows/publish-plugin.yml

@@ -0,0 +1,106 @@
+name: Publish VSCode Extension
+
+on:
+  push:
+    tags:
+      - 'plugin-v*.*.*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (e.g., 1.0.0)'
+        required: true
+      islversion:
+          description: 'Version of ISL to include in the publish (e.g., 1.0.0)'
+          required: true
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Resolve ISL version
+      id: isl-version
+      run: |
+        if [ -n "${{ github.event.inputs.islversion }}" ]; then
+          echo "islVersion=${{ github.event.inputs.islversion }}" >> $GITHUB_OUTPUT
+        elif [[ "${{ github.ref }}" == refs/tags/plugin-v* ]]; then
+          ISL_VER="${GITHUB_REF#refs/tags/plugin-v}"
+          echo "islVersion=$ISL_VER" >> $GITHUB_OUTPUT
+        else
+          ISL_VER=$(grep "^version=" gradle.properties 2>/dev/null | cut -d'=' -f2 | tr -d '\r' || echo "1.1.0")
+          echo "islVersion=$ISL_VER" >> $GITHUB_OUTPUT
+        fi
+        echo "Using ISL version: $(grep islVersion $GITHUB_OUTPUT | cut -d'=' -f2)"
+
+    - name: Set up JDK 21
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'corretto'
+
+    - name: Grant execute permission for gradlew
+      run: chmod +x gradlew
+
+    - name: Build ISL runtime from Maven Central
+      run: ./gradlew :plugin:build-isl-runtime:buildIslRuntime -PislVersion=${{ steps.isl-version.outputs.islVersion }} --no-daemon
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+        cache: 'npm'
+        cache-dependency-path: plugin/package-lock.json
+
+    - name: Install dependencies
+      working-directory: plugin
+      run: npm ci
+
+    - name: Compile TypeScript
+      working-directory: plugin
+      run: npm run compile
+
+    - name: Run tests (if available)
+      working-directory: plugin
+      run: npm test || echo "No tests configured"
+      continue-on-error: true
+
+    - name: Package extension
+      working-directory: plugin
+      run: npx vsce package
+
+    - name: Publish to VSCode Marketplace
+      if: startsWith(github.ref, 'refs/tags/plugin-v')
+      working-directory: plugin
+      env:
+        VSCE_PAT: ${{ secrets.VSCE_TOKEN }}
+      run: npx vsce publish -p $VSCE_PAT
+
+    - name: Publish to Open VSX Registry
+      if: startsWith(github.ref, 'refs/tags/plugin-v')
+      working-directory: plugin
+      env:
+        OVSX_PAT: ${{ secrets.OVSX_TOKEN }}
+      run: npx ovsx publish -p $OVSX_PAT
+      continue-on-error: true
+
+    - name: Upload VSIX artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: isl-language-support-vsix
+        path: plugin/*.vsix
+        retention-days: 90
+
+    - name: Create GitHub Release
+      if: startsWith(github.ref, 'refs/tags/plugin-v')
+      uses: softprops/action-gh-release@v1
+      with:
+        files: plugin/*.vsix
+        generate_release_notes: true
+        draft: false
+        prerelease: false
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+