Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Somewhat misleading escape tokens in String.raw tagged templates

Open
#1,039 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
tooling

Research direction

Start by inspecting the TypeScript TextMate grammar rules used for template strings and tagged templates, reproducing the String.raw examples in VS Code. Check the displayed escape tokens against the requested behavior, including the unclosed template-string case; done means String.raw content no longer shows misleading escape tokens while meaningful backslashes still affect parsing.

Written by the indexing model from the issue text.

Description

JavaScript and TypeScript Nightly version:

Code

// Please include a code snippet that demonstrates the issue
String.raw`--some-flag=C:\Some\Windows\Path` // It looks like the first letter of each dir is being escaped
String.raw`"This is\nJSON text\u2757"` // It looks like '\n' is being escaped
Example of how it looks in VSCode

image

Since String.raw is an EcmaScript standard, it's probably ideal that the grammar shows those string tokens without any escape tokens.

Important to note that backslashes shouldn't be ignored in the pattern, for example:

//        ╭─ Template string opener
//        ┴
String.raw`\`;
//         ─┬─
//          ╰─ Unclosed template string content
Dominant language
TypeScript
Stars
471
Forks
149
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/TypeScript-TmLanguage

All issues in microsoft/TypeScript-TmLanguage

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.