feat: allow filePath to be null on a route added in an editable tree

[Anoesj]

It seems that, when we only allow filePath to be null on a route added in an editable tree, that shouldn't cause any problems.

In Nuxt, we don't use file scanning and add routes by modifying the EditableTreeNode of the root page in the beforeWriteFiles callback. A NuxtPage can theoretically not have a corresponding file, although I'm not sure what the use case here is exactly. So currently, where we run parent.insert(path, page.file), page.file can be undefined and we currently use a @ts-expect-error before that line to suppress TS errors.

If this PR is safe to merge, we can remove that @ts-expect-error.

[pkg-pr-new]

Open in Stackblitz

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

commit: 2d0d1a2

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.72%. Comparing base (cd4a3f8) to head (2d0d1a2).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #607   +/-   ##
=======================================
  Coverage   61.72%   61.72%           
=======================================
  Files          32       32           
  Lines        3135     3135           
  Branches      580      580           
=======================================
  Hits         1935     1935           
  Misses       1194     1194           
  Partials        6        6           

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

[posva]

I know the comment is a bit weird. I didn't find any practical case where this was useful when inserting an already parsed node. I couldn't find any usage of this in Nuxt code. Where is it?

[Anoesj]

Hmm, it's been a while since I last looked at this. I think it's these two lines, where page.file can be undefined when the page is added programmatically:

• https://github.com/nuxt/nuxt/blob/b0497b5b188fa1223db64982acb20e061846faa4/packages/nuxt/src/pages/module.ts#L211
• https://github.com/nuxt/nuxt/blob/b0497b5b188fa1223db64982acb20e061846faa4/packages/nuxt/src/pages/module.ts#L214

Here you can see that file is optional in NuxtPage: https://github.com/nuxt/nuxt/blob/b0497b5b188fa1223db64982acb20e061846faa4/packages/schema/src/types/hooks.ts#L32

I am not entirely sure, but maybe Nuxt supports virtual pages that don't really correspond to files? If that's true and this PR is to be merged, then we need to adjust the lines mentioned above to fall back to null when page.file is nullish.

[Anoesj]

Here is an example in a test file, where no file has been specified: https://github.com/nuxt/nuxt/blob/b0497b5b188fa1223db64982acb20e061846faa4/test/fixtures/basic-types/nuxt.config.ts#L36

Not sure if this test case is actually realistic, but Nuxt does seem to support some form of file-less pages.

[posva]

Thanks for this. I will come back to it after merging other things like relative paths insertions. I'm not 100% sure about it yet but I think it makes sense in the context of the editable tree where a node can be created to have children afterwards

[posva]

Suggested change

	const isComponent = filePath !== null
	const isComponent = filePath != null

[posva]

Suggested change

// Allow null filePath to be handled