Fix windows executable name (#41)

* Extract platform-specific details into platform.ts

* Update ci to work correctly for windows

* Extract workflow script into its own file and update bundle

* Use env variable for version to enable easier updates

* Simplify platform code

* Simplify platform code even further

.github/linters/.eslintrc.yml

@@ -42,6 +42,7 @@ rules:
     'i18n-text/no-en': 'off',
     'import/no-namespace': 'off',
     'no-console': 'off',
+    'no-shadow': 'off',
     'no-unused-vars': 'off',
     'prettier/prettier': 'error',
     'semi': 'off',
@@ -63,6 +64,7 @@ rules:
     '@typescript-eslint/no-namespace': 'error',
     '@typescript-eslint/no-non-null-assertion': 'warn',
     '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-shadow': 'error',
     '@typescript-eslint/no-unnecessary-qualifier': 'error',
     '@typescript-eslint/no-unnecessary-type-assertion': 'error',
     '@typescript-eslint/no-unused-vars': 'error',

.github/workflows/Check-Version.ps1

@@ -0,0 +1,12 @@
+if($args.count -ne 1) {
+    Write-Host "This command requires 1 arg with the version to check"
+    exit 1
+}
+
+$result = pkl.exe --version | Select-String -Pattern $args[0] -Quiet
+
+if($result -eq "True") {
+    exit 0
+} else {
+    exit 1
+}

.github/workflows/ci.yml

@@ -11,6 +11,9 @@ on:
 permissions:
   contents: read
 
+env:
+  CHECK_VERSION: 0.26.0
+
 jobs:
   test-typescript:
     name: TypeScript Tests
@@ -60,7 +63,12 @@ jobs:
         id: test-action
         uses: ./
         with:
-          pkl-version: 0.26.0
+          pkl-version: ${{ env.CHECK_VERSION }}
+
+      - name: Confirm download (unix)
+        run: pkl --version | grep "Pkl ${{ env.CHECK_VERSION }}"
+        if: matrix.os != 'windows-latest'
 
-      - name: Confirm download
-        run: pkl --version
+      - name: Confirm download (windows)
+        run: .github/workflows/Check-Version.ps1 "Pkl ${{ env.CHECK_VERSION }}"
+        if: matrix.os == 'windows-latest'

src/main.ts

@@ -1,7 +1,7 @@
 import * as core from '@actions/core'
 import * as tc from '@actions/tool-cache'
-import os from 'node:os'
 import { chmod } from 'fs/promises'
+import { determinePlatformInfo } from './platform'
 
 /**
  * The main function for the action.
@@ -17,8 +17,8 @@ export async function run(): Promise<void> {
     if (cachedPath) {
       core.debug(`Found cached Pkl version at ${cachedPath}`)
     } else {
-      const assetName = findAssetName()
-      const downloadUrl = `https://github.com/apple/pkl/releases/download/${pklVersion}/${assetName}`
+      const platformInfo = determinePlatformInfo()
+      const downloadUrl = `https://github.com/apple/pkl/releases/download/${pklVersion}/${platformInfo.githubSourceAssetName}`
 
       core.debug(`Download URL: ${downloadUrl}`)
 
@@ -32,7 +32,12 @@ export async function run(): Promise<void> {
       core.debug(`Set executable permissions on: ${pklBinaryPath}`)
 
       // Cache the downloaded file
-      cachedPath = await tc.cacheFile(pklBinaryPath, 'pkl', 'pkl', pklVersion)
+      cachedPath = await tc.cacheFile(
+        pklBinaryPath,
+        platformInfo.targetFileName,
+        'pkl',
+        pklVersion
+      )
       core.debug(`Cached PKL binary to: ${cachedPath}`)
     }
 
@@ -43,26 +48,3 @@ export async function run(): Promise<void> {
     if (error instanceof Error) core.setFailed(error.message)
   }
 }
-
-function findAssetName(): string {
-  const op = os.platform()
-  const arch = os.arch()
-
-  core.info(`Try to find asset name for: ${op}-${arch}`)
-  switch (op) {
-    case 'linux':
-      return 'pkl-linux-amd64'
-    case 'darwin':
-      switch (arch) {
-        case 'x64':
-          return 'pkl-macos-amd64'
-        case 'arm64':
-          return 'pkl-macos-aarch64'
-      }
-      break
-    case 'win32':
-      return 'pkl-windows-amd64.exe'
-  }
-
-  throw new Error(`Couldn't find asset name for ${op}-${arch}`)
-}

src/platform.ts

@@ -0,0 +1,60 @@
+import os from 'node:os'
+
+type Platform = 'linux' | 'macos' | 'windows'
+type Architecture = 'amd64' | 'aarch64'
+
+type PlatformInfo = {
+  githubSourceAssetName: string
+  targetFileName: string
+}
+
+export function determinePlatformInfo(): PlatformInfo {
+  const plat = determineOS()
+  const arch = determineArch()
+
+  return {
+    githubSourceAssetName: determineGithubAsset(plat, arch),
+    targetFileName: determineTargetFileName(plat)
+  }
+}
+
+function determineOS(): Platform {
+  switch (os.platform()) {
+    case 'linux':
+      return 'linux'
+    case 'darwin':
+      return 'macos'
+    case 'win32':
+      return 'windows'
+    default:
+      throw new Error('Unsupported platform')
+  }
+}
+
+function determineArch(): Architecture {
+  switch (os.arch()) {
+    case 'arm64':
+      return 'aarch64'
+    case 'x64':
+      return 'amd64'
+    default:
+      throw new Error('Unsupported architecture')
+  }
+}
+
+function determineGithubAsset(plat: Platform, arch: Architecture): string {
+  if (plat === 'windows') {
+    return `pkl-windows-${arch}.exe`
+  }
+
+  return `pkl-${plat}-${arch}`
+}
+
+function determineTargetFileName(plat: Platform): string {
+  switch (plat) {
+    case 'windows':
+      return 'pkl.exe'
+    default:
+      return 'pkl'
+  }
+}