Stale comment re vitest `global: true` for ESM projects

[Tobbe]

Currently for ESM projects we have this in vitest.setup.ts

  // If vitest globals are enabled testing-library will clean up after each
  // test automatically, but we don't enable globals, so we have to manually
  // clean up here
  // https://testing-library.com/docs/react-testing-library/api/#cleanup

And Greptile is complaining

Stale comment contradicts actual config

The comment says globals are not enabled, but vite.config.ts sets globals: true. With Vitest globals mode, @testing-library/react already auto-installs an afterEach cleanup, so this manual cleanup() call is redundant. The comment should be updated (or the manual call removed) to avoid confusion.

I made it global: true to make CJS -> ESM migration easier. And I want to keep it like this when I make ESM default.
Then, after ESM has been default for a while I want to switch to global: false.

But for now I should make the comment match the actual behavior.

[lisa-assistant]

Implementation Plan

The stale comment is in two template files:

• packages/create-cedar-app/templates/esm-ts/web/vitest.setup.ts
• packages/create-cedar-app/templates/esm-js/web/vitest.setup.js

Both say:

// If vitest globals are enabled testing-library will clean up after each
// test automatically, but we don't enable globals, so we have to manually
// clean up here

But globals: true is already set in the corresponding vite.config.ts / vite.config.js under the test block. This means @testing-library/react will automatically call cleanup() after each test — the manual afterEach call is redundant and the comment is wrong.

Fix

In both vitest.setup.ts and vitest.setup.js:

1. Remove the import { cleanup } from '@testing-library/react' line (no longer needed).
2. Remove the entire afterEach block (the framework handles cleanup automatically when globals are enabled).
3. The remaining file should just be the jest-dom import:

import '@testing-library/jest-dom/vitest'

Files to change

• packages/create-cedar-app/templates/esm-ts/web/vitest.setup.ts
• packages/create-cedar-app/templates/esm-js/web/vitest.setup.js

Gotchas

• Confirm that globals: true won't be removed in a future config cleanup before deleting the manual call — if globals were ever turned off again, cleanup would need to be re-added.
• Check if there are any other non-ESM template variants (ts/, js/) that have a similar setup file and similar mismatched comment.

[lisa-assistant]

Self-fix confidence: 9/10
Small, mechanical cleanup with two identical files to update. The only risk is accidentally removing cleanup in a config that doesn't have globals enabled, but both templates clearly show globals: true.

[lisa-assistant]

Implementation Plan

TL;DR: The comment says globals are disabled, but the vite config actually sets . The comment (and the manual call it justifies) should be updated.

Root cause

defaults to , but both the template and the fixture projects override this in their own :

// packages/create-cedar-app/templates/esm-ts/web/vite.config.ts
test: {
  environment: 'jsdom',
  setupFiles: ['./vitest.setup.ts'],
  globals: true,  // ← globally enabled
}

When globals: true, @testing-library/react automatically registers an afterEach(cleanup) hook — so the manual call in vitest.setup.ts is redundant and the comment explaining it is wrong.

Files to change

All of these share the same stale comment + redundant manual cleanup():

File	Status
packages/create-cedar-app/templates/esm-ts/web/vitest.setup.ts	in vite.config
__fixtures__/test-project-esm/web/vitest.setup.ts	in vite.config
__fixtures__/test-project-live/web/vitest.setup.ts	in vite.config
local-testing-project-live/web/vitest.setup.ts	likely same

Change

Replace the incorrect comment. Since globals are enabled and @testing-library/react auto-cleans up, the manual cleanup() is now redundant — it can safely be removed:

Before:

afterEach(() => {
  // If vitest globals are enabled testing-library will clean up after each
  // test automatically, but we don't enable globals, so we have to manually
  // clean up here
  // https://testing-library.com/docs/react-testing-library/api/#cleanup
  cleanup()
})

After (minimal fix — just update the comment):

afterEach(() => {
  // Vitest globals are enabled (see vite.config.ts), so @testing-library/react
  // auto-runs cleanup after each test. This manual call is kept as a safety net
  // in case a project disables globals in its own config.
  // https://testing-library.com/docs/react-testing-library/api/#cleanup
  cleanup()
})

After (cleaner fix — remove the redundant call):

import '@testing-library/jest-dom/vitest'
// No manual cleanup needed — @testing-library/react auto-cleans up
// when vitest globals are enabled (globals: true in vite.config.ts)
// https://testing-library.com/docs/react-testing-library/api/#cleanup

The minimal fix (update the comment but keep ) is safer: it stays correct even if a user's project sets in their vite config, since an extra is always harmless.

Edge cases

• The ts (non-ESM) template doesn't have its own vitest.setup.ts in templates — no change needed there
• If a project overrides globals: false, the manual cleanup() remains meaningful; removing it would cause test pollution. So updating the comment and keeping the call is the safest option.

[lisa-assistant]

Confidence: 9/10

The bug is completely mechanical — a comment written before globals: true was adopted. All three affected files have the same four lines. The only judgment call is whether to remove cleanup() or just update the comment; keeping it is harmless and safer for users who might override to globals: false. Minus one point because the local-testing-project-live fixture needs to be checked too (no vite.config visible in the repo root fixture path).

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.