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

Dependency discovery #7

Open
keithlayne opened this issue Jul 14, 2021 · 3 comments
Open

Dependency discovery #7

keithlayne opened this issue Jul 14, 2021 · 3 comments

Comments

@keithlayne
Copy link
Collaborator

For the purpose of cross-linking, this seems potentially tricky.

On one hand, you could examine package.json and just go with top-level runtime deps. That could be an okay first cut but would be suboptimal for lots of reasons.

Would be nice if we could use typedoc/compiler API/whatever to determine actual dependencies. This seems problematic possibly, but maybe I'm overthinking it. I was considering module resolution - but I know TS doesn't handle for example imports and exports yet in `package.json.

This is mainly future brainstorming. Please correct any bad assumptions I've made.

@cspotcode
Copy link
Collaborator

Using typedoc or the compiler API would avoid false-positives, because dependencies in package.json may not be referenced in the type declarations.

I wonder, typedoc has options to configure what is and is not considered an "external" type. Maybe it can help.

@keithlayne
Copy link
Collaborator Author

I was also thinking of how lots of people screw up runtime/dev/peer deps, but I imagine that's more end users and not lib autthors.

I was thinking of some other issues but I think I'm worrying about stuff that we should punt on for now.

@cspotcode
Copy link
Collaborator

cspotcode commented Jul 14, 2021 via email

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

No branches or pull requests

2 participants