Skip to content

fix: improve autocomplete for session keys#13622

Merged
ascorbic merged 1 commit intomainfrom
key-autocomp
Apr 15, 2025
Merged

fix: improve autocomplete for session keys#13622
ascorbic merged 1 commit intomainfrom
key-autocomp

Conversation

@ascorbic
Copy link
Copy Markdown
Contributor

@ascorbic ascorbic commented Apr 15, 2025

Changes

Use the | (string & {}) trick to ensure that key autocomplete always works

Testing

Docs

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 15, 2025

🦋 Changeset detected

Latest commit: 4b604f3

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

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 github-actions Bot added the pkg: astro Related to the core `astro` package (scope) label Apr 15, 2025
florian-lefebvre
florian-lefebvre approved these changes Apr 15, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@florian-lefebvre florian-lefebvre left a comment

Choose a reason for hiding this comment

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

Gotta love this trick!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 15, 2025

CodSpeed Performance Report

Merging #13622 will not alter performance

Comparing key-autocomp (4b604f3) with main (406501a)

Summary

✅ 6 untouched benchmarks

ematipico
ematipico approved these changes Apr 15, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

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

Out of curiosity, what does this trick do?

@ascorbic
Copy link
Copy Markdown
Contributor Author

ascorbic commented Apr 15, 2025

@ematipico It lets you type something to accept any string, but also get autocomplete from a string union. If type something as SomeStringUnion | string then it resolves to just string, so you get no autocomplete, but due to a TypeScript quirk, typing it as SomeStringUnion | (string & {}) means it accepts any string but still gives autocomplete for the union values. This is so useful the TS team has decided to not fix the "bug".

@ascorbic ascorbic merged commit a70d32a into main Apr 15, 2025
16 checks passed
@ascorbic ascorbic deleted the key-autocomp branch April 15, 2025 14:14
@astrobot-houston astrobot-houston mentioned this pull request Apr 15, 2025
Merged
openscript pushed a commit to openscript/astro that referenced this pull request Sep 12, 2025
@ascorbic @openscript
fix: improve autocomplete for session keys (withastro#13622)
5808c5b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ematipico ematipico ematipico approved these changes

@florian-lefebvre florian-lefebvre florian-lefebvre approved these changes

Assignees

No one assigned

Labels

pkg: astro Related to the core `astro` package (scope)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ascorbic @ematipico @florian-lefebvre