Create an example using Vitest with Captain

.captain/config.yaml

@@ -0,0 +1,5 @@
+test-suites:
+  captain-examples-vitest:
+    command: npx vitest run --reporter=default --reporter=json --outputFile=./tmp/vitest.json
+    results:
+      path: tmp/vitest.json

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: "Captain Vitest Integration Example"
+on:
+  - push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - uses: rwx-research/setup-captain@v1
+      - run: npm install
+      - run: captain run captain-examples-vitest
+        env:
+          RWX_ACCESS_TOKEN: ${{ secrets.RWX_ACCESS_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+tmp

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2024 ReadWriteExecute, Inc. and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+# Getting Captain working with Vitest
+
+To configure Vitest such that it works with Captain, we need to:
+
+1. 🧪 Ensure vitest produces json output
+
+`npx vitest run --reporter=default --reporter=json --outputFile=./tmp/vitest.json` will produce Captain-compatible JSON output in `tmp/vitest.json`.
+To ensure GitHub logs continue to have test output, also include a stdout-friendly reporter (for example, `--reporter=default`).
+
+```yaml
+# .captain/config.yaml
+test-suites:
+  captain-examples-vitest:
+    command: npx vitest run --reporter=default --reporter=json --outputFile=./tmp/vitest.json
+    results:
+      path: tmp/vitest.json
+```
+
+Additionally, you'll need to make sure `includeTaskLocation` is set to `true` in the `test` section of your Vitest config:
+
+```ts
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    includeTaskLocation: true,
+  },
+});
+```
+
+2. 🔐 Create an Access Token
+
+Create an Access Token for your organization within [Captain][captain] ([more documentation here][create-access-token]).
+
+Add the new token as an action secret to your repository. Conventionally, we call this secret `RWX_ACCESS_TOKEN`.
+
+3. 💌 Install the Captain CLI, and then call it when running tests
+
+See the [full documentation on test suite integration][test-suite-integration].
+
+```yaml
+- uses: rwx-research/setup-captain@v1
+- run: captain run captain-examples-vitest
+  env:
+    RWX_ACCESS_TOKEN: ${{ secrets.RWX_ACCESS_TOKEN }}
+```
+
+4. 🎉 See your test results in Captain!
+
+Take a look at the [final workflow!][workflow-with-captain]
+
+[captain]: https://account.rwx.com/deep_link/manage/access_tokens
+[create-access-token]: https://www.rwx.com/docs/access-tokens
+[workflow-with-captain]: https://github.com/captain-examples/vitest/blob/main/.github/workflows/ci.yml
+[test-suite-integration]: https://www.rwx.com/captain/docs/test-suite-integration