Skip to content

Commit 0a533cb

Browse files
lexasqlexasq
committedAug 26, 2023
feat(typedoc-parsetr): python script implementation
·
webpack-bundler-runtime-1.0.00.8.11
1 parent 9042be5 commit 0a533cb

17 files changed

+1275
-61
lines changed
 

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
/out-tsc
77
/build
88
/@mf-types
9+
/docs
910

1011
# dependencies
1112
node_modules
@@ -42,4 +43,4 @@ Thumbs.db
4243

4344
# Next.js
4445
.next
45-
.netlify
46+
.netlify

‎apps/docs/src/en/modules/ROOT/nav.adoc

+6-10
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,10 @@
4545
* xref:component-level-ownership.adoc[Component Level Ownership]
4646
* xref:brown-green.adoc[]
4747
48-
49-
50-
51-
52-
53-
54-
55-
56-
57-
48+
.Packages
49+
* xref:module-federation-node.adoc[@module-federation/node]
50+
* xref:module-federation-typescript.adoc[@module-federation/typescript - v2.4.2]
51+
* xref:module-federation-utilities.adoc[@module-federation/utilities]
52+
* xref:module-federation-native-federation-typescript.adoc[@module-federation/native-federation-typescript - v0.2.6]
53+
* xref:module-federation-native-federation-tests.adoc[@module-federation/native-federation-tests - v0.2.1]
5854

‎apps/docs/src/en/modules/ROOT/pages/module-federation-native-federation-tests.adoc

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
= @module-federation/native-federation-tests - v0.2.1
2+
3+
= native-federation-tests
4+
5+
Bundler agnostic plugins to share federated components for testing purposes.
6+
7+
It aims to work for both https://vitest.dev/[vitest] and https://vitest.dev/[vitest] https://jestjs.io/[jest] .
8+
9+
== Install
10+
11+
[source, javascript]
12+
----
13+
npm i -D @module-federation/native-federation-tests
14+
15+
----
16+
17+
This module provides two plugins:
18+
19+
=== NativeFederationTestsRemote
20+
21+
This plugin is used to concat the components that will be used in tests.
22+
23+
==== Configuration
24+
25+
[source, javascript]
26+
----
27+
{
28+
moduleFederationConfig: any; // the same configuration provided to the module federation plugin, it is MANDATORY
29+
additionalBundlerConfig?: TsupOptions; // additional `tsup` build options that will be merged with the one generated by the plugin, default is {}
30+
distFolder?: string; // folder used to store the dist, default is './dist'
31+
testsFolder?: string; // folder where all the files will be stored, default is '@mf-tests'
32+
deleteTestsFolder?: boolean; // indicate if the concatenated components folder will be deleted when the job completes, default is 'true'
33+
}
34+
35+
----
36+
37+
==== Additional configuration
38+
39+
Note that, for Webpack, the plugin automatically inject the `devServer.static.directory` configuration.For the other bundlers, you should configure it by yourself.
40+
41+
=== NativeFederationTestsHost
42+
43+
This plugin is used to download the concatenated components mock that will be used for tests.
44+
45+
=== Configuration
46+
47+
[source, javascript]
48+
----
49+
{
50+
moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
51+
testsFolder?: string; // folder where all the files have been stored, default is '@mf-tests',
52+
mocksFolder?: string; // folder where the concatenated files will be stored, default is './ mocks ',
53+
deleteTestsFolder?: boolean; // indicate if the tests mock folder will be deleted before the job starts, default is 'true'
54+
}
55+
56+
----
57+
58+
== Bundler configuration
59+
60+
[source, javascript]
61+
----
62+
// vite.config.ts
63+
import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/vite'
64+
export default defineConfig({
65+
plugins: [
66+
NativeFederationTestsRemote({ /* options */ }),
67+
NativeFederationTestsHost({ /* options */ }),
68+
],
69+
/* ... */
70+
server: { // This is needed to emulate the devServer.static.directory of WebPack and correctly serve the zip file
71+
/* ... */
72+
proxy: {
73+
'/@mf-types.zip': {
74+
target: 'http://localhost:3000',
75+
changeOrigin: true,
76+
rewrite: () => `/@fs/${process.cwd()}/dist/@mf-types.zip`
77+
}
78+
},
79+
fs: {
80+
/* ... */
81+
allow: ['./dist']
82+
/* ... */
83+
}
84+
}
85+
})
86+
87+
----
88+
89+
[source, javascript]
90+
----
91+
// rollup.config.js
92+
import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/rollup'
93+
export default {
94+
plugins: [
95+
NativeFederationTestsRemote({ /* options */ }),
96+
NativeFederationTestsHost({ /* options */ }),
97+
],
98+
}
99+
100+
----
101+
102+
[source, javascript]
103+
----
104+
// webpack.config.js
105+
const {NativeFederationTestsHost, NativeFederationTestsRemote} = require('@module-federation/native-federation-tests/webpack')
106+
module.exports = {
107+
/* ... */
108+
plugins: [
109+
NativeFederationTestsRemote({ /* options */ }),
110+
NativeFederationTestsHost({ /* options */ })
111+
]
112+
}
113+
114+
----
115+
116+
[source, javascript]
117+
----
118+
// esbuild.config.js
119+
import { build } from 'esbuild'
120+
import {NativeFederationTestsHost, NativeFederationTestsRemote} from '@module-federation/native-federation-tests/esbuild'
121+
build({
122+
plugins: [
123+
NativeFederationTestsRemote({ /* options */ }),
124+
NativeFederationTestsHost({ /* options */ })
125+
],
126+
})
127+
128+
----
129+
130+
[source, javascript]
131+
----
132+
// rspack.config.js
133+
const {NativeFederationTestsHost, NativeFederationTestsRemote} = require('@module-federation/native-federation-tests/rspack')
134+
module.exports = {
135+
/* ... */
136+
plugins: [
137+
NativeFederationTestsRemote({ /* options */ }),
138+
NativeFederationTestsHost({ /* options */ })
139+
]
140+
}
141+
142+
----
143+
144+
== Examples
145+
146+
To use it in a `host` module, refer to https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/host[this example] .To use it in a `remote` module, refer to https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/host[this example] https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/remote[this example] .
147+

