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

feat: Restrict types for Spring and Tween #14862

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

webJose
Copy link
Contributor

@webJose webJose commented Dec 29, 2024

Closes Improve Spring data typing, or improving it so it doesn't bother about unsupported data types #14851

This PR introduces the MotionPrimitive and MotionRecord data types to accurately reflect what the algorithms of the Spring and Tween classes can handle.

The alternative would be to remove the throwing whenever an unsupported data type is found, but I suppose that is a breaking change and if that's the preferred route, then it would have to wait for Svelte v6. Therfore, this PR should greatly increase the accuracy of Intellisense when using Spring and Tween.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Closes Improve Spring data typing, or improving it so it doesn't bother about unsupported data types sveltejs#14851
Copy link

changeset-bot bot commented Dec 29, 2024

⚠️ No Changeset found

Latest commit: f0a6b6d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@14862

Copy link
Contributor Author

@webJose webJose left a comment

Choose a reason for hiding this comment

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

PR in draft mode. Kindly let me know if this is something the core team would like to pursue. If so, I'll follow any additional instructions I am given and take the PR out of draft mode. Thanks!

@Ocean-OS
Copy link
Contributor

One thing to account for is that arrays containing numbers are supported, so perhaps MotionRecord could be changed to include arrays like so:

export type MotionRecord = {
	[x: string | number]: MotionPrimitive | MotionRecord | (MotionPrimitive | MotionRecord)[];
} | (MotionPrimitive | MotionRecord)[]

@webJose
Copy link
Contributor Author

webJose commented Dec 30, 2024

One thing to account for is that arrays containing numbers are supported, so perhaps MotionRecord could be changed to include arrays like so:

export type MotionRecord = {
	[x: string | number]: MotionPrimitive | MotionRecord | (MotionPrimitive | MotionRecord)[];
} | (MotionPrimitive | MotionRecord)[]

It's already accounted for. T extends from MotionRecord[string], which is MotionPrimitive, MotionRecord or arrays containing either of those. You can test this in the TS playground.

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.

2 participants