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(init): move templates from core deps to create-electron-app deps #3320

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vhashimotoo
Copy link
Contributor

  • 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 moves an array of template dependencies from the core package to create-electron-app package and adds a tool that syncs templates with the array.

This is maybe a breaking change for folks that use the electron-forge init command. So 😓. I think it's better to move the command onto create-electron-app usage since this is already proposed by docs and makes more sense.

@vhashimotoo vhashimotoo requested a review from a team as a code owner August 25, 2023 14:23
@malept
Copy link
Member

malept commented Aug 25, 2023

This is 100% a breaking change. Any use of electron-forge init will not work - even the default template (i.e., without the --template flag) will not create anything and error out.

It's also unclear when the new tool in this PR needs to be used. It needs to be documented somewhere that's not in a PR summary / comment.

@vhashimotoo
Copy link
Contributor Author

This is 100% a breaking change. Any use of electron-forge init will not work - even the default template (i.e., without the --template flag) will not create anything and error out.

What about is to leave this as a breaking change, and hiding init command from cli? Docs already recommend using npx create-electron-app, and I don't think/see many users using electron-forge init approach.

It's also unclear when the new tool in this PR needs to be used. It needs to be documented somewhere that's not in a PR summary / comment.

Are the docs in template/readme or tools/readme appropriate?

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.

None yet

2 participants