Document File name has a '.js' extension - stripping it

Open Beginner friendly
#41,952 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
documentation

Research direction

Start with the module-resolution handbook page linked in the issue and compare its current explanation with the traceResolution output for the .js and .jsx examples. Document which extensions are stripped and which lookups follow, then verify that the page answers both questions without changing the compiler behavior.

Written by the indexing model from the issue text.

Description

Docs

TypeScript Version: 4.2.0-dev.20201211

Search Terms: typescript File name has a '.js' extension - stripping it

Code

https://github.com/sguillia/ts-repro-III

other.ts

import * as index from "./index.js"

index.ts

export { }

Compile with:

tsc other.ts --traceResolution

Expected behavior:

Does not compile?

Actual behavior:

$ tsc other.ts --traceResolution
...
File name '/path/to/ts-repro-III/index.js' has a '.js' extension - stripping it.
...

This document is very good:
https://www.typescriptlang.org/docs/handbook/module-resolution.html

But it doesn't talk about resolution of modules with their extensions.

The actual behavior is fine but I did not manage to find its documentation

Same issue for jsx

$ tsc other.ts --traceResolution
...
File name '/path/to/ts-repro-III/index.jsx' has a '.jsx' extension - stripping it.
...

Would it be possible to document

  • which extension are trimmed?
  • what look-ups are performed based on the file name with extension stripped?

Playground Link: https://github.com/sguillia/ts-repro-III

Related Issues: no

Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 15h
Merged PRs (30d)
106

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.

More from microsoft/TypeScript

All issues in microsoft/TypeScript

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.