Skip to content

Update testing docs to reference Bun test and preload setup#398

Merged
zz-plant merged 1 commit into
mainfrom
codex/locate-and-fix-issues-in-repo
Jan 14, 2026
Merged

Update testing docs to reference Bun test and preload setup#398
zz-plant merged 1 commit into
mainfrom
codex/locate-and-fix-issues-in-repo

Conversation

@zz-plant

Copy link
Copy Markdown
Owner

Motivation

  • Documentation still referred to Vitest and an absent vitest.config.ts, which could confuse contributors running tests.
  • Align docs with the repository's actual test tooling and preload setup to make local testing instructions accurate.

Description

  • Updated docs/testing-todos.md to replace Vitest references with bun test and to describe the bunfig.toml preload of src/test/preload.ts for happy-dom and Astro virtual module mocks.
  • Reworded docs/diagnostics-capacity-forecaster.md to reference Bun test coverage for the projection engine tests.
  • Ran Prettier formatting on the edited docs with bunx prettier --write to keep style consistent.

Testing

  • This is a docs-only change so no unit or E2E test suites were run and bun run check was intentionally skipped.
  • Prettier formatting was executed with bunx prettier --write and completed without modifying content beyond the intended edits.

Codex Task

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jan 14, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
et3 318a4ae Commit Preview URL

Branch Preview URL
Jan 14 2026, 03:39 PM

@zz-plant zz-plant merged commit 75d7ee5 into main Jan 14, 2026
1 of 2 checks passed
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @zz-plant, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the project's documentation to accurately reflect the current testing infrastructure, transitioning all references from Vitest to Bun test. The changes provide clear and correct instructions for contributors on how to run tests and understand the project's test setup, including details on Bun's configuration and preload mechanisms. This ensures that the documentation remains aligned with the actual development environment, preventing confusion and streamlining the testing process for developers.

Highlights

  • Testing Documentation Update: Replaced all references to Vitest with Bun test across the testing documentation to reflect the current tooling.
  • Bun Test Configuration Clarification: Detailed the Bun test setup, including its configuration via bunfig.toml and the preloading of src/test/preload.ts for happy-dom and Astro virtual module mocks.
  • Diagnostic Document Alignment: Updated docs/diagnostics-capacity-forecaster.md to correctly state Bun test coverage for the projection engine tests.
  • Code Formatting: Applied Prettier formatting to the modified documentation files to maintain consistent style.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the testing documentation to replace references to Vitest with bun test, aligning the docs with the project's current tooling. The changes in docs/testing-todos.md and docs/diagnostics-capacity-forecaster.md are accurate and improve clarity. I have provided one suggestion for docs/testing-todos.md to re-introduce the command for running tests in watch mode, as this is a common developer workflow that was mentioned in the previous version of the documentation.

Comment thread docs/testing-todos.md
Comment on lines +10 to +11
modules. Run `bun test` for local coverage and `bun run test:unit:ci` for a full run with the lcov
reporter.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The previous version of the documentation mentioned running tests in watch mode, which is a very common development workflow. This information was lost in the update. It would be helpful to include how to run tests in watch mode with bun test for completeness.

Suggested change
modules. Run `bun test` for local coverage and `bun run test:unit:ci` for a full run with the lcov
reporter.
modules. Run `bun test` for local coverage or `bun test --watch` for watch mode. Use `bun run test:unit:ci`
for a full run with the lcov reporter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant