Microsoft/TypeScript

Not all leading tab characters in diagnostic messages are replaced with spaces

Open

#41,268 opened on Oct 27, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: Error MessagesHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

The error diagnostics that are used by default do not replace ALL leading tab characters with a single space.

As one would expect from seeing this code line in souce code: https://github.com/microsoft/TypeScript/blob/85ef91e2233fa384e980005c109fadc04376ce3e/src/compiler/program.ts#L410

This line only replaces the first leading tab character. Which causes way too much leading whitespace printed in the logs when errors occur during tsc build.

TypeScript Version: 4.0.3

Search Terms: tabs diagnostics, reporter, formatCodeSpan, formatDiagnosticsWithColorAndContext, leading tabs,

Expected behavior: Source code has four leading tabs for indentation.

[line number] [gutter seperator] [space] [space] [space] [space] [line content]

image

Actual behavior: [line number] [gutter seperator] [space] [tab] [tab] [tab] [line content]

image

PR I can submit a PR for this that would change this line: lineContent = lineContent.replace("\t", " "); // convert tabs to single spaces to: lineContent = lineContent.replace(/\t/gy, " "); // convert all leading tabs to single spaces

Contributor guide

Research direction
Look at the source code in src/compiler/program.ts around line 410. The current line uses `replace("\t", " ")` which only replaces the first tab. Change it to `replace(/\t/gy, " ")` to replace all leading tabs. Test the change and submit a PR.
Tech stack
typescript
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
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.
90