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

Investigate improving "could not find entry point" error messages #2242

Closed
Gerrit0 opened this issue Apr 16, 2023 · 1 comment
Closed

Investigate improving "could not find entry point" error messages #2242

Gerrit0 opened this issue Apr 16, 2023 · 1 comment
Labels
enhancement Improved functionality
Milestone

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 16, 2023

Search Terms

Unable to find any entry points. Make sure TypeDoc can find your tsconfig.

Problem

TypeDoc's errors/warnings when determining entry points could use a lot of user experience improvements. The "make sure TypeDoc can find your tsconfig" message that is printed might have usually been the problem several years ago, but now that we use TypeScript's API to find a tsconfig file, it's very rarely the issue. In my experience it is far more likely that:

  • A file was included that was not included in the program (we should tell the user the path exists, but isn't included in the tsconfig)
  • The user provided a directory/file when TypeDoc expected a file/directory (common when first setting up packages mode)
  • Packages mode was given a directory without workspaces, and expected to expand them (Update typedoc.json Gerrit0/typedoc-packages-example#3)

Suggested Solution

Spend some time trying to break entry points in every way imaginable, and provide better error messaging describing what went wrong.

See also:

@Gerrit0 Gerrit0 added the enhancement Improved functionality label Apr 16, 2023
@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Apr 23, 2023

Note: I am excluding legacy-packages from this investigation, as it will be removed in 0.25 and I don't want to waste time on it.

@Gerrit0 Gerrit0 added this to the v0.24.6 milestone Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

1 participant