design-system icon indicating copy to clipboard operation
design-system copied to clipboard

Turn on typechecking for text component template in showcase

Open natmegs opened this issue 9 months ago • 1 comments

:pushpin: Summary

Example of how we can use showcase to check types as a consumer for HDS components. This PR opts into template typechecking for the Text component, and similar opt in could be done for showcase templates displaying any typed HDS components.

2 issues preventing this from being merged:

  • Currently there are type failures in the text template since the type of this.model is void, even though route and controller are typed. I must be missing something as these docs indicate the type should be inferred based on route + controller
  • Using glint-expect-error to get around the above results in CLI output saying the expect error is unnecessary, but removing it results in a legit type error

:hammer_and_wrench: Detailed description

:camera_flash: Screenshots

:link: External links

Jira ticket: HDS-XXX Figma file: [if it applies]


👀 Component checklist

  • [ ] Percy was checked for any visual regression
  • [ ] A changelog entry was added via Changesets if needed (see templates here)

:speech_balloon: Please consider using conventional comments when reviewing this PR.

natmegs avatar May 16 '24 17:05 natmegs

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview May 16, 2024 6:34pm
hds-website ✅ Ready (Inspect) Visit Preview May 16, 2024 6:34pm

vercel[bot] avatar May 16 '24 17:05 vercel[bot]

@natmegs now that @aklkv PR #2109 has been merged, I think this draft PR can be closed right? (they do the same thing if I'm not wrong).

didoo avatar May 22 '24 10:05 didoo

I'm closing this PR.

didoo avatar Jun 12 '24 11:06 didoo