‎apps/docs/src/en/modules/ROOT/pages/module-federation-native-federation-typescript.adoc

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
= @module-federation/native-federation-typescript - v0.2.6
2+
3+
= native-federation-typescript
4+
5+
Bundler agnostic plugins to share federated types.
6+
7+
== Install
8+
9+
[source, javascript]
10+
----
11+
npm i -D @module-federation/native-federation-typescript
12+
13+
----
14+
15+
This module provides two plugins:
16+
17+
=== NativeFederationTypeScriptRemote
18+
19+
This plugin is used to build the federated types.
20+
21+
==== Configuration
22+
23+
[source, javascript]
24+
----
25+
{
26+
moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
27+
tsConfigPath?: string; // path where the tsconfig file is located, default is ''./tsconfig.json'
28+
typesFolder?: string; // folder where all the files will be stored, default is '@mf-types',
29+
compiledTypesFolder?: string; // folder where the federated modules types will be stored, default is 'compiled-types'
30+
deleteTypesFolder?: boolean; // indicate if the types folder will be deleted when the job completes, default is 'true'
31+
additionalFilesToCompile?: string[] // The path of each additional file which should be emitted
32+
compilerInstance?: 'tsc' | 'vue-tsc' // The compiler to use to emit files, default is 'tsc'
33+
}
34+
35+
----
36+
37+
==== Additional configuration
38+
39+
Note that, for Webpack, the plugin automatically inject the `devServer.static.directory` configuration.For the other bundlers, you should configure it by yourself.
40+
41+
=== NativeFederationTypeScriptHost
42+
43+
This plugin is used to download the federated types.
44+
45+
=== Configuration
46+
47+
[source, javascript]
48+
----
49+
{
50+
moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
51+
typesFolder?: string; // folder where all the files will be stored, default is '@mf-types',
52+
deleteTypesFolder?: boolean; // indicate if the types folder will be deleted before the job starts, default is 'true'
53+
}
54+
55+
----
56+
57+
== Bundler configuration
58+
59+
[source, javascript]
60+
----
61+
// vite.config.ts
62+
import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/vite'
63+
export default defineConfig({
64+
plugins: [
65+
NativeFederationTypeScriptRemote({ /* options */ }),
66+
NativeFederationTypeScriptHost({ /* options */ }),
67+
],
68+
/* ... */
69+
server: { // This is needed to emulate the devServer.static.directory of WebPack and correctly serve the zip file
70+
/* ... */
71+
proxy: {
72+
'/@mf-types.zip': {
73+
target: 'http://localhost:3000',
74+
changeOrigin: true,
75+
rewrite: () => `/@fs/${process.cwd()}/dist/@mf-types.zip`
76+
}
77+
},
78+
fs: {
79+
/* ... */
80+
allow: ['./dist']
81+
/* ... */
82+
}
83+
}
84+
})
85+
86+
----
87+
88+
[source, javascript]
89+
----
90+
// rollup.config.js
91+
import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/rollup'
92+
export default {
93+
plugins: [
94+
NativeFederationTypeScriptRemote({ /* options */ }),
95+
NativeFederationTypeScriptHost({ /* options */ }),
96+
],
97+
}
98+
99+
----
100+
101+
[source, javascript]
102+
----
103+
// webpack.config.js
104+
const {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} = require('@module-federation/native-federation-typescript/webpack')
105+
module.exports = {
106+
/* ... */
107+
plugins: [
108+
NativeFederationTypeScriptRemote({ /* options */ }),
109+
NativeFederationTypeScriptHost({ /* options */ })
110+
]
111+
}
112+
113+
----
114+
115+
[source, javascript]
116+
----
117+
// esbuild.config.js
118+
import { build } from 'esbuild'
119+
import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/esbuild'
120+
build({
121+
plugins: [
122+
NativeFederationTypeScriptRemote({ /* options */ }),
123+
NativeFederationTypeScriptHost({ /* options */ })
124+
],
125+
})
126+
127+
----
128+
129+
[source, javascript]
130+
----
131+
// rspack.config.js
132+
const {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} = require('@module-federation/native-federation-typescript/rspack')
133+
module.exports = {
134+
/* ... */
135+
plugins: [
136+
NativeFederationTypeScriptRemote({ /* options */ }),
137+
NativeFederationTypeScriptHost({ /* options */ })
138+
]
139+
}
140+
141+
----
142+
143+
== TypeScript configuration
144+
145+
To have the type definitions automatically found for imports, add paths to the `compilerOptions` in the `tsconfig.json`:
146+
147+
[source, javascript]
148+
----
149+
{
150+
"paths": {
151+
"*": ["./@mf-types/*"]
152+
}
153+
}
154+
155+
----
156+
157+
== Examples
158+
159+
To use it in a `host` module, refer to https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/host[this example] .To use it in a `remote` module, refer to https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/host[this example] https://github.com/module-federation/module-federation-examples/tree/master/native-federation-tests-typescript-plugins/remote[this example] .
160+

0 commit comments

Comments
 (0)
Please sign in to comment.