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

ban using @internal items in examples #3746

Merged
merged 1 commit into from
May 14, 2024
Merged

Conversation

SomeHats
Copy link
Contributor

There's been some confusion in the community as our example use a few @internal methods. These things are intended for use inside the tldraw library, but aren't a part of the public API. That means that when those examples are copied out of the tldraw repo, those @internal references produce errors.

This diff bans the use of items tagged as @internal inside our examples app by adding an eslint plugin (adapted from the one we already have that protects against deprecated types) preventing them.

Change Type

  • docs — Changes to the documentation, examples, or templates.
  • bugfix — Bug fix
  • tools — Changes to infrastructure, CI, internal scripts, debugging tools, etc.

Copy link

vercel bot commented May 13, 2024

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

Name Status Preview Updated (UTC)
examples ✅ Ready (Inspect) Visit Preview May 13, 2024 11:05am
1 Ignored Deployment
Name Status Preview Updated (UTC)
tldraw-docs ⬜️ Ignored (Inspect) May 13, 2024 11:05am

@huppy-bot huppy-bot bot added bugfix Fixes a bug of some kind docs Changes only affect the documentation tools Changes to infrastructure, CI, internal scripts, debugging tools, etc. labels May 13, 2024
@ds300 ds300 added this pull request to the merge queue May 14, 2024
Merged via the queue into main with commit 5a15c49 May 14, 2024
13 checks passed
@ds300 ds300 deleted the alex/ban-internal-examples branch May 14, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Fixes a bug of some kind docs Changes only affect the documentation tools Changes to infrastructure, CI, internal scripts, debugging tools, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants