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

Remove transitive dependency type augmentations from build output #1855

Merged
merged 17 commits into from
Feb 10, 2022

Conversation

jclem
Copy link
Contributor

@jclem jclem commented Feb 10, 2022

This removes tests and test utilities from our TypeScript builds. Some of them import Storybook types, and doing so forces Storybook types and its dependencies' React interface augmentations like those added by @emotion/core into our types output.

This also adds a new workflow (I didn't integrate it into CI while we test it out), that ensures that a consumer of Primer React can pass TypeScript compilation with "skipLibChecks": false.

@jclem jclem requested review from a team and rezrah February 10, 2022 16:26
@changeset-bot
Copy link

changeset-bot bot commented Feb 10, 2022

🦋 Changeset detected

Latest commit: d47ca2c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2022

size-limit report 📦

Path Size
dist/browser.esm.js 62.61 KB (0%)
dist/browser.umd.js 63 KB (0%)

@jclem jclem marked this pull request as draft February 10, 2022 17:09
@jclem jclem force-pushed the remove-storybook-types branch 2 times, most recently from 9c1155a to 2f0b530 Compare February 10, 2022 17:14
@jclem jclem marked this pull request as ready for review February 10, 2022 18:07
@jclem jclem changed the title Remove tests from build output Remove transitive dependency type augmentations from build output Feb 10, 2022
* Add annotation step to test_types workflow

* Remove branch restriction from `pull_request` event

* Make tsconfig.build.json fail consumer test

* Add always() to if clause in test_types workflow

* Use clearer failed() instead of always()

* Remove brackets from workflow if

* s/status/conclusion

* s/failed/failure

* Add longer annotation

* Format workflow echo

* Attempt to use cat for multi-line annotation

* Rename to consumer test

* Add issue context links

* Nicer links in consumer test readme

* Revert "Make tsconfig.build.json fail consumer test"

This reverts commit f6a3678.

* Add consumer-test to eslintrc ignore
@jclem jclem marked this pull request as ready for review February 10, 2022 20:00
@jclem jclem requested review from colebemis and jfuchs and removed request for rezrah February 10, 2022 20:00
Copy link
Contributor

@colebemis colebemis left a comment

Choose a reason for hiding this comment

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

Thanks for the fix and for adding tests! ✨

@jclem jclem enabled auto-merge (squash) February 10, 2022 22:23
@jclem jclem merged commit c3b4ad7 into main Feb 10, 2022
@jclem jclem deleted the remove-storybook-types branch February 10, 2022 22:28
@primer-css primer-css mentioned this pull request Feb 10, 2022
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

Successfully merging this pull request may close these issues.

Storybook dependency changes types in build output
2 participants