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

Support for the Typedoc 0.26 #16

Closed
Fancy2209 opened this issue Jun 7, 2024 · 10 comments
Closed

Support for the Typedoc 0.26 #16

Fancy2209 opened this issue Jun 7, 2024 · 10 comments
Labels
enhancement New feature or request

Comments

@Fancy2209
Copy link

I am using the Beta for the packageOptions property of tsconfig.json, but would prefer if the modules were all under the name of the Module like this plugin does, is there any way I could use it with 0.26.0-beta.2?

@krisztianb
Copy link
Owner

krisztianb commented Jun 7, 2024

Did you run into any problems with the new TypeDoc version? I'm not planing to update the plugin until TypeDoc 0.26 is officially released.

@Fancy2209
Copy link
Author

Fancy2209 commented Jun 7, 2024

Did you run into any problems with the new TypeDoc version? I'm not planing to update the plugin until TypeDoc 0.26 is officially released.

The peer depedencies don't have 0.26.x set so npm refuses to install it normally, and I fear i'll break something using legacy-peer-deps or force

@krisztianb
Copy link
Owner

Yeah, there is a reason I was defensive with defining the peer dependencies. Most major updates broke my plugins.

What do you think would break if you force the update?

Btw. you could change this line in your node_modules folder to satisfy npm and see what happens.

@krisztianb krisztianb added the question Further information is requested label Jun 8, 2024
@Fancy2209
Copy link
Author

Fancy2209 commented Jun 11, 2024

Yeah, there is a reason I was defensive with defining the peer dependencies. Most major updates broke my plugins.

What do you think would break if you force the update?

Btw. you could change this line in your node_modules folder to satisfy npm and see what happens.

I stopped beeing able to click classes and their icons dissapeared, it also didn't actually merge them
i guess I'll need to wait for 0.26 Stable, shame :/, it has 3 things I need (Proper Markdown in the On this page part of the sidebar, fix for using msys2 git instead (typedoc takes 2.5 hours making the docs if I don't use 0.26.0-beta.3!), packageOptions)

@ben-polinsky
Copy link

ben-polinsky commented Jun 13, 2024

I was unable to get this plugin to work with the packages entry point strategy, FYI. I plan on getting a minimal reproduction up today.

Edit: My bad, I see that was released in 0.25.12. I'll open a different issue if needed.

@krisztianb
Copy link
Owner

I was unable to get this plugin to work with the packages entry point strategy, FYI. I plan on getting a minimal reproduction up today.

Edit: My bad, I see that was released in 0.25.12. I'll open a different issue if needed.

Hi Ben. You can find examples for monorepo setups (using the "packages" entry point strategy) in the test folder here on GitHub: https://github.com/krisztianb/typedoc-plugin-merge-modules/tree/master/test

Please take a look and compare your setup. If you still think that there is an issue with the plugin please open another issue. Thank you.

@ben-polinsky
Copy link

Please take a look and compare your setup. If you still think that there is an issue with the plugin please open another issue. Thank you.

Appreciate it, will do.

@krisztianb krisztianb changed the title Support for the Typedoc 26 Beta? Support for the Typedoc 26 Jun 22, 2024
@krisztianb krisztianb changed the title Support for the Typedoc 26 Support for the Typedoc 0.26 Jun 22, 2024
@krisztianb
Copy link
Owner

TypeDoc 0.26 has been released and I can confirm that the plugin is no longer working correctly. Will have to debug the problem.

@krisztianb krisztianb added enhancement New feature or request under investigation Still figuring out what this is and removed question Further information is requested labels Jun 22, 2024
@krisztianb krisztianb removed the under investigation Still figuring out what this is label Jun 30, 2024
@krisztianb
Copy link
Owner

I published version 6.0.0 which should work with TypeDoc 0.26.x

Please try it and report back if you find any issues. Thank you.

@Fancy2209
Copy link
Author

seems to work

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

When branches are created from issues, their pull requests are automatically linked.

3 participants