microsoft / microsoft/TypeScript
SourceRoot documentation inconsistent
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der verlinkten Dokumentation zu den Compileroptionen und der Dokumentation zu tsconfig.json für die Eigenschaft extends, und überprüfen Sie anschließend, wie sourceRoot-Pfade aufgelöst werden. Stimmen Sie die beiden Erklärungen so aufeinander ab, dass das dokumentierte Verhalten konsistent ist, oder dokumentieren Sie die tatsächliche Pfadbasis eindeutig.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100