-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
extract package walk logic into utility
- Loading branch information
1 parent
4a71969
commit 12911c0
Showing
3 changed files
with
184 additions
and
177 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| const acorn = require('acorn'); | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const walk = require('acorn-walk'); | ||
|
|
||
| const importMap = {}; | ||
|
|
||
| const updateImportMap = (entry, entryPath) => { | ||
|
|
||
| if (path.extname(entryPath) === '') { | ||
| entryPath = `${entryPath}/${entry}.js`; | ||
| } | ||
|
|
||
| importMap[entry] = entryPath; | ||
| }; | ||
|
|
||
| const getPackageEntryPath = (packageJson) => { | ||
| let entry = packageJson.exports | ||
| ? Object.keys(packageJson.exports) // first favor export maps first | ||
| : packageJson.module // next favor ESM entry points | ||
| ? packageJson.module | ||
| : packageJson.main && packageJson.main !== '' // then favor main | ||
| ? packageJson.main | ||
| : 'index.js'; // lastly, fallback to index.js | ||
|
|
||
| // use .mjs version if it exists, for packages like redux | ||
| if (!Array.isArray(entry) && fs.existsSync(`${process.cwd()}/node_modules/${packageJson.name}/${entry.replace('.js', '.mjs')}`)) { | ||
| entry = entry.replace('.js', '.mjs'); | ||
| } | ||
|
|
||
| return entry; | ||
| }; | ||
|
|
||
| const walkModule = (module, dependency) => { | ||
| walk.simple(acorn.parse(module, { | ||
| ecmaVersion: '2020', | ||
| sourceType: 'module' | ||
| }), { | ||
| ImportDeclaration(node) { | ||
| let { value: sourceValue } = node.source; | ||
|
|
||
| if (path.extname(sourceValue) === '' && sourceValue.indexOf('http') !== 0 && sourceValue.indexOf('./') < 0) { | ||
| if (!importMap[sourceValue]) { | ||
| // found a _new_ bare import for ${sourceValue} | ||
| // we should add this to the importMap and walk its package.json for more transitive deps | ||
| updateImportMap(sourceValue, `/node_modules/${sourceValue}`); | ||
| } | ||
|
|
||
| walkPackageJson(path.join(process.cwd(), 'node_modules', sourceValue, 'package.json')); | ||
| } else if (sourceValue.indexOf('./') < 0) { | ||
| // adding a relative import | ||
| updateImportMap(sourceValue, `/node_modules/${sourceValue}`); | ||
| } else { | ||
| // walk this module for all its dependencies | ||
| sourceValue = sourceValue.indexOf('.js') < 0 | ||
| ? `${sourceValue}.js` | ||
| : sourceValue; | ||
|
|
||
| if (fs.existsSync(path.join(process.cwd(), 'node_modules', dependency, sourceValue))) { | ||
| const moduleContents = fs.readFileSync(path.join(process.cwd(), 'node_modules', dependency, sourceValue)); | ||
| walkModule(moduleContents, dependency); | ||
| } | ||
| } | ||
| }, | ||
| ExportNamedDeclaration(node) { | ||
| const sourceValue = node && node.source ? node.source.value : ''; | ||
|
|
||
| if (sourceValue !== '' && sourceValue.indexOf('.') !== 0 && sourceValue.indexOf('http') !== 0) { | ||
| updateImportMap(sourceValue, `/node_modules/${sourceValue}`); | ||
| } | ||
| }, | ||
| ExportAllDeclaration(node) { | ||
| const sourceValue = node && node.source ? node.source.value : ''; | ||
|
|
||
| if (sourceValue !== '' && sourceValue.indexOf('.') !== 0 && sourceValue.indexOf('http') !== 0) { | ||
| updateImportMap(sourceValue, `/node_modules/${sourceValue}`); | ||
| } | ||
| } | ||
| }); | ||
| }; | ||
|
|
||
| const walkPackageJson = (packageJson = {}) => { | ||
| // while walking a package.json we need to find its entry point, e.g. index.js | ||
| // and then walk that for import / export statements | ||
| // and walk its package.json for its dependencies | ||
|
|
||
| Object.keys(packageJson.dependencies || {}).forEach(dependency => { | ||
| const dependencyPackageRootPath = path.join(process.cwd(), './node_modules', dependency); | ||
| const dependencyPackageJsonPath = path.join(dependencyPackageRootPath, 'package.json'); | ||
| const dependencyPackageJson = require(dependencyPackageJsonPath); | ||
| const entry = getPackageEntryPath(dependencyPackageJson); | ||
| const isJavascriptPackage = Array.isArray(entry) || typeof entry === 'string' && entry.endsWith('.js') || entry.endsWith('.mjs'); | ||
|
|
||
| if (isJavascriptPackage) { | ||
| // https://nodejs.org/api/packages.html#packages_determining_module_system | ||
| if (Array.isArray(entry)) { | ||
| // we have an exportMap | ||
| const exportMap = entry; | ||
|
|
||
| exportMap.forEach((entry) => { | ||
| const exportMapEntry = dependencyPackageJson.exports[entry]; | ||
| let packageExport; | ||
|
|
||
| if (Array.isArray(exportMapEntry)) { | ||
| let fallbackPath; | ||
| let esmPath; | ||
|
|
||
| exportMapEntry.forEach((mapItem) => { | ||
| switch (typeof mapItem) { | ||
|
|
||
| case 'string': | ||
| fallbackPath = mapItem; | ||
| break; | ||
| case 'object': | ||
| const entryTypes = Object.keys(mapItem); | ||
|
|
||
| if (entryTypes.import) { | ||
| esmPath = entryTypes.import; | ||
| } else if (entryTypes.require) { | ||
| console.error('The package you are importing needs commonjs support. Please use our commonjs plugin to fix this error.'); | ||
| fallbackPath = entryTypes.require; | ||
| } else if (entryTypes.default) { | ||
| console.warn('The package you are requiring may need commonjs support. If this module is not working for you, consider adding our commonjs plugin.'); | ||
| fallbackPath = entryTypes.default; | ||
| } | ||
| break; | ||
| default: | ||
| console.warn(`Sorry, we were unable to detect the module type for ${mapItem} :(. please consider opening an issue to let us know about your use case.`); | ||
| break; | ||
|
|
||
| } | ||
| }); | ||
|
|
||
| packageExport = esmPath | ||
| ? esmPath | ||
| : fallbackPath; | ||
| } else if (exportMapEntry.default) { | ||
| packageExport = exportMapEntry.default; | ||
|
|
||
| // use the dependency itself as an entry in the importMap | ||
| if (entry === '.') { | ||
| updateImportMap(dependency, `/node_modules/${dependency}/${packageExport.replace('./', '')}`); | ||
| } | ||
| } else if (exportMapEntry.endsWith && (exportMapEntry.endsWith('.js') || exportMapEntry.endsWith('.mjs')) && exportMapEntry.indexOf('*') < 0) { | ||
| // is probably a file, so _not_ an export array, package.json, or wildcard export | ||
| packageExport = exportMapEntry; | ||
| } | ||
|
|
||
| if (packageExport) { | ||
|
|
||
| // check all exports of an exportMap entry | ||
| // to make sure those deps get added to the importMap | ||
| if (packageExport.endsWith('.js')) { | ||
| const moduleContents = fs.readFileSync(path.join(process.cwd(), 'node_modules', `${dependency}/${packageExport.replace('./', '')}`)); | ||
| walkModule(moduleContents, dependency); | ||
| } | ||
|
|
||
| updateImportMap(`${dependency}/${packageExport.replace('./', '')}`, `/node_modules/${dependency}/${packageExport.replace('./', '')}`); | ||
| } | ||
| }); | ||
|
|
||
| walkPackageJson(dependencyPackageJson); | ||
| } else { | ||
| const packageEntryPointPath = path.join(process.cwd(), './node_modules', dependency, entry); | ||
|
|
||
| // sometimes a main file is actually just an empty string... :/ | ||
| if (fs.existsSync(packageEntryPointPath)) { | ||
| const packageEntryModule = fs.readFileSync(packageEntryPointPath, 'utf-8'); | ||
|
|
||
| walkModule(packageEntryModule, dependency); | ||
| updateImportMap(dependency, `/node_modules/${dependency}/${entry}`); | ||
| walkPackageJson(dependencyPackageJson); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| return importMap; | ||
| }; | ||
|
|
||
| module.exports = { walkPackageJson, walkModule }; |
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