Microsoft/vscode

[html] Formatting Breaks with Space Between Commented Lines in Script Tag

Open

#213,628 opened on May 28, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)TypeScript (10,221 forks)batch import
bughelp wantedhtml

Repository metrics

Stars
 (74,848 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

Does this issue occur when all extensions are disabled?: Yes

When commenting out sections in a script tag, the HTML formatting breaks if there is a line with at least 1 space in between 2 commented out lines. ( Highlighting the following code block may help clarify. )

<script>
    //
 
    //
             </script>

Steps to Reproduce:

  1. Copy and paste the code block shown above into a blank HTML file in vscode.
  2. Format the HTML using the Format Document command ( keyboard shortcut is usually Ctrl + Shift + I ) .
  3. Document will not format
  4. Remove the single space ( not the line ) between the 2 commented out lines.
  5. Format HTML using same method as Step 2.
  6. Document should be formatted.

Contributor guide

Research direction
Investigate the HTML formatter in VS Code, specifically how it handles script tag content with consecutive commented lines separated by whitespace. Look at the formatting logic in `extensions/html language features/server/src/htmlFormatter.ts` and trace the handling of script tag children.
Tech stack
typescript
Domain
developer experiencetooling
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70