beautifier/js-beautify

Beautification problem with JS Single Line Comment <!--

Open

#1,835 opened on Aug 31, 2020

View on GitHub
 (10 comments) (0 reactions) (1 assignee)JavaScript (1,460 forks)batch import
good first issuelanguage: javascripttype: bug

Repository metrics

Stars
 (8,342 stars)
PR merge metrics
 (Avg merge 51d 1h) (16 merged PRs in 30d)

Description

In Javascript <!-- is treated as a single-line comment just like //.

js-beautify works as expected when the line starts with <!--:

Input: <!--alert(1)commented

Output: <!--alert(1)commented

Otherwise it will break the syntax:

Input: alert(1)<!--commented

Output: alert(1) < !--commented

Contributor guide

Research direction
Inspect the JavaScript tokenizer in js beautify to find where `<! ` is handled. Look for patterns that incorrectly add spaces after `alert(1)` when followed by `<! `. Fix the tokenization or formatting logic to preserve `<! ` as a single line comment.
Tech stack
javascript
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75