Support typescript "keyof typeof" on imported YAML structures

[ArendPeter]

Hello,

Thanks for creating this tool, it's fitting my needs perfectly and it'll make our team's lives a lot easier

I was hoping to use typescript's "keyof typeof" syntax to let me ensure I only reference existing keys, but I'm having trouble getting that working.

Here's an example of defining a type based on keys of a javascript object

Supposedly this should work with json, however it doesn't seem to work when I try it with YAML.

Let me know if I can configure the loader to support this. Thanks!

[vincerubinetti]

Am I correct in thinking that this plugin does not "support" typescript in the same way that importing JSON does? That is, automatically generating the type-schema of the specific file that is being imported? Any yaml file I import, I get the generic (and unhelpful) type Record<string, any>.

Your original screenshots are broken, but if you replace the "modyfi" in the url with "figma", it looks like you're just getting the generic PropertyKey type for a Record key (string | number | symbol). I think that's because this library doesn't actually import types, just a generic type. And at time of writing, I think PropertyKey got changed to just string for me.

Anyway, I discovered this other plugin which seems to add actual typescript support:
https://github.com/cabralpinto/typescript-yaml-plugin

Perhaps the maintainers could consider integrating its features here. It doesn't look too onerous.

Edit Nevermind, that plugin only works for editor integration and doesn't work when statically type checking your project, which makes it a non-starter for me. Is there any chance a vite plugin could be made to automatically generate .d.ts for every yaml file, since TS doesn't support compiler plugins?

Overall, I think we essentially need a resolveYamlModule option like the resolveJsonModule option.