-
-
Notifications
You must be signed in to change notification settings - Fork 592
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(node-resolve): support package entry points
- Loading branch information
1 parent
4387386
commit 9fe41a0
Showing
84 changed files
with
703 additions
and
59 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| import fs from 'fs'; | ||
| import path from 'path'; | ||
| import { promisify } from 'util'; | ||
|
|
||
| import resolve from 'resolve'; | ||
|
|
||
| import { getPackageName } from './util'; | ||
| import { exists, realpath } from './fs'; | ||
|
|
||
| const resolveImportPath = promisify(resolve); | ||
| const readFile = promisify(fs.readFile); | ||
|
|
||
| const pathNotFoundError = (subPath, pkgPath) => | ||
| new Error(`Package subpath '${subPath}' is not defined by "exports" in ${pkgPath}`); | ||
|
|
||
| function findExportKeyMatch(exportMap, subPath) { | ||
| for (const key of Object.keys(exportMap)) { | ||
| if (key.endsWith('*')) { | ||
| // star match: "./foo/*": "./foo/*.js" | ||
| const keyWithoutStar = key.substring(0, key.length - 1); | ||
| if (subPath.startsWith(keyWithoutStar)) { | ||
| return key; | ||
| } | ||
| } | ||
|
|
||
| if (key.endsWith('/') && subPath.startsWith(key)) { | ||
| // directory match (deprecated by node): "./foo/": "./foo/.js" | ||
| return key; | ||
| } | ||
|
|
||
| if (key === subPath) { | ||
| // literal match | ||
| return key; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| function mapSubPath(pkgJsonPath, subPath, key, value) { | ||
| if (typeof value === 'string') { | ||
| if (typeof key === 'string' && key.endsWith('*')) { | ||
| // star match: "./foo/*": "./foo/*.js" | ||
| const keyWithoutStar = key.substring(0, key.length - 1); | ||
| const subPathAfterKey = subPath.substring(keyWithoutStar.length); | ||
| return value.replace(/\*/g, subPathAfterKey); | ||
| } | ||
|
|
||
| if (value.endsWith('/')) { | ||
| // directory match (deprecated by node): "./foo/": "./foo/.js" | ||
| return `${value}${subPath.substring(key.length)}`; | ||
| } | ||
|
|
||
| // mapping is a string, for example { "./foo": "./dist/foo.js" } | ||
| return value; | ||
| } | ||
|
|
||
| if (Array.isArray(value)) { | ||
| // mapping is an array with fallbacks, for example { "./foo": ["foo:bar", "./dist/foo.js"] } | ||
| return value.find((v) => v.startsWith('./')); | ||
| } | ||
|
|
||
| throw pathNotFoundError(subPath, pkgJsonPath); | ||
| } | ||
|
|
||
| function findEntrypoint(pkgJsonPath, subPath, exportMap, conditions, key) { | ||
| if (typeof exportMap !== 'object') { | ||
| return mapSubPath(pkgJsonPath, subPath, key, exportMap); | ||
| } | ||
|
|
||
| // iterate conditions recursively, find the first that matches all conditions | ||
| for (const [condition, subExportMap] of Object.entries(exportMap)) { | ||
| if (conditions.includes(condition)) { | ||
| const mappedSubPath = findEntrypoint(pkgJsonPath, subPath, subExportMap, conditions, key); | ||
| if (mappedSubPath) { | ||
| return mappedSubPath; | ||
| } | ||
| } | ||
| } | ||
| throw pathNotFoundError(subPath, pkgJsonPath); | ||
| } | ||
|
|
||
| export function findEntrypointTopLevel(pkgJsonPath, subPath, exportMap, conditions) { | ||
| if (typeof exportMap !== 'object') { | ||
| // the export map shorthand, for example { exports: "./index.js" } | ||
| if (subPath !== '.') { | ||
| // shorthand only supports a main entrypoint | ||
| throw pathNotFoundError(subPath, pkgJsonPath); | ||
| } | ||
| return mapSubPath(pkgJsonPath, subPath, null, exportMap); | ||
| } | ||
|
|
||
| // export map is an object, the top level can be either conditions or sub path mappings | ||
| const keys = Object.keys(exportMap); | ||
| const isConditions = keys.every((k) => !k.startsWith('.')); | ||
| const isMappings = keys.every((k) => k.startsWith('.')); | ||
|
|
||
| if (!isConditions && !isMappings) { | ||
| throw new Error( | ||
| `Invalid package config ${pkgJsonPath}, "exports" cannot contain some keys starting with '.'` + | ||
| ' and some not. The exports object must either be an object of package subpath keys or an object of main entry' + | ||
| ' condition name keys only.' | ||
| ); | ||
| } | ||
|
|
||
| let key = null; | ||
| let exportMapForSubPath; | ||
|
|
||
| if (isConditions) { | ||
| // top level is conditions, for example { "import": ..., "require": ..., "module": ... } | ||
| if (subPath !== '.') { | ||
| // package with top level conditions means it only supports a main entrypoint | ||
| throw pathNotFoundError(subPath, pkgJsonPath); | ||
| } | ||
| exportMapForSubPath = exportMap; | ||
| } else { | ||
| // top level is sub path mappings, for example { ".": ..., "./foo": ..., "./bar": ... } | ||
| key = findExportKeyMatch(exportMap, subPath); | ||
| if (!key) { | ||
| throw pathNotFoundError(subPath, pkgJsonPath); | ||
| } | ||
| exportMapForSubPath = exportMap[key]; | ||
| } | ||
|
|
||
| return findEntrypoint(pkgJsonPath, subPath, exportMapForSubPath, conditions, key); | ||
| } | ||
|
|
||
| async function resolveId(importPath, options, exportConditions, warn) { | ||
| const pkgName = getPackageName(importPath); | ||
| if (pkgName) { | ||
| let pkgJsonPath; | ||
| let pkgJson; | ||
| try { | ||
| pkgJsonPath = await resolveImportPath(`${pkgName}/package.json`, options); | ||
| pkgJson = JSON.parse(await readFile(pkgJsonPath, 'utf-8')); | ||
| } catch (_) { | ||
| // if there is no package.json we defer to regular resolve behavior | ||
| } | ||
|
|
||
| if (pkgJsonPath && pkgJson && pkgJson.exports) { | ||
| try { | ||
| const packageSubPath = | ||
| pkgName === importPath ? '.' : `.${importPath.substring(pkgName.length)}`; | ||
| const mappedSubPath = findEntrypointTopLevel( | ||
| pkgJsonPath, | ||
| packageSubPath, | ||
| pkgJson.exports, | ||
| exportConditions | ||
| ); | ||
| const pkgDir = path.dirname(pkgJsonPath); | ||
| return path.join(pkgDir, mappedSubPath); | ||
| } catch (error) { | ||
| warn(error); | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return resolveImportPath(importPath, options); | ||
| } | ||
|
|
||
| // Resolve module specifiers in order. Promise resolves to the first module that resolves | ||
| // successfully, or the error that resulted from the last attempted module resolution. | ||
| export function resolveImportSpecifiers( | ||
| importSpecifierList, | ||
| resolveOptions, | ||
| exportConditions, | ||
| warn | ||
| ) { | ||
| let promise = Promise.resolve(); | ||
|
|
||
| for (let i = 0; i < importSpecifierList.length; i++) { | ||
| // eslint-disable-next-line no-loop-func | ||
| promise = promise.then(async (value) => { | ||
| // if we've already resolved to something, just return it. | ||
| if (value) { | ||
| return value; | ||
| } | ||
|
|
||
| let result = await resolveId(importSpecifierList[i], resolveOptions, exportConditions, warn); | ||
| if (!resolveOptions.preserveSymlinks) { | ||
| if (await exists(result)) { | ||
| result = await realpath(result); | ||
| } | ||
| } | ||
| return result; | ||
| }); | ||
|
|
||
| // swallow MODULE_NOT_FOUND errors | ||
| promise = promise.catch((error) => { | ||
| if (error.code !== 'MODULE_NOT_FOUND') { | ||
| throw error; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| return promise; | ||
| } |
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
Oops, something went wrong.