Skip to content

Support baseUrl and paths as TS compiler options #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lennartjansson opened this issue Nov 17, 2016 · 4 comments
Closed

Support baseUrl and paths as TS compiler options #340

lennartjansson opened this issue Nov 17, 2016 · 4 comments

Comments

@lennartjansson
Copy link
Contributor

I need these tsconfig options to be able to run typedoc on my project without compiler errors, since I'm relying on path mapping using the paths option.

If you think this is a relatively easy task, I may be able to write the PR myself. In this case, advice/guidance/pointers to the correct area of the code would be appreciated. Thanks!

@aciccarello
Copy link
Collaborator

Hello @lennartjansson, it would be great if you put together a PR. The current maintainer took over the project from someone else so no one is an expert on the code base. Various people have been helping improve the TypeScript 2.0 support starting with #234 so your help would be greatly appreciated.

I do know that those compiler options were set to be temporarily ignored in #308 so that the compiler would run again. So I would start by removing them from that array and figuring out how to get the values to be used correctly.

@lennartjansson
Copy link
Contributor Author

Cool, will take a swing at it.

So I would start by removing them from that array and figuring out how to get the values to be used correctly.

I did try this -- baseUrl seems to parse with no further issues, but the paths option led to the error messages

Error: Unknown option `paths.*.0`.
Error: Unknown option `paths.*.1`.

etc., which suggests it's trying to parse object keys as separate options... typedoc does not consume any compiler options with object or array types already, right? The error message looks similar to the one from #234 (comment), for example.

@aciccarello
Copy link
Collaborator

@lennartjansson I haven't really looked into the relevant typedoc code but from browsing the compiler options docs it doesn't look like there were any array types prior to 2.0

@aciccarello
Copy link
Collaborator

Closed via #342

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants