angular / dgeni-packages

A collection of dgeni packages for generating documentation from source code.
MIT License
142 stars 106 forks source link

feat(typescript): add `realFilePath`/`realProjectRelativePath` to `FileInfo` #238

Closed gkalpak closed 7 years ago

gkalpak commented 7 years ago

The file paths returned by TypeScript may contain symlinks. This is fine most of the time, since the path points to the correct file, but in certain cases (e.g. when we want to generate GitHub links based on the project-relative path) it is necessary to know the real path to the file (without symlinks).

This commit adds two new properties, realFilePath and realProjectRelativePath, which are based on the real path to the file.

(Related to angular/angular#18353.)

petebacondarwin commented 7 years ago

Published as dgeni-packages@0.20.0. @gkalpak - feel free to update aio project with this new version