typedoc: v0.19.2 adjustments

mozilla / sphinx-js

Autodoc-style extraction into Sphinx for your JS project

https://pypi.python.org/pypi/sphinx-js/

MIT License

282 stars 81 forks source link

typedoc: v0.19.2 adjustments #162

Open Informatic opened 3 years ago

Informatic commented 3 years ago

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.

Informatic commented 3 years ago

Possibly fixes #160 / #154

Informatic commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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

XeniaSiskaki commented 3 years ago

Any news on when this might get merged?

tomerghelber commented 3 years ago

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

Informatic commented 3 years ago

As far as I could quickly test a couple of weeks ago, it's not and requires more sphinx-js patches :/

On Thu, 12 Aug 2021, 09:12 Tomer Ghelber, @.***> wrote:

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

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/mozilla/sphinx-js/pull/162#issuecomment-897403613, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIUEXXT7J6VYRX5Y2NU74DT4NX4JANCNFSM4U2VCNEQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email .