Skip to content

Commit f48d447

Browse files
steven-pribilinskiysteven-pribilinskiy
authored
Merge pull request #2 from cloudbeds/add-source-dest-options
fix: docs: remove duplicate feature tables
2 parents 0bc28cd + d171411 commit f48d447

File tree

3 files changed

+31
-48
lines changed

3 files changed

+31
-48
lines changed

‎.github/workflows/push.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Push to branch
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
- '!main'
8+
9+
jobs:
10+
push:
11+
uses: cloudbeds/workflows/.github/workflows/npm-test-build.yml@main
12+
secrets:
13+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Build and publish npm package
33
on:
44
push:
55
branches:
6-
- main
6+
- 'main'
77

88
jobs:
99
publish:

‎README.md‎

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,6 @@ Global type definitions from _src/@types/*.d.ts_ are included in compilation.
99

1010
Paths can be customized to meet your environment.
1111

12-
## Feature comparison tables
13-
14-
| Feature | @touk/<br>federated-types | ruanyl/dts-loader | ruanyl/webpack-remote-types-plugin | @module-federation/typescript | @cloudbeds/wmf-types-plugin |
15-
|------------------------------------|---------------------------|-------------------|------------------------------------|-------------------------------|-----------------------------|
16-
| Webpack Plugin | - | + | + | + | + |
17-
| Standalone | + | - | - | - | + |
18-
| Polyrepo support | - | + | + | + | + |
19-
| Runtime microapp imports | - | - | - | - | + |
20-
| Support typings from node_modules | - | - | - | - | + |
21-
| Webpack aliases | - | - | - | - | + |
22-
| Exposed aliases | + | + | + | - | + |
23-
| Excessive recompilation prevention | - | - | - | - | + |
24-
25-
*_Runtime microapp imports_ refers to templated remote URLs that are resolved in runtime using
26-
[module-federation/external-remotes-plugin](https://github.com/module-federation/external-remotes-plugin)
27-
28-
*_Synchronization_ refers to [webpack compile hooks](https://webpack.js.org/api/compiler-hooks/)
29-
30-
*_Excessive recompilation_ refers to the fact that the plugin is not smart enough to detect when the typings file is changed.
31-
Every time a `d.ts` file is downloaded, webpack recompiles the whole bundle because the watcher compares the timestamp only, which is updated on every download.
32-
33-
| Package | Emitted destination | Download destination | Synchronization/[compile hooks](https://webpack.js.org/api/compiler-hooks/) |
34-
|------------------------------------|------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------|
35-
| @touk/federated-types | file in <br> `node_modules/@types/__federated_types` | - | - |
36-
| ruanyl/dts-loader | folders in <br> `.wp_federation` | - | - |
37-
| ruanyl/webpack-remote-types-plugin | - | `types/[name]-dts` | download on `beforeRun` and `watchRun` |
38-
| @module-federation/typescript | folders in <br> `dist/@mf-typescript` | `@mf-typescript` | compile and download on `afterCompile` (leads to double compile), <br> redo every 1 minute when idle |
39-
| @cloudbeds/wmf-types-plugin | file in <br> `dist/@types` | `@remote-types` | download on startup, <br> compile `afterEmit`, <br> download every 1 minute or custom interval when idle |
40-
41-
4212
## Installation
4313

4414
```sh
@@ -246,16 +216,16 @@ After a month of waiting this package was built.
246216

247217
## Feature comparison tables
248218

249-
| Feature | @touk/<br>federated-types | ruanyl/dts-loader | ruanyl/webpack-remote-types-plugin | @module-federation/typescript | @cloudbeds/wmf-types-plugin |
250-
|------------------------------------|---------------------------|-------------------|------------------------------------|-------------------------------|-----------------------------|
251-
| Webpack Plugin | - | + | + | + | + |
252-
| Standalone | + | - | - | - | + |
253-
| Polyrepo support | - | + | + | + | + |
254-
| Runtime microapp imports | - | - | - | - | + |
255-
| Include external typings | - | - | - | - | - |
256-
| Webpack aliases | - | - | - | - | + |
257-
| Exposed aliases | + | + | + | - | + |
258-
| Excessive recompilation prevention | - | - | - | - | + |
219+
| Feature | @touk/<br>federated-types | ruanyl/dts-loader | ruanyl/webpack-remote-types-plugin | @module-federation/typescript | @cloudbeds/webpack-module-federation-types-plugin |
220+
|------------------------------------|---------------------------|-------------------|------------------------------------|-------------------------------|---------------------------------------------------|
221+
| Webpack Plugin | - | + | + | + | + |
222+
| Standalone | + | - | - | - | + |
223+
| Polyrepo support | - | + | + | + | + |
224+
| Runtime microapp imports | - | - | - | - | + |
225+
| Support typings from node_modules | - | - | - | - | + |
226+
| Webpack aliases | - | - | - | - | + |
227+
| Exposed aliases | + | + | + | - | + |
228+
| Excessive recompilation prevention | - | - | - | - | + |
259229

260230
*_Runtime microapp imports_ refers to templated remote URLs that are resolved in runtime using
261231
[module-federation/external-remotes-plugin](https://github.com/module-federation/external-remotes-plugin)
@@ -267,12 +237,12 @@ changed.
267237
Every time a `d.ts` file is downloaded, webpack recompiles the whole bundle because the watcher compares the timestamp
268238
only, which is updated on every download.
269239

270-
| Package | Emitted destination | Download destination | Synchronization/[compile hooks](https://webpack.js.org/api/compiler-hooks/) |
271-
|------------------------------------|------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------|
272-
| @touk/federated-types | file in <br> `node_modules/@types/__federated_types` | - | - |
273-
| ruanyl/dts-loader | folders in <br> `.wp_federation` | - | - |
274-
| ruanyl/webpack-remote-types-plugin | - | `types/[name]-dts` | download on `beforeRun` and `watchRun` |
275-
| @module-federation/typescript | folders in <br> `dist/@mf-typescript` | `@mf-typescript` | compile and download on `afterCompile` (leads to double compile), <br> redo every 1 minute when idle |
276-
| @cloudbeds/wmf-types-plugin | file in <br> `dist/@types` | `src/@types/remotes` | download on startup, <br> compile `afterEmit`, <br> download every 1 minute or custom interval when idle |
240+
| Package | Emitted destination | Download destination | Synchronization/[compile hooks](https://webpack.js.org/api/compiler-hooks/) |
241+
|---------------------------------------------------|------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------|
242+
| @touk/federated-types | file in <br> `node_modules/@types/__federated_types` | - | - |
243+
| ruanyl/dts-loader | folders in <br> `.wp_federation` | - | - |
244+
| ruanyl/webpack-remote-types-plugin | - | `types/[name]-dts` | download on `beforeRun` and `watchRun` |
245+
| @module-federation/typescript | folders in <br> `dist/@mf-typescript` | `@mf-typescript` | compile and download on `afterCompile` (leads to double compile), <br> redo every 1 minute when idle |
246+
| @cloudbeds/webpack-module-federation-types-plugin | file in <br> `dist/@types` | `src/@types/remotes` | download on startup, <br> compile `afterEmit`, <br> download every 1 minute or custom interval when idle |
277247

278248

0 commit comments

Comments
 (0)