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.

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!: improve forge configuration DX #2963

Merged
merged 3 commits into from
Oct 19, 2022
Merged

feat!: improve forge configuration DX #2963

merged 3 commits into from
Oct 19, 2022

Conversation

MarshallOfSound
Copy link
Member

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 🪄

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
@MarshallOfSound MarshallOfSound requested a review from a team October 13, 2022 22:11
@codecov
Copy link

codecov bot commented Oct 13, 2022

Codecov Report

Merging #2963 (c0934d2) into main (6b215b0) will decrease coverage by 0.02%.
The diff coverage is 42.85%.

Impacted file tree graph

@@            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%) ⬇️
packages/plugin/webpack/src/WebpackPlugin.ts 38.00% <ø> (ø)
packages/api/core/src/api/make.ts 79.20% <60.00%> (+0.20%) ⬆️
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 data
Powered by Codecov. Last update 6b215b0...c0934d2. Read the comment docs.

Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's avoid merging this until Gitbook docs are ready

@erickzhao erickzhao changed the title refactor: improve forge config types feat!: improve forge configuration DX Oct 13, 2022
@erickzhao
Copy link
Member

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

@erickzhao erickzhao merged commit 2c12d73 into main Oct 19, 2022
@erickzhao erickzhao deleted the improve-forge-types branch October 19, 2022 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants