idyll-lang/idyll

Invalid markup syntax will lead to crash

Open

#675 opened on Jan 5, 2021

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (1,977 stars) (97 forks)batch import
CompilerDocsRuntimebughelp wanted

Description

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Go to homepage https://idyll-lang.org/
  2. Click on the editable area and start to input []()
  3. See error

Expected behavior render []() as text. or maybe just warn user it's not valid

Screenshots N/A

Desktop (please complete the following information):

  • OS: Mac
  • Browser chrome
  • Version 87

Additional context N/A

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript basicsunderstanding of IDyll's parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The bug occurs when inputting `[]()` on the homepage editable area. The crash likely happens in the parser. Investigate the IDyll parser source, likely in the `src/` directory, to find where markdown or custom syntax is parsed. Add handling for invalid syntax like `[]()` to either render as text or show a warning. Check for existing tests and run them to ensure no regression.