Skip to content

Update for typescript v3.1.x #824

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
wants to merge 2 commits into from

Conversation

ahocevar
Copy link
Contributor

@ahocevar ahocevar commented Aug 2, 2018

I am trying to update TypeDoc to use typescript@next, which has some new features that we will be relying on in OpenLayers (see openlayers/openlayers#8449).

I think I was able to update the code properly, but I'm struggling with one failing test:

One thing I noticed is that none of the specs have the isExported: true flag set any more when regenerated with my code. Maybe that's related?

Any help here would be much appreciated.

I'm also willing to continue working on this pull request if there are more requirements for updating to a newer version that I might be missing. I'd be thankful for any comments or reviews.

Fixes #822.

@ahocevar
Copy link
Contributor Author

ahocevar commented Aug 2, 2018

Thanks to looking at #825, I was able to fix the isExported issue. All test pass now.

@VictorQueiroz
Copy link

This is a must have, we can't generate docs for projects with lower version of TypeScript right now. What's missing to accept this PR?

@lf94
Copy link

lf94 commented Aug 9, 2018

I too need this. Lets do anything we need to get this in.

@cedx
Copy link

cedx commented Aug 9, 2018

TypeDoc should try to use the local TypeScript package (i.e. declared in package.json file), if any one is already installed. Relying on a development version of TypeScript is not a good idea from my point of view...

@lf94
Copy link

lf94 commented Aug 9, 2018

TypeDoc should try to use the local TypeScript package (i.e. declared in package.json file), if any one is already installed. Relying on a development version of TypeScript is not a good idea from my point of view...

Agreed for everything. IMO your suggestion should be another MR.

This MR should still be merged to encourage people to update. Typescript 3 - Typescript ~2.5 or whichever version typedoc is on, is not a huge difference. Actually it turns out I don't need this MR to get my stuff to work, but regardless, it would be nice.

Who do we poke to move this forward?

@ahocevar
Copy link
Contributor Author

ahocevar commented Aug 9, 2018

When merged, this could simply be published as typedoc@next.

@aciccarello
Copy link
Collaborator

@lf94 you poke me. I made some testing updates yesterday. I hope to get dependencies updated soon

@ahocevar
Copy link
Contributor Author

ahocevar commented Aug 10, 2018

I'm not entirely sure, but it looks like even with this update the @enum and @typedef JSDoc annotations that TypeScript supports now do not generate correct output:

untitled

The above was generated from

/** @typedef {Array<number>} Coordinate */

/** @enum {number} */
export const Source = {
  UNKNOWN: 0,
  GPS: 1,
  MANUAL: 2
};

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.

5 participants