shellscape / shellscape/jsx-email

Preview crashes when template is saved with errors

Open
#457 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.3k
Forks
55
PR merge metrics
No merged PRs in 30d

Description

  • Component or Package Name: jsx-email
  • Component or Package Version: v3.2.1
Expected Behavior / Situation

While creating templates, I sometimes save a template file while it has errors in it. One of the reasons I do this, is to trigger formatting, as this runs on save. Also, I sometimes just do it thoughtlessly, because of muscle memory.

I would expect the preview build to allow this, so that I can fix the errors, save my file again, and continue.

Actual Behavior / Situation

However, as soon as I save my file with errors in it, the email preview build fails and the process ends. Therefore, I have to run the startup command again to fix it. This slows me down massively in the development process.

Modification Proposal

I propose to adjust the behavior of the preview process. On error, it does not end, but only displays an error in the terminal. When there are errors in the file, the preview just does not update, or shows an error message over top.

I am also fine with other behavior, as long as I don't have to run the command every time.

I would love to hear your thoughts on this! It would be a great improvement if this gets implemented in some way!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the preview build and file-save/watch entry point; the issue does not name a file, test, or command beyond the startup command. Reproduce by saving a template with errors, then trace how the preview process handles the build failure. Done means the process stays running and the preview remains usable or visibly reports the error until the next successful save.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, developer-experience
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.