-
Notifications
You must be signed in to change notification settings - Fork 357
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate dist/dynamic-modules.json for relevant packages (#10046)
* Generate dist/dynamic-modules.json for relevant packages * Address review comments * Skip writing dynamic-modules.json when the module map is empty
- Loading branch information
1 parent
325c0b3
commit 9fa6654
Showing
2 changed files
with
213 additions
and
32 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,159 @@ | ||
| /* eslint-disable no-console */ | ||
| const fs = require('fs-extra'); | ||
| const path = require('path'); | ||
| const glob = require('glob'); | ||
| const ts = require('typescript'); | ||
|
|
||
| /** @type {ts.CompilerOptions} */ | ||
| const tsConfigBase = require(path.resolve(__dirname, '../packages/tsconfig.base.json')); | ||
|
|
||
| /** @type {ts.CompilerOptions} */ | ||
| const defaultCompilerOptions = { | ||
| target: tsConfigBase.target, | ||
| module: tsConfigBase.module, | ||
| moduleResolution: tsConfigBase.moduleResolution, | ||
| esModuleInterop: tsConfigBase.esModuleInterop, | ||
| allowJs: true, | ||
| strict: false, | ||
| skipLibCheck: true, | ||
| noEmit: true | ||
| }; | ||
|
|
||
| /** | ||
| * Map all exports of the given index module to their corresponding dynamic modules. | ||
| * | ||
| * Example: `@patternfly/react-core` package provides ESModules index at `dist/esm/index.js` | ||
| * which exports Alert component related code & types via `dist/esm/components/Alert/index.js` | ||
| * module. | ||
| * | ||
| * Given the example above, this function should return a mapping like so: | ||
| * ```js | ||
| * { | ||
| * Alert: 'dist/dynamic/components/Alert', | ||
| * AlertProps: 'dist/dynamic/components/Alert', | ||
| * AlertContext: 'dist/dynamic/components/Alert', | ||
| * // ... | ||
| * } | ||
| * ``` | ||
| * | ||
| * The above mapping can be used when generating import statements like so: | ||
| * ```ts | ||
| * import { Alert } from '@patternfly/react-core/dist/dynamic/components/Alert'; | ||
| * ``` | ||
| * | ||
| * It may happen that the same export is provided by multiple dynamic modules; | ||
| * in such case, the resolution favors modules with most specific file paths, for example | ||
| * `dist/dynamic/components/Wizard/hooks` is favored over `dist/dynamic/components/Wizard`. | ||
| * | ||
| * Dynamic modules nested under `deprecated` or `next` directories are ignored. | ||
| * | ||
| * If the referenced index module does not exist, an empty object is returned. | ||
| * | ||
| * @param {string} basePath | ||
| * @param {string} indexModule | ||
| * @param {string} resolutionField | ||
| * @param {ts.CompilerOptions} tsCompilerOptions | ||
| * @returns {Record<string, string>} | ||
| */ | ||
| const getDynamicModuleMap = ( | ||
| basePath, | ||
| indexModule = 'dist/esm/index.js', | ||
| resolutionField = 'module', | ||
| tsCompilerOptions = defaultCompilerOptions | ||
| ) => { | ||
| if (!path.isAbsolute(basePath)) { | ||
| throw new Error('Package base path must be absolute'); | ||
| } | ||
|
|
||
| const indexModulePath = path.resolve(basePath, indexModule); | ||
|
|
||
| if (!fs.existsSync(indexModulePath)) { | ||
| return {}; | ||
| } | ||
|
|
||
| /** @type {Record<string, string>} */ | ||
| const dynamicModulePathToPkgDir = glob.sync(`${basePath}/dist/dynamic/**/package.json`).reduce((acc, pkgFile) => { | ||
| const pkg = require(pkgFile); | ||
| const pkgModule = pkg[resolutionField]; | ||
|
|
||
| if (!pkgModule) { | ||
| throw new Error(`Missing field ${resolutionField} in ${pkgFile}`); | ||
| } | ||
|
|
||
| const pkgResolvedPath = path.resolve(path.dirname(pkgFile), pkgModule); | ||
| const pkgRelativePath = path.dirname(path.relative(basePath, pkgFile)); | ||
|
|
||
| acc[pkgResolvedPath] = pkgRelativePath; | ||
|
|
||
| return acc; | ||
| }, {}); | ||
|
|
||
| const dynamicModulePaths = Object.keys(dynamicModulePathToPkgDir); | ||
| const compilerHost = ts.createCompilerHost(tsCompilerOptions); | ||
| const program = ts.createProgram([indexModulePath, ...dynamicModulePaths], tsCompilerOptions, compilerHost); | ||
| const errorDiagnostics = ts.getPreEmitDiagnostics(program).filter((d) => d.category === ts.DiagnosticCategory.Error); | ||
|
|
||
| if (errorDiagnostics.length > 0) { | ||
| const { getCanonicalFileName, getCurrentDirectory, getNewLine } = compilerHost; | ||
|
|
||
| console.error( | ||
| ts.formatDiagnostics(errorDiagnostics, { | ||
| getCanonicalFileName, | ||
| getCurrentDirectory, | ||
| getNewLine | ||
| }) | ||
| ); | ||
|
|
||
| throw new Error(`Detected TypeScript errors while parsing modules at ${basePath}`); | ||
| } | ||
|
|
||
| const typeChecker = program.getTypeChecker(); | ||
|
|
||
| /** @param {ts.SourceFile} sourceFile */ | ||
| const getExportNames = (sourceFile) => | ||
| typeChecker.getExportsOfModule(typeChecker.getSymbolAtLocation(sourceFile)).map((symbol) => symbol.getName()); | ||
|
|
||
| const indexModuleExports = getExportNames(program.getSourceFile(indexModulePath)); | ||
|
|
||
| /** @type {Record<string, string[]>} */ | ||
| const dynamicModuleExports = dynamicModulePaths.reduce((acc, modulePath) => { | ||
| acc[modulePath] = getExportNames(program.getSourceFile(modulePath)); | ||
| return acc; | ||
| }, {}); | ||
|
|
||
| /** @param {string[]} modulePaths */ | ||
| const getMostSpecificModulePath = (modulePaths) => | ||
| modulePaths.reduce((acc, p) => { | ||
| const pathSpecificity = p.split(path.sep).length; | ||
| const currSpecificity = acc.split(path.sep).length; | ||
|
|
||
| if (pathSpecificity > currSpecificity) { | ||
| return p; | ||
| } | ||
|
|
||
| if (pathSpecificity === currSpecificity) { | ||
| return !p.endsWith('index.js') && acc.endsWith('index.js') ? p : acc; | ||
| } | ||
|
|
||
| return acc; | ||
| }, ''); | ||
|
|
||
| return indexModuleExports.reduce((acc, exportName) => { | ||
| const foundModulePaths = Object.keys(dynamicModuleExports).filter((modulePath) => | ||
| dynamicModuleExports[modulePath].includes(exportName) | ||
| ); | ||
|
|
||
| const filteredModulePaths = foundModulePaths.filter((modulePath) => { | ||
| const dirNames = path.dirname(modulePath).split(path.sep); | ||
| return !dirNames.includes('deprecated') && !dirNames.includes('next'); | ||
| }); | ||
|
|
||
| if (filteredModulePaths.length > 0) { | ||
| acc[exportName] = dynamicModulePathToPkgDir[getMostSpecificModulePath(filteredModulePaths)]; | ||
| } | ||
|
|
||
| return acc; | ||
| }, {}); | ||
| }; | ||
|
|
||
| module.exports = getDynamicModuleMap; |