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!: prefer forge.config.js over package.json config #2991

Merged
merged 8 commits into from
Oct 27, 2022

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Oct 25, 2022

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable).
  • The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

This change affects the init and import commands. It changes these commands to create a forge.config.js rather than creating config.forge in your package.json.

This is considered a breaking change for any third-party templates because the base template no longer sets up a config.forge object, and any template-specific mutations to the Forge config should instead be performed on the forge.config.js file.

Ref #2973

@codecov
Copy link

codecov bot commented Oct 25, 2022

Codecov Report

Merging #2991 (05c423b) into main (1472149) will increase coverage by 0.14%.
The diff coverage is 82.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2991      +/-   ##
==========================================
+ Coverage   73.80%   73.94%   +0.14%     
==========================================
  Files          67       68       +1     
  Lines        2168     2180      +12     
  Branches      436      434       -2     
==========================================
+ Hits         1600     1612      +12     
- Misses        361      362       +1     
+ Partials      207      206       -1     
Impacted Files Coverage Δ
packages/api/core/src/api/import.ts 62.74% <56.25%> (+0.98%) ⬆️
packages/api/core/src/util/forge-config.ts 80.00% <66.66%> (-0.60%) ⬇️
packages/api/core/src/api/init-scripts/init-git.ts 92.30% <100.00%> (ø)
packages/api/core/src/api/init.ts 91.89% <100.00%> (+0.22%) ⬆️
packages/template/base/src/BaseTemplate.ts 97.72% <100.00%> (ø)
packages/template/base/tmpl/forge.config.js 100.00% <100.00%> (ø)
...ypescript-webpack/src/TypeScriptWebpackTemplate.ts 100.00% <100.00%> (ø)
packages/template/webpack/src/WebpackTemplate.ts 100.00% <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 1472149...05c423b. Read the comment docs.

@erickzhao erickzhao requested a review from a team October 26, 2022 04:43
@erickzhao erickzhao force-pushed the feat/prefer-forge-config branch from 05c423b to fac496f Compare October 26, 2022 21:56
@erickzhao erickzhao force-pushed the feat/prefer-forge-config branch from e224da8 to 6a29f0b Compare October 27, 2022 18:41
@erickzhao erickzhao marked this pull request as draft October 27, 2022 19:18
@erickzhao erickzhao marked this pull request as ready for review October 27, 2022 20:15
@erickzhao erickzhao requested a review from a team October 27, 2022 20:16
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.

3 participants