@dbalabka/chrome-wsl 0.2.4 → 0.3.0

package/README.md

@@ -17,7 +17,9 @@ A small WSL helper to open Google Chrome on Windows with remote debugging (port
 - Windows Chrome installed at `C:\Program Files\Google\Chrome\Application\chrome.exe` (adjust the path in the script if different).
 - Network/apt access to install `socat` on first run (or preinstall manually).
 
-## Usage (npx)
+## Usage
+
+### with NPX
 ```sh
 npx @dbalabka/chrome-wsl
 ```
@@ -25,10 +27,42 @@ npx @dbalabka/chrome-wsl
 - The script logs `socat` output to `/tmp/socat-9222.log`.
 - To stop the `socat` forwarder:
 ```sh
- npx @dbalabka/chrome-wsl -- --stop
+ npx @dbalabka/chrome-wsl --stop
+```
+- To uninstall (prompts before removing the firewall rule and socat):
+```sh
+ npx @dbalabka/chrome-wsl --uninstall
 ```
 - Runs directly via npm without cloning; default entrypoint is `chrome-wsl` (matching the package name).
-- To install globally instead of npx: `npm install -g @dbalabka/chrome-wsl` then run `chrome-wsl` or `chrome-wsl --stop`.
+
+#### Example
+```sh
+❯ npx @dbalabka/chrome-wsl
+✅ Detected Windows host IP: 172.18.112.1
+✅ Portproxy 172.18.112.1:9222 -> 127.0.0.1:9222 is configured.
+✅ Firewall rule "Chrome Remote Debug" exists.
+✅ socat is already installed.
+✅ Started socat (logging to /tmp/socat-9222.log).
+✅ Launched Chrome (pid 32408) with remote debugging.
+✅ Chrome is listening on port 9222.
+```
+```sh
+❯ npx @dbalabka/chrome-wsl --stop
+✅ Stopped tracked Chrome process (pid 32408).
+✅ Stopped socat forwarding for port 9222.
+```
+
+### with NPM
+To install globally instead of npx:
+  ```sh
+  npm install -g @dbalabka/chrome-wsl
+  ```
+Then run:
+  ```sh
+  chrome-wsl
+  chrome-wsl --stop
+  chrome-wsl --uninstall
+  ```
 
 ## Notes
 - Portproxy check expects forwarding from the detected Windows host IP to `127.0.0.1:9222`.

package/chrome-wsl

@@ -64,8 +64,37 @@ stop_socat() {
 }
 
 run_powershell() {
-  # Runs a PowerShell command from WSL.
-  powershell.exe -NoLogo -NoProfile -NonInteractive -Command "$@"
+  # Runs a PowerShell command from WSL. If RUN_AS_ADMIN=1, invoke via Start-Process -Verb RunAs
+  # and capture output through a temp script/output file to mirror direct execution.
+  local ps_cmd="$*"
+
+  if [[ "${RUN_AS_ADMIN:-}" == "1" ]]; then
+    local out_file ps_file win_out win_ps
+    mkdir -p /mnt/c/Temp
+    out_file=$(mktemp -p /mnt/c/Temp chrome-wsl-out-XXXXXX)
+    ps_file=$(mktemp -p /mnt/c/Temp --suffix=.ps1 chrome-wsl-XXXXXX)
+    win_out=$(wslpath -w "$out_file")
+    win_ps=$(wslpath -w "$ps_file")
+
+    {
+      echo "& {"
+      echo "  ${ps_cmd}"
+      echo "} | Out-File -FilePath \"${win_out}\" -Encoding UTF8"
+    } >"$ps_file"
+
+    powershell.exe -NoLogo -NoProfile -NonInteractive -Command "Start-Process -FilePath 'powershell' -Verb RunAs -ArgumentList '-NoLogo','-NoProfile','-NonInteractive','-File','\"${win_ps}\"' -WindowStyle Hidden -Wait"
+    cat "$out_file"
+    rm -f "$out_file" "$ps_file"
+  else
+    powershell.exe -NoLogo -NoProfile -NonInteractive -Command "$ps_cmd"
+  fi
+}
+
+confirm() {
+  local prompt=$1
+  local reply
+  read -r -p "${prompt} [y/N] " reply
+  [[ "${reply}" =~ ^[Yy]$ ]]
 }
 
 chrome_running() {
@@ -89,6 +118,10 @@ port_listening_info() {
   run_powershell "\$conns = Get-NetTCPConnection -LocalPort ${PORT} -ErrorAction SilentlyContinue | Select-Object -Property LocalAddress,LocalPort,RemoteAddress,RemotePort,State,OwningProcess; foreach (\$c in \$conns) { \$p = Get-Process -Id \$c.OwningProcess -ErrorAction SilentlyContinue; \$name = if (\$p) { \$p.Name } else { 'unknown' }; Write-Output (\"{0}:{1} owner={2} pid={3} state={4}\" -f \$c.LocalAddress, \$c.LocalPort, \$name, \$c.OwningProcess, \$c.State) }"
 }
 
+port_in_use_by_non_chrome() {
+  run_powershell "if (Get-NetTCPConnection -LocalPort ${PORT} -ErrorAction SilentlyContinue | Where-Object { \$p = Get-Process -Id \_.OwningProcess -ErrorAction SilentlyContinue; -not (\$p -and \$p.Name -eq 'chrome') }) { exit 0 } else { exit 1 }"
+}
+
 get_wsl_host_ip() {
   local host_ip
   host_ip=$(ip route | awk '/^default via / {print $3; exit}')
@@ -118,19 +151,68 @@ EOF
 }
 
 check_firewall_rule() {
-  if run_powershell "\$rule='${FIREWALL_RULE_NAME}'; if (Get-NetFirewallRule -DisplayName \$rule -ErrorAction SilentlyContinue) { exit 0 } else { exit 1 }"; then
+  local rule_check_cmd="\$rule='${FIREWALL_RULE_NAME}'; if (Get-NetFirewallRule -DisplayName \$rule -ErrorAction SilentlyContinue) { exit 0 } else { exit 1 }"
+
+  if run_powershell "${rule_check_cmd}"; then
     ok "Firewall rule \"${FIREWALL_RULE_NAME}\" exists."
     return 0
   fi
 
+  err "Firewall rule \"${FIREWALL_RULE_NAME}\" is missing; attempting to create it (may prompt for admin)."
+  if RUN_AS_ADMIN=1 run_powershell "New-NetFirewallRule -DisplayName \"${FIREWALL_RULE_NAME}\" -Direction Inbound -LocalPort ${PORT} -Protocol TCP -Action Allow" \
+     && run_powershell "${rule_check_cmd}"; then
+    ok "Created firewall rule \"${FIREWALL_RULE_NAME}\"."
+    return 0
+  fi
+
   cat <<EOF
-${ERR_MARK} Firewall rule "${FIREWALL_RULE_NAME}" is missing.
+${ERR_MARK} Failed to create firewall rule "${FIREWALL_RULE_NAME}" automatically.
 Run this in an **admin PowerShell** window:
 New-NetFirewallRule -DisplayName "${FIREWALL_RULE_NAME}" -Direction Inbound -LocalPort ${PORT} -Protocol TCP -Action Allow
 EOF
   return 1
 }
 
+uninstall_firewall_rule() {
+  local rule_check_cmd="\$rule='${FIREWALL_RULE_NAME}'; if (Get-NetFirewallRule -DisplayName \$rule -ErrorAction SilentlyContinue) { exit 0 } else { exit 1 }"
+
+  if ! run_powershell "${rule_check_cmd}"; then
+    ok "Firewall rule \"${FIREWALL_RULE_NAME}\" is already absent."
+    return 0
+  fi
+
+  if ! confirm "Remove firewall rule \"${FIREWALL_RULE_NAME}\"?"; then
+    ok "Skipped firewall rule removal."
+    return 0
+  fi
+
+  if RUN_AS_ADMIN=1 run_powershell "Remove-NetFirewallRule -DisplayName \"${FIREWALL_RULE_NAME}\"" \
+     && ! run_powershell "${rule_check_cmd}"; then
+    ok "Removed firewall rule \"${FIREWALL_RULE_NAME}\"."
+  else
+    err "Failed to remove firewall rule \"${FIREWALL_RULE_NAME}\"."
+  fi
+}
+
+uninstall_socat() {
+  if ! command -v socat >/dev/null 2>&1; then
+    ok "socat is not installed; nothing to remove."
+    return 0
+  fi
+
+  if ! confirm "Remove socat package (sudo apt-get remove -y socat)?"; then
+    ok "Skipped socat removal."
+    return 0
+  fi
+
+  stop_socat
+  if sudo apt-get remove -y socat; then
+    ok "Removed socat package."
+  else
+    err "Failed to remove socat package."
+  fi
+}
+
 ensure_socat() {
   if command -v socat >/dev/null 2>&1; then
     ok "socat is already installed."
@@ -185,6 +267,11 @@ start_chrome() {
     fi
   fi
 
+  if port_in_use_by_non_chrome; then
+    err "Port ${PORT} is already in use by another process (not Chrome); details:"
+    port_listening_info
+  fi
+
   local chrome_pid
   chrome_pid=$(run_powershell "$chrome_cmd" | tr -d '\r' | head -n 1)
   if [[ -n "${chrome_pid:-}" ]]; then
@@ -203,6 +290,12 @@ start_chrome() {
 }
 
 main() {
+  if [[ "${1-}" == "--uninstall" ]]; then
+    uninstall_firewall_rule
+    uninstall_socat
+    exit 0
+  fi
+
   if [[ "${1-}" == "--stop" ]]; then
     stop_chrome
     stop_socat

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbalabka/chrome-wsl",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "WSL helper to start Windows Chrome with remote debugging and socat port forwarding.",
   "bin": "./chrome-wsl",
   "files": [
@@ -18,11 +18,14 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dbalabka/wsl-chrome-portproxy-launcher.git"
+    "url": "git+https://github.com/dbalabka/chrome-wsl.git"
   },
   "author": "Dmitry Balabka",
   "bugs": {
-    "url": "https://github.com/dbalabka/wsl-chrome-portproxy-launcher/issues"
+    "url": "https://github.com/dbalabka/chrome-wsl/issues"
   },
-  "homepage": "https://github.com/dbalabka/wsl-chrome-portproxy-launcher#readme"
+  "homepage": "https://github.com/dbalabka/chrome-wsl#readme",
+  "publishConfig": {
+    "access": "public"
+  }
 }