feat(setup/zephyr): adds support for windows (#224)

* feat(setup/zephyr): adds support for windows

* chore(workflows/release): unset NODE_AUTH_TOKEN

* chore: configure auto to not set npmrc token for publishing

* chore: attempt to resolve npm publishing in CI

* chore: allow release token to updating issues, PRs

Author: HipsterBrown

.github/workflows/release.yml

@@ -11,6 +11,8 @@ env:
 permissions:
   id-token: write
   contents: read
+  issues: write
+  pull-requests: write
 
 jobs:
   release:
@@ -40,13 +42,12 @@ jobs:
         with:
           node-version: 24
           cache: 'pnpm'
-          registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
         run: pnpm install
 
       - name: Release It
         run: |
-          pnpm release
+          NODE_AUTH_TOKEN="" pnpm release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -7,6 +7,10 @@
   "engines": {
     "node": ">=20"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "bin": {
     "xs-dev": "build/src/cli.js"
   },
@@ -116,7 +120,12 @@
   "auto": {
     "plugins": [
       "magic-zero",
-      "npm",
+      [
+        "npm",
+        {
+          "setRcToken": false
+        }
+      ],
       "all-contributors",
       "conventional-commits",
       "first-time-contributor",

src/toolbox/setup/zephyr.ts

@@ -4,14 +4,17 @@ import { INSTALL_DIR, EXPORTS_FILE_PATH } from './constants'
 import upsert from '../patching/upsert'
 import { installDeps as installMacDeps } from './zephyr/mac'
 import { installDeps as installLinuxDeps } from './zephyr/linux'
+import { installDeps as installWinDeps } from './zephyr/windows'
 import { moddableExists } from './moddable'
 import { sourceEnvironment } from '../system/exec'
 import { failure, successVoid, isFailure } from '../system/errors'
 import type { SetupResult } from '../../types'
 import { detectPython } from '../system/python'
+import { ensureModdableCommandPrompt, setEnv } from './windows'
 
 export default async function(): Promise<SetupResult> {
   const OS = platformType().toLowerCase()
+  const isWindows = OS === 'windows_nt'
   const ZEPHYR_ROOT =
     process.env.ZEPHYR_ROOT ?? filesystem.resolve(INSTALL_DIR, 'zephyrproject')
   const ZEPHYR_BASE =
@@ -31,6 +34,11 @@ export default async function(): Promise<SetupResult> {
     )
     return failure('Moddable platform tooling required. Run `xs-dev setup` before trying again.')
   }
+
+  if (isWindows) {
+    const result = await ensureModdableCommandPrompt(spinner)
+    if (isFailure(result)) return result
+  }
   spinner.info('Ensuring zephyr directory')
   filesystem.dir(ZEPHYR_ROOT)
 
@@ -45,6 +53,11 @@ export default async function(): Promise<SetupResult> {
     const result = await installLinuxDeps(spinner)
     if (isFailure(result)) return result
   }
+  if (isWindows) {
+    spinner.start('Installing dependencies with winget')
+    const result = await installWinDeps(spinner)
+    if (isFailure(result)) return result
+  }
   spinner.succeed()
 
   // 2. Create zephyr virtual environment
@@ -60,7 +73,18 @@ export default async function(): Promise<SetupResult> {
     spinner.succeed()
   }
   // 3. Activate virtual environment
-  await upsert(EXPORTS_FILE_PATH, `source ${ZEPHYR_VENV_ACTIVATE}`)
+  if (isWindows) {
+    await upsert(
+      EXPORTS_FILE_PATH,
+      `call "${ZEPHYR_ROOT}\\.venv\\Scripts\\activate.bat"`,
+    )
+    await system.exec(`${ZEPHYR_ROOT}\\.venv\\Scripts\\activate.bat`, {
+      stdout: process.stdout,
+      shell: true,
+    })
+  } else {
+    await upsert(EXPORTS_FILE_PATH, `source ${ZEPHYR_VENV_ACTIVATE}`)
+  }
   await sourceEnvironment()
 
   // 4. Install West with pip
@@ -86,11 +110,19 @@ export default async function(): Promise<SetupResult> {
 
   // 6. Install west packages
   spinner.start(`Installing west packages`)
-  await system.exec(`west packages pip --install`, {
-    process,
-    shell: process.env.SHELL,
-    stdout: process.stdout
-  })
+  if (isWindows) {
+    await system.exec(`cmd /c zephyr\\scripts\\utils\\west-packages-pip-install.cmd`, {
+      cwd: ZEPHYR_ROOT,
+      process,
+      shell: process.env.SHELL,
+    })
+  } else {
+    await system.exec(`west packages pip --install`, {
+      process,
+      shell: process.env.SHELL,
+      stdout: process.stdout
+    })
+  }
   spinner.succeed()
 
   // 7. Install Zephyr SDK 
@@ -103,7 +135,11 @@ export default async function(): Promise<SetupResult> {
   spinner.succeed()
 
   if (process.env.ZEPHYR_BASE === undefined) {
-    await upsert(EXPORTS_FILE_PATH, `export ZEPHYR_BASE=${ZEPHYR_BASE}`)
+    if (isWindows) {
+      await setEnv('ZEPHYR_BASE', ZEPHYR_BASE)
+    } else {
+      await upsert(EXPORTS_FILE_PATH, `export ZEPHYR_BASE=${ZEPHYR_BASE}`)
+    }
   }
 
   print.success(`

src/toolbox/setup/zephyr/windows.ts

@@ -0,0 +1,30 @@
+import { print, system } from 'gluegun'
+import type { GluegunPrint } from 'gluegun'
+import type { Result } from '../../../types'
+import { failure, successVoid } from '../../system/errors'
+
+export async function installDeps(
+  spinner: ReturnType<GluegunPrint['spin']>,
+): Promise<Result<void>> {
+
+  spinner.start('Downloading ESP-IDF Tools Installer')
+  try {
+    await system.exec('where winget')
+  } catch (error) {
+    print.error(
+      'winget is required to install dependencies for Zephyr tooling.',
+    )
+    print.info(
+      'You can install winget via the App Installer package in the Microsoft Store.',
+    )
+    spinner.fail()
+    return failure('winget is required to install dependencies for Zephyr tooling.')
+  }
+  await system.exec(
+    'winget install Kitware.CMake Ninja-build.Ninja oss-winget.gperf Python.Python.3.12 Git.Git oss-winget.dtc wget 7zip.7zip',
+    { stdio: 'inherit', shell: true },
+  )
+  spinner.succeed()
+  return successVoid()
+}
+