README tweaks

This commit is contained in:
cte 2025-03-20 14:52:09 -07:00
parent b7fc099a0c
commit f1fd4bbc2c
2 changed files with 43 additions and 29 deletions

View file

@ -1,5 +1,11 @@
# Benchmark Harness
## Get Started
[Install](https://docs.docker.com/desktop/) Docker Desktop.
## Local Debugging
Install nvm:
```sh
@ -27,11 +33,46 @@ Configure database:
```sh
cp packages/server/.env.sample packages/server/.env
# Update BENCHMARKS_DB_PATH as needed in `packages/server/.env`.
pnpm --filter @benchmark/server db:migrate
pnpm --filter @benchmark/db db:push
```
Run the web ui:
Run the web app:
```sh
pnpm web
```
Run an exercise via the cli:
```sh
pnpm cli run [cpp|go|java|javascript|python|rust|all] [<exercise>|all]
```
## Extension Runner
The extension runner (`@benchmark/runner`) is responsible for spawning VSCode instances and running Roo Code on the benchmark exercises. It leverages the [`@vscode/test-electron`](https://github.com/Microsoft/vscode-test) package to do this.
VS Code provides two CLI parameters for running extension tests, `--extensionDevelopmentPath` and `--extensionTestsPath`.
For example:
```sh
# - Launches VS Code Extension Host
# - Loads the extension at <EXTENSION-ROOT-PATH>
# - Executes the test runner script at <TEST-RUNNER-SCRIPT-PATH>
code \
--extensionDevelopmentPath=<EXTENSION-ROOT-PATH> \
--extensionTestsPath=<TEST-RUNNER-SCRIPT-PATH>
```
If you make extension code changes then you need to re-build it so that `extensionDevelopmentPath` has the latest version transpiled:
```sh
pnpm build:extension
```
If you make changes to `@benchmark/runner` or any of its dependencies then you should rebuild it:
```sh
pnpm build:runner
```

View file

@ -1,27 +0,0 @@
# Extension Runner
VS Code provides two CLI parameters for running extension tests, `--extensionDevelopmentPath` and `--extensionTestsPath`.
For example:
```sh
# - Launches VS Code Extension Host
# - Loads the extension at <EXTENSION-ROOT-PATH>
# - Executes the test runner script at <TEST-RUNNER-SCRIPT-PATH>
code \
--extensionDevelopmentPath=<EXTENSION-ROOT-PATH> \
--extensionTestsPath=<TEST-RUNNER-SCRIPT-PATH>
```
If you make extension code changes then you need to re-build it so that `extensionDevelopmentPath` has the latest version transpiled:
```sh
# From the repository root:
pnpm build:extension
```
If you make changes to `@benchmark/runner` or any of its dependencies then you should rebuild it:
```sh
pnpm build:runner
```