Skip to content
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

fix: Upgrade TypeDoc to v0.16 #103

Merged
merged 3 commits into from
Jan 14, 2020
Merged

fix: Upgrade TypeDoc to v0.16 #103

merged 3 commits into from
Jan 14, 2020

Conversation

Gerrit0
Copy link
Contributor

@Gerrit0 Gerrit0 commented Jan 12, 2020

The public API changed.

Presumably the TypedocApp extends Application class was intended to trick TypeDoc into reading tsconfig.json / typedoc.json by default. This is no longer necessary with v0.16 so long as the readers are added.


I was unable to compile locally, I believe due to #87? Though that's apparently blocked on a release of TypeDoc that has happened, so I'm not sure.

The public API changed.

Presumably the TypedocApp extends Application class was intended to trick TypeDoc into reading tsconfig.json / typedoc.json by default. This is no longer necessary with v0.16 so long as the readers are added.
@palantirtech
Copy link
Member

Thanks for your interest in palantir/documentalist, @Gerrit0! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

@Gerrit0
Copy link
Contributor Author

Gerrit0 commented Jan 12, 2020

Okay then, I guess the handlebars definitions weren't just local... Not sure what needs to be done here.

@Gerrit0
Copy link
Contributor Author

Gerrit0 commented Jan 12, 2020

Looking into the tests, some of the test failures are due to TypeDoc doing the right thing now with isExported = true for child reflections.

One test is failing for a reason I don't understand though, excludePaths appears to not be working... I didn't change anything there.

@adidahiya
Copy link
Contributor

thanks for the PR @Gerrit0! not sure what you're referring to re: excludePaths... tests seem to be passing after I updated snapshots

@adidahiya adidahiya merged commit edf55e3 into palantir:develop Jan 14, 2020
@Gerrit0
Copy link
Contributor Author

Gerrit0 commented Jan 14, 2020

Good to hear! Maybe something weird was going on with my local environment. No reflections were being excluded.

@adidahiya
Copy link
Contributor

@Gerrit0 just released 2.6.0

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

Successfully merging this pull request may close these issues.

None yet

3 participants