microsoft / microsoft/TypeScript
SourceRoot documentation inconsistent
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation liée des options du compilateur et par la documentation de tsconfig.json concernant la propriété extends, puis vérifiez comment les chemins de sourceRoot sont résolus. Mettez les deux explications en cohérence afin que le comportement documenté soit cohérent, ou documentez clairement la base réelle des chemins.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100