Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(plugin): support object-based MF2 exposed modules in ModuleFeder… #50

Merged
merged 1 commit into from
Dec 13, 2024
+28 −9
Merged

feat(plugin): support object-based MF2 exposed modules in ModuleFeder… #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/bin/make-federated-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ if (argv['federation-config']) {
.mfPluginOptions as FederationConfig;
}

const exposedModules = Object.values(federationConfig.exposes);
const exposedModules = federationConfig.exposes;
const outDir =
argv['output-types-folder'] || path.join(DEFAULT_DIR_DIST, DEFAULT_DIR_EMITTED_TYPES);
const outFile = path.join(outDir, 'index.d.ts');
const dirGlobalTypes = argv['global-types'] || DEFAULT_DIR_GLOBAL_TYPES;
const tsconfigPath = argv.tsconfig || TS_CONFIG_FILE;

console.log(`Emitting types for ${exposedModules.length} exposed module(s)`);
console.log(`Emitting types for ${Object.keys(exposedModules).length} exposed module(s)`);

setLogger(console);

Expand Down
16 changes: 11 additions & 5 deletions src/compileTypes/__tests__/compileTypesWorker.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,10 @@ describe('compileTypesWorker', () => {
test('handles successful compilation and rewrite', () => {
const workerMessage: CompileTypesWorkerMessage = {
tsconfigPath: 'tsconfig.json',
exposedModules: ['moduleA', 'moduleB'],
exposedModules: {
'./moduleA': 'moduleA',
'./moduleB': 'moduleB',
},
outFile: 'dist/types.d.ts',
dirGlobalTypes: 'src/@types',
federationConfig: {} as FederationConfig,
Expand All @@ -72,7 +75,10 @@ describe('compileTypesWorker', () => {
expect(mockCompileTypes).toHaveBeenCalledWith(
expect.objectContaining({
tsconfigPath: 'tsconfig.json',
exposedModules: ['moduleA', 'moduleB'],
exposedModules: {
'./moduleA': 'moduleA',
'./moduleB': 'moduleB',
},
outFile: 'dist/types.d.ts',
dirGlobalTypes: 'src/@types',
}),
Expand All @@ -92,7 +98,7 @@ describe('compileTypesWorker', () => {
test('handles compilation failure', () => {
const workerMessage: CompileTypesWorkerMessage = {
tsconfigPath: 'tsconfig.json',
exposedModules: ['moduleA'],
exposedModules: { './moduleA': 'moduleA' },
outFile: 'dist/types.d.ts',
dirGlobalTypes: 'src/@types',
federationConfig: {} as FederationConfig,
Expand All @@ -108,7 +114,7 @@ describe('compileTypesWorker', () => {
test('handles errors during compilation', () => {
const workerMessage: CompileTypesWorkerMessage = {
tsconfigPath: 'tsconfig.json',
exposedModules: ['moduleA'],
exposedModules: { './moduleA': 'moduleA' },
outFile: 'dist/types.d.ts',
dirGlobalTypes: 'src/@types',
federationConfig: {} as FederationConfig,
Expand All @@ -130,7 +136,7 @@ describe('compileTypesWorker', () => {
test('logs performance metrics', () => {
const workerMessage: CompileTypesWorkerMessage = {
tsconfigPath: 'tsconfig.json',
exposedModules: ['moduleA'],
exposedModules: { './moduleA': 'moduleA' },
outFile: 'dist/types.d.ts',
dirGlobalTypes: 'src/@types',
federationConfig: {} as FederationConfig,
Expand Down
2 changes: 1 addition & 1 deletion src/compileTypes/compileTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { getTSConfigCompilerOptions, reportCompileDiagnostic } from './helpers';

export type CompileTypesParams = {
tsconfigPath: string;
exposedModules: string[];
exposedModules: Dict<string>;
outFile: string;
dirGlobalTypes: string;
};
Expand Down
15 changes: 14 additions & 1 deletion src/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,19 @@ export class ModuleFederationTypesPlugin implements WebpackPluginInstance {
return;
}

// In MF2 an item can be an object with `import` and `name` properties
federationPluginOptions.exposes = Object.entries(federationPluginOptions.exposes || {}).reduce(
(acc, [key, value]) => {
if (value && typeof value === 'object' && 'import' in value) {
acc[key] = (value as Dict<string>).import[0];
} else {
acc[key] = value;
}
return acc;
},
{} as Dict<string>,
);

// Define path for the emitted typings file
const { exposes, remotes } = federationPluginOptions;

Expand All @@ -100,7 +113,7 @@ export class ModuleFederationTypesPlugin implements WebpackPluginInstance {
await compileTypesAsync(
{
tsconfigPath: TS_CONFIG_FILE,
exposedModules: exposes as string[],
exposedModules: exposes as Dict<string>,
outFile,
dirGlobalTypes,
federationConfig: federationPluginOptions as FederationConfig,
Expand Down
Loading