Skip to content

re-open #111 (2015) every single class in project is NOT named default #1993

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
dvtate opened this issue Jul 10, 2022 · 3 comments
Closed

re-open #111 (2015) every single class in project is NOT named default #1993

dvtate opened this issue Jul 10, 2022 · 3 comments
Labels
wontfix Declining to implement

Comments

@dvtate
Copy link

dvtate commented Jul 10, 2022

Search terms

This issue is previously defined as #111 export default class Anything.

Expected Behavior

it should use name given to default exports instead of having multiple default identifiers. I do not care if it uses the name assigned to it in the import declaration or the name given in the export default binding (although the former makes most sense to me).

It's very common in enterprise/OO codebases for each file to have a single export default class UsefulName { ... } however with typedoc literally everything will be called default and thus the generated documentation will be almost useless

Actual Behavior

it uses multiple ambiguous default identifiers.

Steps to reproduce the bug

self explanatory

Environment

Note that I'm targeting esm and import statements end with .js because typescript is poorly designed, not sure if that's relevant

  • Typedoc version: 0.22.18
  • TypeScript version: 4.7.3
  • Node.js version: v18.3.0
  • OS: Linux archbook 5.18.5-arch1-1 Name of commandline tool #1 SMP PREEMPT_DYNAMIC Thu, 16 Jun 2022 20:40:45 +0000 x86_64 GNU/Linux

image
image

@dvtate dvtate added the bug label Jul 10, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 10, 2022

@Gerrit0 Gerrit0 added the wontfix Declining to implement label Jul 10, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 10, 2022

The plugin above is the recommended way to handle this case. TypeDoc works by export names, for which default is the correct name.

@Gerrit0 Gerrit0 closed this as not planned Won't fix, can't repro, duplicate, stale Jul 10, 2022
@dvtate
Copy link
Author

dvtate commented Jul 10, 2022

thanks!

@Gerrit0 Gerrit0 removed the bug label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix Declining to implement
Projects
None yet
Development

No branches or pull requests

2 participants