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

Add list item in docs about errors in internal TypeScript dependencies. #9315

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

anthonyshew
Copy link
Contributor

@anthonyshew anthonyshew commented Oct 22, 2024

Description

A few folks have asked about this. Good to add to our tradeoffs notes!

Testing Instructions

👀

Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2024 10:13pm
8 Skipped Deployments
Name Status Preview Comments Updated (UTC)
examples-basic-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-gatsby-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview Oct 22, 2024 10:13pm

Copy link
Contributor

github-actions bot commented Oct 22, 2024

Hi there 👋

It looks like this PR introduces broken links to the docs, please take a moment to fix them before merging:

Broken link Type File
/repo/docs/guides/tools/typescript#you-likely-dont-need-a-tsconfigjson-file-in-the-root-of-your-project hash /repo-docs/crafting-your-repository/structuring-a-repository.mdx
#package-entrypoint-wildcards hash /repo-docs/guides/tools/typescript.mdx
#package-entrypoint-wildcards hash /repo-docs/guides/tools/typescript.mdx

Thank you 🙏

Copy link
Contributor

@dimitropoulos dimitropoulos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps rephrase

When directly exporting TypeScript, type-checking in a dependent package will fail if code in a dependency has TypeScript errors.

to

When directly exporting TypeScript files from a package, any type errors from this package's code will appear in packages that depend on it.

@anthonyshew anthonyshew merged commit e54d017 into main Oct 22, 2024
10 of 24 checks passed
@anthonyshew anthonyshew deleted the shew-5d34a branch October 22, 2024 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants