SourceRoot documentation inconsistent

Open

#28,099 opened on Oct 24, 2018 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: 35/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: typescript
Domain: documentation

Research direction

Start with the linked compiler options documentation and the tsconfig.json documentation for the extends property, then verify how sourceRoot paths are resolved. Reconcile the two explanations so the documented behavior is consistent, or document the actual path base clearly.

Written by the indexing model from the issue text.

Description

Docs

In the compiler options documentation is sourceRoot explained as follows:

Specifies the location where debugger should locate TypeScript files instead of source locations. Use this flag if the sources will be located at run-time in a different location than that at design-time. The location specified will be embedded in the sourceMap to direct the debugger where the source files will be located.

In the documentation of the extends property is explained that all path are relative to the file they originated in.

All relative paths found in the configuration file will be resolved relative to the configuration file they originated in.

I have understood that the path in sourceRoot is relative to the compiled files and points to the source files. sourceRoot is not relative to the configuration file it originates in. If I use a path relative to the configuration file, the source files are not found.

Expected behavior:
The documentation must be consistent or the path must be relative to the file they originated in.

Dominant language: Go
Stars: 111k
Forks: 14.4k
Avg merge: 1d 19h
Merged PRs (30d): 117

Contributor guide

Open the contributing guide

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.

Similar issues

[optimization:agents-md-curator] AGENTS.md: compress duplicated Debugging & Logging section and merge redundant autopilot rules Open

optimization optimization:agents-md-curator

Difficulty 2/5 1-3 hours Newbie friendliness 86/100

githubnext/gh-aw-cao#13143 · Opened Sep 20, 2026
fix(ui/spend): normalize mnemonic before keystore reattach comparison Open

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

blinklabs-io/bursa#904 · Opened Sep 20, 2026
docs(parser): clarify State callback lifecycle Open

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

yanet-platform/ipfw-go#129 · Opened Sep 20, 2026
[confmap/provider/googlesecretmanagerprovider] Missing URI format validation for Google Secret Manager resource paths Open

bug confmap/provider/googlesecretmanagerprovider needs triage

Difficulty 2/5 1-3 hours Newbie friendliness 72/100

open-telemetry/opentelemetry-collector-contrib#51273 · 2 comments · Opened Sep 20, 2026
bug: AI Gateway client filter lists "Unknown" twice when NULL and literal Unknown clients coexist Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 90/100

coder/coder#29623 · 1 comment · Opened Sep 20, 2026

More Go issues