feat!: improve forge configuration DX
Couple of breaking changes to improve DX
- Plugins now follow the same syntax as makers/publishers
- Better type safety of the core make/publish APIs
- Renamed electronRebuildConfig to rebuildConfig
- Fixed types for packagerConfig and rebuildConfig to appropriately Omit certain forge provided keys
With better types we can do some work to allow forge.config.ts and a completely type-safe config 🪄
Codecov Report
Merging #2963 (c0934d2) into main (6b215b0) will decrease coverage by
0.02%. The diff coverage is42.85%.
@@ Coverage Diff @@
## main #2963 +/- ##
==========================================
- Coverage 73.46% 73.44% -0.03%
==========================================
Files 67 67
Lines 2178 2180 +2
Branches 427 426 -1
==========================================
+ Hits 1600 1601 +1
- Misses 370 371 +1
Partials 208 208
| Impacted Files | Coverage Δ | |
|---|---|---|
| packages/api/core/src/api/publish.ts | 68.42% <ø> (ø) |
|
| packages/api/core/src/util/forge-config.ts | 80.59% <ø> (ø) |
|
| packages/api/core/src/util/plugin-interface.ts | 31.11% <0.00%> (-0.71%) |
:arrow_down: |
| packages/plugin/webpack/src/WebpackPlugin.ts | 38.00% <ø> (ø) |
|
| packages/api/core/src/api/make.ts | 79.20% <60.00%> (+0.20%) |
:arrow_up: |
| packages/api/core/src/api/package.ts | 75.55% <100.00%> (ø) |
|
| packages/api/core/src/api/start.ts | 64.04% <100.00%> (ø) |
|
| packages/api/core/src/util/upgrade-forge-config.ts | 98.24% <100.00%> (ø) |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update 6b215b0...c0934d2. Read the comment docs.
Docs change: https://app.gitbook.com/o/-LBKDRmeoAGTb1M5X51f/s/-LBKK1y7h_XWAtuRJG9X-4037718589/~/changes/FDdH0MpzmtwuHs3J6DWS/configuration
this reworks all the plugin docs and changes electronRebuildConfig -> rebuildConfig