feat(resolve): support "fallback array" in package exports field #10504
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ import fs from 'node:fs' | |
| import path from 'node:path' | ||
| import colors from 'picocolors' | ||
| import type { PartialResolvedId } from 'rollup' | ||
| import { resolveExports } from 'resolve.exports' | ||
| import { hasESMSyntax } from 'mlly' | ||
| import type { Plugin } from '../plugin' | ||
| import { | ||
|
|
@@ -107,6 +107,7 @@ export interface InternalResolveOptions extends Required<ResolveOptions> { | |
| shouldExternalize?: (id: string) => boolean | undefined | ||
| // Check this resolve is called from `hookNodeResolve` in SSR | ||
| isHookNodeResolve?: boolean | ||
| overrideConditions?: string[] | ||
| } | ||
|
|
||
| export function resolvePlugin(resolveOptions: InternalResolveOptions): Plugin { | ||
|
|
@@ -579,21 +580,12 @@ function tryResolveFile( | |
| } | ||
| } | ||
|
|
||
| export const idToPkgMap = new Map<string, PackageData>() | ||
|
|
||
| export function tryNodeResolve( | ||
| id: string, | ||
| importer: string | null | undefined, | ||
| options: InternalResolveOptions, | ||
| targetWeb: boolean, | ||
| depsOptimizer?: DepsOptimizer, | ||
| ssr?: boolean, | ||
|
|
@@ -923,29 +915,29 @@ export function resolvePackageEntry( | |
| return cached | ||
| } | ||
| try { | ||
| let entryPoints: string[] = [] | ||
|
There was a problem hiding this comment. The new |
||
|
|
||
| // the exports field takes highest priority as described in | ||
| // https://nodejs.org/api/packages.html#package-entry-points | ||
| if (data.exports) { | ||
|
There was a problem hiding this comment. No need for |
||
| entryPoints = resolveExports( | ||
| data, | ||
| '.', | ||
| options, | ||
| getInlineConditions(options, targetWeb), | ||
| options.overrideConditions | ||
|
There was a problem hiding this comment. When |
||
| ) | ||
| if (!entryPoints.length) { | ||
| packageEntryFailure(id) | ||
|
There was a problem hiding this comment. This comes from #8484, and it makes resolution more strict when an |
||
| } | ||
| } else if (targetWeb && options.browserField) { | ||
| // check browser field | ||
| // https://github.com/defunctzombie/package-browser-field-spec | ||
| const browserEntry = | ||
| typeof data.browser === 'string' | ||
| ? data.browser | ||
| : isObject(data.browser) && data.browser['.'] | ||
|
|
||
| if (browserEntry) { | ||
| // check if the package also has a "module" field. | ||
| if ( | ||
|
|
@@ -968,34 +960,34 @@ export function resolvePackageEntry( | |
| const content = fs.readFileSync(resolvedBrowserEntry, 'utf-8') | ||
| if (hasESMSyntax(content)) { | ||
| // likely ESM, prefer browser | ||
| entryPoints[0] = browserEntry | ||
| } else { | ||
| // non-ESM, UMD or IIFE or CJS(!!! e.g. firebase 7.x), prefer module | ||
| entryPoints[0] = data.module | ||
| } | ||
| } | ||
| } else { | ||
| entryPoints[0] = browserEntry | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (!entryPoints[0]) { | ||
| for (const field of options.mainFields) { | ||
| if (field === 'browser') continue // already checked above | ||
| if (typeof data[field] === 'string') { | ||
| entryPoints[0] = data[field] | ||
| break | ||
| } | ||
| } | ||
| entryPoints[0] ||= data.main | ||
| } | ||
|
|
||
| // try default entry when entry is not define | ||
| // https://nodejs.org/api/modules.html#all-together | ||
| if (!entryPoints[0]) { | ||
| entryPoints = ['index.js', 'index.json', 'index.node'] | ||
| } | ||
|
|
||
| for (let entry of entryPoints) { | ||
| // make sure we don't get scripts when looking for sass | ||
|
|
@@ -1040,52 +1032,41 @@ function packageEntryFailure(id: string, details?: string) { | |
| ) | ||
| } | ||
|
|
||
| /** | ||
| * This generates conditions that aren't inferred by `resolveExports` | ||
| * from the `options` object. | ||
| */ | ||
| function getInlineConditions( | ||
| options: InternalResolveOptions, | ||
| targetWeb: boolean | ||
| ) { | ||
| const inlineConditions: string[] = [] | ||
|
|
||
| const conditions: readonly string[] = | ||
| options.overrideConditions || options.conditions | ||
|
|
||
| if (targetWeb) { | ||
| if (!conditions.includes('node')) { | ||
| inlineConditions.push('browser') | ||
| } | ||
| } else if (!conditions.includes('browser')) { | ||
| inlineConditions.push('node') | ||
|
There was a problem hiding this comment. This mirrors the |
||
| } | ||
|
|
||
| // The "module" condition is no longer recommended, but some older | ||
| // packages may still use it. | ||
| if (!options.isRequire && !conditions.includes('require')) { | ||
| inlineConditions.push('module') | ||
| } | ||
|
|
||
| // The "overrideConditions" array can add arbitrary conditions. | ||
| options.overrideConditions?.forEach((condition) => { | ||
| if (!inlineConditions.includes(condition)) { | ||
| inlineConditions.push(condition) | ||
| } | ||
| }) | ||
|
|
||
| return inlineConditions | ||
| } | ||
|
|
||
| function resolveDeepImport( | ||
|
|
@@ -1105,47 +1086,58 @@ function resolveDeepImport( | |
| return cache | ||
| } | ||
|
|
||
| const { exports: exportsField, browser: browserField } = data | ||
| const { file, postfix } = splitFileAndPostfix(id) | ||
|
|
||
| let possibleFiles: string[] | undefined | ||
| if (exportsField) { | ||
| // map relative based on exports data | ||
| possibleFiles = resolveExports( | ||
| data, | ||
| file, | ||
| options, | ||
| getInlineConditions(options, targetWeb), | ||
| options.overrideConditions | ||
| ) | ||
| if (postfix) { | ||
| if (possibleFiles.length) { | ||
| possibleFiles = possibleFiles.map((f) => f + postfix) | ||
| } else { | ||
| possibleFiles = resolveExports( | ||
| data, | ||
| file + postfix, | ||
| options, | ||
| getInlineConditions(options, targetWeb), | ||
| options.overrideConditions | ||
| ) | ||
| } | ||
| } | ||
| if (!possibleFiles.length) { | ||
| throw new Error( | ||
| `Package subpath '${file}' is not defined by "exports" in ` + | ||
| `${path.join(dir, 'package.json')}.` | ||
| ) | ||
| } | ||
| } else if (targetWeb && options.browserField && isObject(browserField)) { | ||
| const mapped = mapWithBrowserField(file, browserField) | ||
| if (mapped) { | ||
| possibleFiles = [mapped + postfix] | ||
| } else if (mapped === false) { | ||
| return (webResolvedImports[id] = browserExternalId) | ||
| } | ||
| } | ||
|
|
||
| possibleFiles ||= [id] | ||
| if (possibleFiles[0]) { | ||
| let resolved: string | undefined | ||
| possibleFiles.some( | ||
| (file) => | ||
| (resolved = tryFsResolve( | ||
| path.join(dir, file), | ||
| options, | ||
| !exportsField, // try index only if no exports field | ||
| targetWeb | ||
| )) | ||
| ) | ||
| if (resolved) { | ||
| isDebug && | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fixes a bug introduced in #10683
Some packages use "require" instead of "default" for CJS entry (eg:
vitest/config)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, this bug was introduced (and now fixed) by this PR :)
The
overrideConditionsarray is respected by@alloc/resolve.exportsfor all conditions (includingimportandrequire) except fordefaultof course. So we have to defineimportorrequireexplicitly in theoverrideConditionsoption.