relativePath returned by tsParser getFileInfo() is sometimes absolute

[mikejpeters]

The dgeni TypeScript package sometimes generates docs where doc.fileInfo.relativePath is an absolute path instead of relative. This also affects the doc.id, which I think is resolved from this property.

It seems that if readTypeScriptModules.sourceFiles is configured so that the TypeScript parser parses a file before it parses a second file that is imported by the first, it affects how the parser resolves the second file's fileName property, causing it to be an absolute path instead of relative. Based on this I don't think you can trust fileName to be relative at typescript/services/tsParser/getFileInfo.js#L7.

Example

Assuming basePath is /absolute/path/to/src and sourcePath includes:

• File A: /absolute/path/to/src/a.ts (imports ./b.ts)
• File B: /absolute/path/to/src/b.ts

If the TypeScript parser parses File A before File B, the doc for File A will have fileInfo.relativePath: "a.ts", but the doc for File B will have fileInfo.relativePath: "/absolute/path/to/src/b.ts"

[davidreher]

@petebacondarwin I will work on a PR

[petebacondarwin]

We had a problem with similar to this in the angular.io project. The solution is to use

doc.fileInfo.projectRelativePath

See angular/angular.io#1440