feat: volar plugins

[Anoesj]

• Moved existing Volar plugin for <route> block IntelliSense into src, added it to the building process and added it to exports
  • explain in the docs how users can enable the plugin (by adding it to vueCompilerOptions.plugins)
• Added Volar plugin for improved useRoute and $route typings
  • explain in the docs how users can enable the plugin (by adding it to vueCompilerOptions.plugins)
  • add tests
  • update playground examples
  • use relative paths

Future

• Explore other solutions for structuring types, e.g. like how they do it in SvelteKit
• Explore adding enhanced typing for <RouterView> slots regarding named views

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/unplugin-vue-router@609

commit: a5e63cb

[codecov]

Codecov Report

Attention: Patch coverage is 29.55665% with 143 lines in your changes missing coverage. Please review.

Project coverage is 59.85%. Comparing base (cd4a3f8) to head (a5e63cb).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
src/volar/entries/sfc-typed-router.ts	0.00%	55 Missing and 1 partial ⚠️
src/volar/entries/sfc-route-blocks.ts	0.00%	49 Missing and 1 partial ⚠️
src/volar/utils/augment-vls-ctx.ts	4.76%	20 Missing ⚠️
src/codegen/generateDTS.ts	0.00%	11 Missing ⚠️
src/core/context.ts	0.00%	4 Missing ⚠️
src/codegen/generateRouteFileInfoMap.ts	96.72%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #609      +/-   ##
==========================================
- Coverage   61.72%   59.85%   -1.87%     
==========================================
  Files          32       36       +4     
  Lines        3135     3333     +198     
  Branches      580      601      +21     
==========================================
+ Hits         1935     1995      +60     
- Misses       1194     1330     +136     
- Partials        6        8       +2     

☔ 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.

[Anoesj]

Will ctx.compilerOptions.baseUrl always equal the VueRouter plugin's root? If not, this might not always work.