CLI-ify (#1)

Converts the extension to a CLI that can be run independent of VS Code,
by shimming the use of `vscode` APIs and adding a new entrypoint.

Author: cole-miller

.esbuild.js

@@ -4,15 +4,14 @@ const watch = process.argv.includes('--watch');
 const minify = watch ? process.argv.includes('--minify') : !process.argv.includes('--no-minify');
 
 const ctx = esbuild.context({
-  entryPoints: ['src/extension.ts'],
+  entryPoints: ['src/cli.ts'],
   tsconfig: './tsconfig.json',
   bundle: true,
-  external: ['vscode'],
+  external: [],
   sourcemap: !minify,
   minify,
   platform: 'node',
-  outdir: 'out',
-  packages: 'bundle',
+  outfile: 'out/cli.js',
 });
 
 ctx

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "extension": ["ts"],
+  "spec": "test/**/*.test.ts",
+  "node-option": ["import=tsx"]
+}

CODE_OF_CONDUCT.md

@@ -1,4 +1,21 @@
-# js-debug-companion
+# js-debug-companion-cli
+
+This is a fork of the original [vscode-js-debug-companion](https://github.com/microsoft/vscode-js-debug-companion) project, which allows running the same code as a standalone process instead of a VS Code extension. It's used by [Zed](https://zed.dev) to support browser debugging in SSH and WSL projects.
+
+The CLI is launched as follows:
+
+```bash
+node out/cli.js --listen=localhost:3000 --state=/path/to/state/dir
+```
+
+This launches a process that will listen for HTTP requests on the specified address. There are two endpoints:
+
+- `POST /launch-and-attach`: Corresponds to the VS Code `js-debug-companion.launchAndAttach` command.
+- `POST /kill`: Corresponds to the VS Code `js-debug-companion.kill` command.
+
+The body for each request should be the same JSON payload that's provided to the corresponding command by vscode-js-debug. The process can handle launching and killing multiple browsers during its lifetime.
+
+## Original vscode-js-debug-companion README
 
 A companion extension to [js-debug](https://github.com/microsoft/vscode-js-debug) to enable remote Chrome debugging. You probably don't want to install this extension by itself, but for your interest, this is what it does.
 

README.md

@@ -1,7 +1,8 @@
 import eslint from '@eslint/js';
 import tseslint from 'typescript-eslint';
 
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-);
+export default tseslint.config(eslint.configs.recommended, ...tseslint.configs.recommended, {
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+});