microsoft / microsoft/TypeScript-TmLanguage
Somewhat misleading escape tokens in String.raw tagged templates
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
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
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100