refactor(kit,nuxi): resolve module paths using node algorithm

[danielroe]

🔗 Linked issue

#18431 (comment)

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The linked issue is caused by us trying to resolve an ESM module's path by CJS utilities, and then import it with native ESM.

This refactors our internal CJS utils in kit + nuxi to use resolvePath from mlly which uses import-meta-resolve under the hood (a polyfill for the Node built-in). To decrease the change surface, I've restricted changes to places where we have a single search path (e.g. rootDir or cwd) and have kept the existing behaviour where we have multiple paths (e.g. where nuxt.options.modulesDir is used).

I would be up for refactoring the remaining usage of CJS utils as well, but am also happy to defer that to a subsequent PR.

As part of this, the behaviour of tryResolveModule (exposed by kit) has changed (it is now async, it now returns a file URL, and it takes a single string as a second argument rather than an object). However, I think this is safe as it was a deprecated internal module and not used outside of nuxt itself.

I've also decreased the number of internal utilities we are exposing from the CJS part of kit as a number of them are not being used elsewhere in the repo.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[codesandbox]

  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

[pi0]

This is a really lovely initiative! Only I think we should use mlly.resolvePath that wraps same package internally for less deps, more consistency and path normalizations.

[pi0]

Looks good must have to me 🚀