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

typedoc: v0.19.2 adjustments #162

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Informatic
Copy link

Notable changes:

  • "Module" has been renamed to "Namespace";
  • "External module' seems to have been renamed to "Module";
  • type id of references may be missing

All tests seem to be passing, however, as I seem to be unable to find a definitive changelog/spec of typedoc JSON output, some issues may still occur. This has already been tested on our internal codebase, where old typedoc/typescript/sphinx-js would fail. With these patches applied, support for older typedoc releases will very likely be broken. module/namespace rename could be put behind some typedoc version check.

Notable changes:
 * Module has been renamed to Namespace;
 * External module seems to have been renamed to Module;
 * type id of references may be missing
@Informatic
Copy link
Author

Possibly fixes #160 / #154

@Informatic
Copy link
Author

Oops, seems like tests are failing because of typescript/typedoc upgrade, of which some transitive dependencies require Node 10, while current Travis setup is running on Node 8. All tests seemed to have passed on my Python 3.7.9 & Node v10.22.1 machine.

@erikrose
Copy link
Contributor

erikrose commented Jan 8, 2021

Just switched from Travis to CircleCI. Now we have node 14.15.1. :-)

Thanks for the patch! I'm not really concerned with breaking "internal module" support for old TS versions, since that flavor of module is, as I gather from people who use TS more than me, rarely used. I'm not sure how I feel about breaking old typedoc support. Do people generally keep up to date? Full review to come. Thanks again!

@Informatic
Copy link
Author

It should be possible to detect typedoc version on startup and change Module/Namespace checks to Module/External module on old enough versions.

@XeniaSiskaki
Copy link

Any news on when this might get merged?

@tomerghelber
Copy link

Does someone know if v0.25 and v0.19 are compatible?

@Informatic
Copy link
Author

Informatic commented Aug 12, 2021 via email

@willkg willkg added this to the 3.2 milestone Feb 23, 2022
@willkg willkg modified the milestones: 3.2.0, 3.next Dec 13, 2022
hoodmane added a commit to hoodmane/sphinx-js that referenced this pull request May 9, 2024
…#162)

This corresponds to some slightly weird code paths in convertReferenceToXRef.
Ideally we'd fix them but I don't know how.
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