feat(kit,nuxt,schema): allow modules to specify dependencies (#33063)

Author: danielroe

docs/2.guide/3.going-further/3.modules.md

@@ -177,6 +177,23 @@ export default defineNuxtModule({
   defaults: {},
   // Shorthand sugar to register Nuxt hooks
   hooks: {},
+  // Configuration for other modules - this does not ensure the module runs before
+  // your module, but it allows you to change the other module's configuration before it runs
+  moduleDependencies: {
+    'some-module': {
+      // You can specify a version constraint for the module. If the user has a different
+      // version installed, Nuxt will throw an error on startup.
+      version: '>=2',
+      // By default moduleDependencies will be added to the list of modules to be installed
+      // by Nuxt unless `optional` is set.
+      optional: true,
+      // Any configuration that should override `nuxt.options`.
+      overrides: {},
+      // Any configuration that should be set. It will override module defaults but
+      // will not override any configuration set in `nuxt.options`.
+      defaults: {}
+    }
+  },
   // The function holding your module logic, it can be asynchronous
   setup(moduleOptions, nuxt) {
     // ...

packages/kit/src/index.ts

@@ -1,6 +1,6 @@
 // Module
 export { defineNuxtModule } from './module/define'
-export { getDirectory, installModule, loadNuxtModuleInstance, normalizeModuleTranspilePath } from './module/install'
+export { getDirectory, installModule, installModules, loadNuxtModuleInstance, normalizeModuleTranspilePath, resolveModuleWithOptions } from './module/install'
 export { getNuxtModuleVersion, hasNuxtModule, hasNuxtModuleCompatibility } from './module/compatibility'
 
 // Loader

packages/kit/src/module/define.ts

@@ -78,6 +78,13 @@ function _defineNuxtModule<
     return Promise.resolve(options)
   }
 
+  function getModuleDependencies (nuxt: Nuxt = useNuxt()) {
+    if (typeof module.moduleDependencies === 'function') {
+      return module.moduleDependencies(nuxt)
+    }
+    return module.moduleDependencies
+  }
+
   // Module format is always a simple function
   async function normalizedModule (this: any, inlineOptions: Partial<TOptions>, nuxt: Nuxt): Promise<ModuleSetupReturn> {
     nuxt ||= tryUseNuxt() || this.nuxt /* invoked by nuxt 2 */
@@ -145,6 +152,7 @@ function _defineNuxtModule<
   // Define getters for options and meta
   normalizedModule.getMeta = () => Promise.resolve(module.meta)
   normalizedModule.getOptions = getOptions
+  normalizedModule.getModuleDependencies = getModuleDependencies
 
   normalizedModule.onInstall = module.onInstall
   normalizedModule.onUpgrade = module.onUpgrade