Skip to content

docs: enhance typed-router.d.ts docs and add section for using sfc-typed-router #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: enhance typed-router.d.ts docs and add section for using sfc-typed-router #687

wants to merge 1 commit into from

Conversation

Anoesj
Copy link
Contributor

@Anoesj Anoesj commented Aug 8, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Expanded and clarified TypeScript usage guidance, including detailed explanations of exported types and interfaces.
    • Improved instructions for manually typing dynamically added routes, with updated augmentation examples.
    • Added a new section on enabling and using the sfc-typed-router Volar plugin for enhanced type safety.
    • Corrected configuration file references and added notes about Volar plugin integration in Nuxt documentation.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Aug 8, 2025 •
edited
Loading

Walkthrough

The documentation for TypeScript and Nuxt integration with unplugin-vue-router was expanded. Details about exported types, manual augmentation for dynamic routes, and Volar plugin usage were added or clarified. Minor corrections were made to filename extensions and plugin enablement notes in Nuxt documentation.

Changes

Cohort / File(s) Change Summary
TypeScript Usage Documentation
docs/guide/typescript.md		 Expanded and clarified documentation on exported types, manual augmentation, and Volar plugin integration.
Nuxt Getting Started Docs
docs/nuxt/getting-started.md		 Corrected config filename, added note on Volar plugin enablement, and linked to manual instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Suggested reviewers

  • posva

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov Codecov
Copy link

codecov bot commented Aug 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.90%. Comparing base (2d20014) to head (e5c1100).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #687   +/-   ##
=======================================
  Coverage   60.90%   60.90%           
=======================================
  Files          36       36           
  Lines        3379     3379           
  Branches      618      618           
=======================================
  Hits         2058     2058           
  Misses       1314     1314           
  Partials        7        7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai[bot]
coderabbitai bot reviewed Aug 8, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/guide/typescript.md (2)

24-26: Extension mismatch in import snippet

Snippet imports ./typed-router.d, while the file generated earlier is typed-router.d.ts. Append the .ts extension to avoid “file not found” issues in strict TS setups.

56-60: Small wording tweak for clarity

Consider replacing “you should also augment” with “you must also augment” to emphasise the requirement when the Volar plugin is used.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d20014 and e5c1100.

📒 Files selected for processing (2)
  • docs/guide/typescript.md (3 hunks)
  • docs/nuxt/getting-started.md (2 hunks)
🔇 Additional comments (5)
docs/guide/typescript.md (3)

36-50: Great addition—clearly documents generated helper types

The added explanation of RouteNamedMap, _RouteFileInfoMap, and _RouteNamesForFilePath makes the generated file much easier to reason about. No further action needed.

95-108: Example paths look good

The augmentation example is correct and mirrors real catch-all route syntax. 👍

143-171: Nuxt/Volar setup instructions are spot-on

The config snippets are accurate and match current Nuxt expectations. Nice work.

docs/nuxt/getting-started.md (2)

3-11: Filename correction acknowledged

Switch to nuxt.config.ts is correct and prevents confusion in TS projects.

13-13: Verify anchor link

Double-check the URL /guide/typescript#using-the-sfc-typed-router-volar-plugin renders correctly on the deployed docs site (some generators strip the leading slash).

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

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Anoesj