scalameta/mdoc

Worksheet mode adds spaces into multiline strings

Open

#722 opened on Dec 8, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Scala (89 forks)github user discovery
buggood first issue

Repository metrics

Stars
 (402 stars)
PR merge metrics
 (Avg merge 8h 29m) (11 merged PRs in 30d)

Description

Describe the bug

The worksheet seems to tabulate the inside of multi-line strings, resulting in unexpected spaces

  1. Metals: Create Worksheet
  2. Write
val s = """
""".length
  1. Worksheet adds comment: // : Int = 5

Expected behavior

Should not add extra characters inside multiline strings

The example should add the comment //: Int = 1

Operating system

Windows

Editor/Extension

VS Code

Version of Metals

0.11.9 ?

Extra context or search terms

No response

Contributor guide

Research direction
Examine how the worksheet mode in Metals processes multiline strings. Look at the code that formats or pretty prints the output, particularly how string literals are handled. Check for any regex or whitespace normalization that might introduce extra spaces inside triple quoted strings.
Tech stack
scala
Domain
tooling
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.
Half day
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
ScalaGitsbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55