microsoft / microsoft/TypeScript

Backticks around module names in module declarations

Open
#31,697 0 comments 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

  • backticks
  • module declaration
  • NoSubstitutionTemplateLiteral
  • template string

Other related issues/PRs:

Suggestion

It'd be nice for backticks to be allowed in module declarations. For example:

declare module `semver` {}

This causes an error with typescript 3.5.1: Cannot invoke an expression whose type lacks a call signature. Type 'NodeModule' has no compatible call signatures.ts(2349)

Use Cases

I'd like to be able to use backticks more consistently in my code.

Similar to https://github.com/microsoft/TypeScript/issues/30962:

This is especially important because the backticks mode of the quotes rule from ESLint breaks programs (cf yarnpkg/berry#70 for an example). While it could be seen as an ESLint bug, I think it should be possible for TS to use raw template string interchangeably with regular strings as long as they don't contain variables.

Examples

This would be allowed

declare module `semver` {}

and would be equivalent to

declare module 'semver' {}

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading the related issue #30962 and fix in PR #31042, then trace how module declarations are handled, since issue #31548 notes they differ internally. The work is done when a no-substitution template literal is accepted in a module declaration and behaves like the equivalent quoted name, with coverage for the examples in this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.