mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-16 02:44:51 +00:00
55 lines
2.3 KiB
TypeScript
55 lines
2.3 KiB
TypeScript
|
import satisfies from 'semver/functions/satisfies.js' // npm/node-semver#381
|
||
|
import type { Nuxt, NuxtModule } from '@nuxt/schema'
|
||
|
import { useNuxt } from '../context'
|
||
|
import { normalizeSemanticVersion } from '../compatibility'
|
||
|
import { loadNuxtModuleInstance } from './install'
|
||
|
|
||
|
/**
|
||
|
* Check if a Nuxt module is installed by name.
|
||
|
*
|
||
|
* This will check both the installed modules and the modules to be installed. Note
|
||
|
* that it cannot detect if a module is _going to be_ installed programmatically by another module.
|
||
|
*/
|
||
|
export function hasNuxtModule (moduleName: string, nuxt: Nuxt = useNuxt()) : boolean {
|
||
|
return nuxt.options._installedModules.some(({ meta }) => meta.name === moduleName) ||
|
||
|
nuxt.options.modules.includes(moduleName)
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Checks if a Nuxt Module is compatible with a given semver version.
|
||
|
*/
|
||
|
export async function hasNuxtModuleCompatibility (module: string | NuxtModule, semverVersion: string, nuxt: Nuxt = useNuxt()): Promise<boolean> {
|
||
|
const version = await getNuxtModuleVersion(module, nuxt)
|
||
|
if (!version) {
|
||
|
return false
|
||
|
}
|
||
|
return satisfies(normalizeSemanticVersion(version), semverVersion, {
|
||
|
includePrerelease: true
|
||
|
})
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get the version of a Nuxt module.
|
||
|
*
|
||
|
* Scans installed modules for the version, if it's not found it will attempt to load the module instance and get the version from there.
|
||
|
*/
|
||
|
export async function getNuxtModuleVersion (module: string | NuxtModule, nuxt: Nuxt | any = useNuxt()): Promise<string | false> {
|
||
|
const moduleMeta = (typeof module === 'string' ? { name: module } : await module.getMeta?.()) || {}
|
||
|
if (moduleMeta.version) { return moduleMeta.version }
|
||
|
// need a name from here
|
||
|
if (!moduleMeta.name) { return false }
|
||
|
// maybe the version got attached within the installed module instance?
|
||
|
const version = nuxt.options._installedModules
|
||
|
// @ts-expect-error _installedModules is not typed
|
||
|
.filter(m => m.meta.name === moduleMeta.name).map(m => m.meta.version)?.[0]
|
||
|
if (version) {
|
||
|
return version
|
||
|
}
|
||
|
// it's possible that the module will be installed, it just hasn't been done yet, preemptively load the instance
|
||
|
if (typeof module !== 'string' && nuxt.options.modules.includes(moduleMeta.name)) {
|
||
|
const { buildTimeModuleMeta } = await loadNuxtModuleInstance(moduleMeta.name, nuxt)
|
||
|
return buildTimeModuleMeta.version || false
|
||
|
}
|
||
|
return false
|
||
|
}
|