feat(modules): infer modules types in config

[Barbapapazes]

🔗 Linked issue

fix #2685

❓ Type of change

• [ ] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
• [x] 👌 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

Hello 👋,

This feature uses typegen to add modules types within the NitroConfig interface to allow autocompletion in the nitro.config.ts file.

With the following module:

interface ModuleOptions {
  bar: string;
  foo: {
    baz: string;
  };
}

export default defineNitroModule<ModuleOptions>({
  name: "playground",
  configKey: "playground",
  setup: (nitro, moduleOptions) => {},
});

TypeScript will help you with autocompletion when you are configuring the module in the nitro.config.ts file:

import { defineNitroConfig } from "nitropack/config";

export default defineNitroConfig({
  playground: {
    bar: "bar",
    foo: "baz",
  },

  compatibilityDate: "2024-06-12",
});

Of course, the foo property should be an object, and TypeScript will raise an error.

📝 Checklist

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

[pi0]

Hi, thanks for the PR i appreciate it but at the current state, i prefer to not depend more on auto generated types. it can both make conflict with higher level framework types and user experience.

[Barbapapazes]

Have you any plans to improve the DX of modules? Is it possible to help?

[pi0]

Not until we officially release Nitro Kit and I think i am more likely to recommend direct module imports (like vite plugins that accept options inline) and not nuxt style -- this immediately supports type hints in IDE. but have to think more about it.