docs(getting-started): warn that the published base tsconfig disables emit

[kojiwakayama]

Problem

DX dogfood of the published add-to-existing-project page against veryfront@0.1.1239 found a High-severity doc bug: the page leads with

{ "extends": "veryfront/tsconfig.json", "include": ["src", "app"] }

but the shipped base config sets "noEmit": true. A host project whose build emits with tsc keeps exiting 0 after that swap while silently writing nothing — its dist/ goes stale with no warning. That directly contradicts the page's own promise ("Your existing scripts are untouched. Confirm the build you had before still runs").

Repro (published package): plain TS project building tsc -p → dist/; follow the page; edit a source file; npm run build exits 0; node dist/index.js still runs the old code.

Fix

• Warn right after the extends snippet that the base config disables emit, and steer emitting projects to the manual three-option route (or an explicit "noEmit": false" in the build config).
• Extend "Verify it worked" to check output freshness, not just the exit code.

Regression coverage

• guide-code-examples.test.ts: new test pins noEmit: true in build-npm-dnt.ts (the artifact that generates the published tsconfig) to the page carrying the warning — written first, failed for the right reason.
• guide-contracts.test.ts: page contract now requires the "noEmit": true snippet.

Verified: deno test tests/docs/ 56/56, validate-public-docs.ts clean, and the manual-options route empirically re-verified in a sandbox (emit restored while Veryfront serves).

Summary by CodeRabbit

• Documentation

  • Updated the existing-project setup guide to warn that the recommended TypeScript configuration disables JavaScript emission.
  • Added guidance for projects that generate JavaScript with TypeScript, including configuration overrides and build-output verification.

• Tests

  • Added documentation checks to verify the TypeScript setting and ensure the setup guide includes the emission warning and verification steps.

[github-actions]

📦 Client bundle boundary

Entrypoint	Modules	Source size	Server leaks
src/index.client.ts	320	1904 KiB	✅ 0

A server module in a client graph aborts hydration in the browser. New leaks fail CI; known leaks are tracked in scripts/lint/client-bundle-baseline.json to burn down.

[coderabbitai]

Warning

Review limit reached

@kojiwakayama, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 32 minutes

Limit details: You’ve used all 3 included reviews currently available under your plan.

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2aaaeaa0-51c9-4b55-9e47-6472b723885f

📥 Commits

Reviewing files that changed from the base of the PR and between 56f06a7 and c176c56.

📒 Files selected for processing (2)

• docs/getting-started/installation.md
• tests/docs/guide-code-examples.test.ts

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d9276bd9-0b9b-48e9-8619-d667fb149e2b

📥 Commits

Reviewing files that changed from the base of the PR and between a67821a and 56f06a7.

📒 Files selected for processing (3)

• docs/getting-started/add-to-existing-project.md
• tests/docs/guide-code-examples.test.ts
• tests/docs/guide-contracts.test.ts

Included review availability: Your plan includes up to 3 reviews per rolling hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The existing-project guide now documents that Veryfront’s base TypeScript configuration sets noEmit: true. It explains configuration options for projects that emit JavaScript with tsc and adds output verification steps. Tests verify the configuration and guide content.

Changes

TypeScript emission guidance

Layer / File(s)	Summary
Document TypeScript emission behavior docs/getting-started/add-to-existing-project.md	The guide explains that inherited noEmit: true can prevent tsc from writing files. It adds configuration guidance and requires verification of emitted output.
Validate the documented configuration tests/docs/guide-code-examples.test.ts, tests/docs/guide-contracts.test.ts	Tests verify the published configuration and require the guide to document noEmit: true and its emission behavior.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 56f06

This localized documentation and test update is merge-ready after normal checks; no actionable merge-blocking risk remains.

Possibly related PRs

• veryfront/veryfront-code#3358: Both changes update TypeScript configuration guidance involving noEmit.

Suggested reviewers: kwakayama

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the documentation change that warns users that the published base tsconfig disables emit.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/dx-add-existing-noemit

---

_{Comment @coderabbitai help to get the list of available commands.}

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 56f06a7910

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".