@module-federation/bridge-react-webpack-plugin 0.0.0-docs-remove-invalid-lark-link-20251205062649
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +633 -0
- package/LICENSE +21 -0
- package/README.md +131 -0
- package/__tests__/mockRouterDir/router-v5/react-router-dom/package.json +71 -0
- package/__tests__/mockRouterDir/router-v6/react-router-dom/package.json +49 -0
- package/__tests__/mockRouterDir/router-v7/react-router/package.json +45 -0
- package/__tests__/utils.spec.ts +102 -0
- package/dist/index.cjs.d.ts +14 -0
- package/dist/index.cjs.js +1776 -0
- package/dist/index.es.js +1777 -0
- package/package.json +40 -0
- package/project.json +29 -0
- package/src/index.ts +62 -0
- package/src/router-alias.ts +124 -0
- package/src/utils.ts +52 -0
- package/tsconfig.json +42 -0
- package/tsconfig.node.json +11 -0
- package/vite.config.ts +24 -0
- package/vitest.config.ts +22 -0
package/package.json
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@module-federation/bridge-react-webpack-plugin",
|
|
3
|
+
"version": "0.0.0-docs-remove-invalid-lark-link-20251205062649",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"access": "public"
|
|
6
|
+
},
|
|
7
|
+
"author": "zhouxiao <codingzx@gmail.com>",
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/module-federation/core.git",
|
|
12
|
+
"directory": "packages/bridge/bridge-react-webpack-plugin"
|
|
13
|
+
},
|
|
14
|
+
"main": "./dist/index.cjs.js",
|
|
15
|
+
"module": "./dist/index.es.js",
|
|
16
|
+
"types": "./dist/index.cjs.d.ts",
|
|
17
|
+
"exports": {
|
|
18
|
+
".": {
|
|
19
|
+
"types": "./dist/index.cjs.d.ts",
|
|
20
|
+
"import": "./dist/index.es.js",
|
|
21
|
+
"require": "./dist/index.cjs.js"
|
|
22
|
+
},
|
|
23
|
+
"./*": "./*"
|
|
24
|
+
},
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"semver": "7.6.3",
|
|
27
|
+
"@types/semver": "7.5.8",
|
|
28
|
+
"@module-federation/sdk": "0.0.0-docs-remove-invalid-lark-link-20251205062649"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"typescript": "^5.2.2",
|
|
32
|
+
"vite": "^5.4.21",
|
|
33
|
+
"vite-plugin-dts": "^4.3.0"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"dev": "vite",
|
|
37
|
+
"build": "vite build",
|
|
38
|
+
"preview": "vite preview"
|
|
39
|
+
}
|
|
40
|
+
}
|
package/project.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bridge-react-webpack-plugin",
|
|
3
|
+
"$schema": "../../node_modules/nx/schemas/project-schema.json",
|
|
4
|
+
"sourceRoot": "packages/bridge/bridge-react-webpack-plugin/src",
|
|
5
|
+
"projectType": "library",
|
|
6
|
+
"tags": ["type:pkg"],
|
|
7
|
+
"targets": {
|
|
8
|
+
"build": {
|
|
9
|
+
"executor": "nx:run-commands",
|
|
10
|
+
"options": {
|
|
11
|
+
"commands": [
|
|
12
|
+
"npm run build --prefix packages/bridge/bridge-react-webpack-plugin"
|
|
13
|
+
]
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"test": {
|
|
17
|
+
"executor": "nx:run-commands",
|
|
18
|
+
"options": {
|
|
19
|
+
"parallel": false,
|
|
20
|
+
"commands": [
|
|
21
|
+
{
|
|
22
|
+
"command": "vitest run -c packages/bridge/bridge-react-webpack-plugin/vitest.config.ts",
|
|
23
|
+
"forwardAllArgs": false
|
|
24
|
+
}
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import type { moduleFederationPlugin } from '@module-federation/sdk';
|
|
4
|
+
import { getBridgeRouterAlias } from './router-alias';
|
|
5
|
+
|
|
6
|
+
class ReactBridgeAliasChangerPlugin {
|
|
7
|
+
alias: string;
|
|
8
|
+
targetFile: string;
|
|
9
|
+
moduleFederationOptions: moduleFederationPlugin.ModuleFederationPluginOptions;
|
|
10
|
+
constructor(info: {
|
|
11
|
+
moduleFederationOptions: moduleFederationPlugin.ModuleFederationPluginOptions;
|
|
12
|
+
}) {
|
|
13
|
+
this.moduleFederationOptions = info.moduleFederationOptions;
|
|
14
|
+
this.alias = 'react-router-dom$';
|
|
15
|
+
this.targetFile = '@module-federation/bridge-react/dist/router.es.js';
|
|
16
|
+
|
|
17
|
+
if (this.moduleFederationOptions.shared) {
|
|
18
|
+
if (Array.isArray(this.moduleFederationOptions.shared)) {
|
|
19
|
+
if (this.moduleFederationOptions.shared.includes('react-router-dom')) {
|
|
20
|
+
throw Error(
|
|
21
|
+
'React-router-dom cannot be set to shared after react bridge is used',
|
|
22
|
+
);
|
|
23
|
+
}
|
|
24
|
+
} else {
|
|
25
|
+
if (this.moduleFederationOptions.shared['react-router-dom']) {
|
|
26
|
+
throw Error(
|
|
27
|
+
'React-router-dom cannot be set to shared after react bridge is used',
|
|
28
|
+
);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
apply(compiler: any) {
|
|
35
|
+
compiler.hooks.afterEnvironment.tap('ReactBridgeAliasPlugin', () => {
|
|
36
|
+
// Gets the path to the node_modules directory
|
|
37
|
+
const nodeModulesPath = path.resolve(compiler.context, 'node_modules');
|
|
38
|
+
const targetFilePath = path.join(nodeModulesPath, this.targetFile);
|
|
39
|
+
|
|
40
|
+
if (fs.existsSync(targetFilePath)) {
|
|
41
|
+
const originalResolve = compiler.options.resolve || {};
|
|
42
|
+
const originalAlias = originalResolve.alias || {};
|
|
43
|
+
|
|
44
|
+
// Update alias - set up router version alias
|
|
45
|
+
const updatedAlias: Record<string, string> = {
|
|
46
|
+
// allow `alias` can be override
|
|
47
|
+
// [this.alias]: targetFilePath,
|
|
48
|
+
...getBridgeRouterAlias(originalAlias['react-router-dom']),
|
|
49
|
+
...originalAlias,
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
// Update the webpack configuration
|
|
53
|
+
compiler.options.resolve = {
|
|
54
|
+
...originalResolve,
|
|
55
|
+
alias: updatedAlias,
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export default ReactBridgeAliasChangerPlugin;
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { checkVersion, findPackageJson, getDependencies } from './utils';
|
|
4
|
+
|
|
5
|
+
const reactRouterDomV5AliasPath =
|
|
6
|
+
'@module-federation/bridge-react/dist/router-v5.es.js';
|
|
7
|
+
const reactRouterDomV6AliasPath =
|
|
8
|
+
'@module-federation/bridge-react/dist/router-v6.es.js';
|
|
9
|
+
const reactRouterDomV7AliasPath =
|
|
10
|
+
'@module-federation/bridge-react/dist/router-v7.es.js';
|
|
11
|
+
|
|
12
|
+
const createReactRouterV7Alias = (
|
|
13
|
+
reactRouterDomPath: string,
|
|
14
|
+
): Record<string, string> => {
|
|
15
|
+
const baseAlias = {
|
|
16
|
+
'react-router$': reactRouterDomV7AliasPath,
|
|
17
|
+
'react-router-dom$': reactRouterDomV7AliasPath, // Keep compatibility for old imports
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
const resolvedDistPaths: Record<string, string> = {
|
|
21
|
+
'react-router/dist/development/index.js': reactRouterDomPath,
|
|
22
|
+
'react-router/dist/production/index.js': reactRouterDomPath,
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
const legacyCompatibility: Record<string, string> = {
|
|
26
|
+
'react-router-dom/dist/index.js': reactRouterDomPath,
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
return {
|
|
30
|
+
...baseAlias,
|
|
31
|
+
...resolvedDistPaths,
|
|
32
|
+
...legacyCompatibility,
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
const createReactRouterV5Alias = (
|
|
37
|
+
reactRouterDomPath: string,
|
|
38
|
+
): Record<string, string> => {
|
|
39
|
+
return {
|
|
40
|
+
'react-router-dom$': reactRouterDomV5AliasPath,
|
|
41
|
+
'react-router-dom/index.js': reactRouterDomPath,
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const createReactRouterV6Alias = (
|
|
46
|
+
reactRouterDomPath: string,
|
|
47
|
+
): Record<string, string> => {
|
|
48
|
+
return {
|
|
49
|
+
'react-router-dom$': reactRouterDomV6AliasPath,
|
|
50
|
+
'react-router-dom/dist/index.js': reactRouterDomPath,
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
const setRouterAlias = (
|
|
55
|
+
majorVersion: number,
|
|
56
|
+
reactRouterDomPath: string,
|
|
57
|
+
): Record<string, string> => {
|
|
58
|
+
switch (majorVersion) {
|
|
59
|
+
case 5:
|
|
60
|
+
return createReactRouterV5Alias(reactRouterDomPath);
|
|
61
|
+
case 6:
|
|
62
|
+
return createReactRouterV6Alias(reactRouterDomPath);
|
|
63
|
+
case 7:
|
|
64
|
+
return createReactRouterV7Alias(reactRouterDomPath);
|
|
65
|
+
default:
|
|
66
|
+
console.warn(
|
|
67
|
+
`Unsupported React Router version: ${majorVersion}. Defaulting to v7.`,
|
|
68
|
+
);
|
|
69
|
+
return createReactRouterV7Alias(reactRouterDomPath);
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
|
|
73
|
+
export const getBridgeRouterAlias = (
|
|
74
|
+
originalAlias: string,
|
|
75
|
+
): Record<string, string> => {
|
|
76
|
+
const userDependencies = getDependencies();
|
|
77
|
+
let reactRouterDomPath = '';
|
|
78
|
+
|
|
79
|
+
if (originalAlias) {
|
|
80
|
+
reactRouterDomPath = originalAlias;
|
|
81
|
+
} else if (userDependencies['react-router']) {
|
|
82
|
+
// React Router v7 uses 'react-router' package name
|
|
83
|
+
reactRouterDomPath = path.resolve(
|
|
84
|
+
process.cwd(),
|
|
85
|
+
'node_modules/react-router',
|
|
86
|
+
);
|
|
87
|
+
} else if (userDependencies['react-router-dom']) {
|
|
88
|
+
// React Router v5/v6 uses 'react-router-dom' package name
|
|
89
|
+
reactRouterDomPath = path.resolve(
|
|
90
|
+
process.cwd(),
|
|
91
|
+
'node_modules/react-router-dom',
|
|
92
|
+
);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Generate alias based on detected router package
|
|
96
|
+
if (reactRouterDomPath) {
|
|
97
|
+
const packageJsonPath = findPackageJson(reactRouterDomPath);
|
|
98
|
+
if (packageJsonPath) {
|
|
99
|
+
const packageJsonContent = JSON.parse(
|
|
100
|
+
fs.readFileSync(packageJsonPath, 'utf-8'),
|
|
101
|
+
);
|
|
102
|
+
const majorVersion = checkVersion(packageJsonContent.version);
|
|
103
|
+
const bridgeRouterAlias = setRouterAlias(
|
|
104
|
+
majorVersion,
|
|
105
|
+
reactRouterDomPath,
|
|
106
|
+
);
|
|
107
|
+
console.log(
|
|
108
|
+
'<<<<<<<<<<<<< bridgeRouterAlias >>>>>>>>>>>>>',
|
|
109
|
+
bridgeRouterAlias,
|
|
110
|
+
);
|
|
111
|
+
return bridgeRouterAlias;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// Default to v6 which uses 'react-router-dom'
|
|
116
|
+
const bridgeRouterAlias = {
|
|
117
|
+
'react-router-dom$': reactRouterDomV6AliasPath,
|
|
118
|
+
};
|
|
119
|
+
console.log(
|
|
120
|
+
'<<<<<<<<<<<<< default bridgeRouterAlias >>>>>>>>>>>>>',
|
|
121
|
+
bridgeRouterAlias,
|
|
122
|
+
);
|
|
123
|
+
return bridgeRouterAlias;
|
|
124
|
+
};
|
package/src/utils.ts
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import semver from 'semver';
|
|
4
|
+
|
|
5
|
+
export const checkVersion = (version: string) => {
|
|
6
|
+
// Extract the version number starting from the first digit
|
|
7
|
+
const versionMatch = version.match(/\d.*/);
|
|
8
|
+
if (!versionMatch) return 0;
|
|
9
|
+
|
|
10
|
+
const cleanVersion = versionMatch[0];
|
|
11
|
+
|
|
12
|
+
if (semver.gte(cleanVersion, '5.0.0') && semver.lt(cleanVersion, '6.0.0')) {
|
|
13
|
+
return 5;
|
|
14
|
+
} else if (
|
|
15
|
+
semver.gte(cleanVersion, '6.0.0') &&
|
|
16
|
+
semver.lt(cleanVersion, '7.0.0')
|
|
17
|
+
) {
|
|
18
|
+
return 6;
|
|
19
|
+
} else if (semver.gte(cleanVersion, '7.0.0')) {
|
|
20
|
+
return 7;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
return 0;
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
export const findPackageJson = (startPath: string): string | null => {
|
|
27
|
+
let currentPath = startPath;
|
|
28
|
+
while (currentPath !== path.parse(currentPath).root) {
|
|
29
|
+
const packageJsonPath = path.join(currentPath, 'package.json');
|
|
30
|
+
if (fs.existsSync(packageJsonPath)) {
|
|
31
|
+
return packageJsonPath;
|
|
32
|
+
}
|
|
33
|
+
currentPath = path.dirname(currentPath);
|
|
34
|
+
}
|
|
35
|
+
return null;
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
export const getDependencies = () => {
|
|
39
|
+
const userPackageJsonPath = path.resolve(process.cwd(), 'package.json');
|
|
40
|
+
let userDependencies: Record<string, string> = {};
|
|
41
|
+
|
|
42
|
+
if (fs.existsSync(userPackageJsonPath)) {
|
|
43
|
+
const userPackageJson = JSON.parse(
|
|
44
|
+
fs.readFileSync(userPackageJsonPath, 'utf-8'),
|
|
45
|
+
);
|
|
46
|
+
userDependencies = {
|
|
47
|
+
...userPackageJson.dependencies,
|
|
48
|
+
...userPackageJson.devDependencies,
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
return userDependencies;
|
|
52
|
+
};
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"useDefineForClassFields": true,
|
|
4
|
+
|
|
5
|
+
/* Bundler mode */
|
|
6
|
+
"allowImportingTsExtensions": true,
|
|
7
|
+
"resolveJsonModule": true,
|
|
8
|
+
|
|
9
|
+
"declarationDir": "./dist/types",
|
|
10
|
+
"rootDir": "./src",
|
|
11
|
+
"module": "commonjs",
|
|
12
|
+
"target": "es5",
|
|
13
|
+
|
|
14
|
+
/* Linting */
|
|
15
|
+
"noUnusedLocals": true,
|
|
16
|
+
"noUnusedParameters": true,
|
|
17
|
+
"noFallthroughCasesInSwitch": true,
|
|
18
|
+
"declaration": true,
|
|
19
|
+
"emitDeclarationOnly": true,
|
|
20
|
+
"outDir": "dist",
|
|
21
|
+
"skipLibCheck": true,
|
|
22
|
+
"strict": true,
|
|
23
|
+
"moduleResolution": "node",
|
|
24
|
+
"lib": ["esnext", "dom"],
|
|
25
|
+
"jsx": "preserve",
|
|
26
|
+
"esModuleInterop": true,
|
|
27
|
+
"allowSyntheticDefaultImports": true,
|
|
28
|
+
"sourceMap": true,
|
|
29
|
+
"baseUrl": ".",
|
|
30
|
+
"paths": {
|
|
31
|
+
"@/*": ["src/*"]
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"include": [
|
|
35
|
+
"src/**/*.ts",
|
|
36
|
+
"src/**/*.tsx",
|
|
37
|
+
"src/**/*.vue",
|
|
38
|
+
"src/remoteApp.tsx",
|
|
39
|
+
"src/create.ts"
|
|
40
|
+
],
|
|
41
|
+
"references": [{ "path": "./tsconfig.node.json" }]
|
|
42
|
+
}
|
package/vite.config.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { defineConfig } from 'vite';
|
|
2
|
+
import path from 'path';
|
|
3
|
+
import dts from 'vite-plugin-dts';
|
|
4
|
+
|
|
5
|
+
export default defineConfig({
|
|
6
|
+
plugins: [
|
|
7
|
+
dts({
|
|
8
|
+
rollupTypes: true,
|
|
9
|
+
}),
|
|
10
|
+
],
|
|
11
|
+
build: {
|
|
12
|
+
lib: {
|
|
13
|
+
entry: {
|
|
14
|
+
index: path.resolve(__dirname, 'src/index.ts'),
|
|
15
|
+
},
|
|
16
|
+
formats: ['cjs', 'es'],
|
|
17
|
+
fileName: (format, entryName) => `${entryName}.${format}.js`,
|
|
18
|
+
},
|
|
19
|
+
rollupOptions: {
|
|
20
|
+
external: ['node:fs', 'node:path'],
|
|
21
|
+
},
|
|
22
|
+
minify: false,
|
|
23
|
+
},
|
|
24
|
+
});
|
package/vitest.config.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { defineConfig } from 'vitest/config';
|
|
2
|
+
import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
|
|
3
|
+
import path from 'path';
|
|
4
|
+
export default defineConfig({
|
|
5
|
+
define: {
|
|
6
|
+
__DEV__: true,
|
|
7
|
+
__TEST__: true,
|
|
8
|
+
__BROWSER__: false,
|
|
9
|
+
__VERSION__: '"unknown"',
|
|
10
|
+
__APP_VERSION__: '"0.0.0"',
|
|
11
|
+
},
|
|
12
|
+
plugins: [nxViteTsPaths()],
|
|
13
|
+
test: {
|
|
14
|
+
environment: 'jsdom',
|
|
15
|
+
include: [
|
|
16
|
+
path.resolve(__dirname, '__tests__/*.spec.ts'),
|
|
17
|
+
path.resolve(__dirname, '__tests__/*.spec.tsx'),
|
|
18
|
+
],
|
|
19
|
+
globals: true,
|
|
20
|
+
testTimeout: 10000,
|
|
21
|
+
},
|
|
22
|
+
});
|