Examples and Docs clash

[TheCodeDestroyer]

Summary

Hiya, been digging through the docs and examples and there seem to be some clashing concepts and I am not sure what is the actual source of truth.

In examples for internal packages you use bunchee to output .js and .d.ts files and in exports you point to dist files.

But in the documentation you state that for internal packages it’s best to use tsc and point the types export to the source file.

Which is the correct and optimal approach?

Additional information

No response

Example

No response

[anthonyshew]

Both approaches are correct and situational. It is indeed simplest to use tsc when you can but some situations call for using a bundler instead.

Can you point to the parts of the docs that you're finding confusing? Happy to make some updates to clarify.

[TheCodeDestroyer]

@anthonyshew I'm just trying to figure out whats the optimal configuration for TSServer to behave properly so that its performant and so that it properly suggests auto imports in VSCode

[anthonyshew]

I understand. I'm trying to learn more about where you're finding the docs confusing, so I can make them more clear for everyone.

[TheCodeDestroyer]

I understand. I'm trying to learn more about where you're finding the docs confusing, so I can make them more clear for everyone.

I just think it would be valuable to point out optimal setup for best performance for TSServer and IDE detecting auto imports.
Should we use tsc, tsup or bunchee.
Should we point types to src or dist .d.ts.
Right now I’m having issues with VSCode not auto suggesting imports even after restarts and reinstalls.
I have read a lot about people saying that references in tsconfig should resolve these issues since this is how TSServer finds out about dependencies that have not been imported yet. But in your documentation you advise against it because of potential caching issues.
So I would really love to see a guide for optimal setup that offers the best performance for an IDE that actually works in practice.

[anthonyshew]

There isn't a singular way to do these things. Folks tend to have different opinions and preferences for the tradeoffs involved.

In the case of TypeScript's Project References, we don't recommend them but that comes with the tradeoff that you're describing.

[TheCodeDestroyer]

There isn't a singular way to do these things. Folks tend to have different opinions and preferences for the tradeoffs involved.

In the case of TypeScript's Project References, we don't recommend them but that comes with the tradeoff that you're describing.

I see so basically it shouldn't make a difference performance wise to use tsc vs tsc vs bunchee.

P.S.: Do you have any experience with incremental or composite settings in tsconfig?

[anthonyshew]

There won't be a performance difference until significant scale. 👍