[enhanced-image] support svelte 5 + fix types #12822
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: fe5becc The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
pngwn
commented
Oct 16, 2024
| "svelte": "^4.2.10", | ||
| "typescript": "^5.3.3", | ||
| "svelte": "^5.0.0-next.0", | ||
| "typescript": "^5.6.3", |
There was a problem hiding this comment.
Required to support top-level jsdoc type imports.
Comment on lines
-5
to
+7
| import { asyncWalk } from 'estree-walker'; | ||
| import { walk } from 'zimmerframe'; |
There was a problem hiding this comment.
asyncWalk didn't like my types.
| @@ -32,7 +34,7 @@ export function image(opts) { | |||
| } | |||
|
|
|||
| const s = new MagicString(content); | |||
| const ast = parse(content, { filename }); | |||
| const ast = parse(content, { filename, modern: true }); | |||
Comment on lines
+54
to
+55
| * @param {import('svelte/compiler').AST.RegularElement} node | ||
| * @param {AST.Text | AST.ExpressionTag} src_attribute |
| return; | ||
| } else if (src_attribute.type === 'AttributeShorthand') { | ||
| const src_var_name = content.substring(src_attribute.start, src_attribute.end).trim(); | ||
| if (src_attribute.type === 'ExpressionTag') { |
| return `"${src}"`; | ||
| } | ||
|
|
||
| /** | ||
| * For images like `<img src={manually_imported} />` | ||
| * @param {string} content | ||
| * @param {import('svelte/types/compiler/interfaces').TemplateNode} node | ||
| * @param {import('svelte/compiler').AST.RegularElement} node |
| @@ -28,7 +29,11 @@ | |||
| alt="sizes test" | |||
| /> | |||
|
|
|||
| <enhanced:img src="./dev.png" on:click={(foo = 'clicked an image!')} alt="event handler test" /> | |||
| <enhanced:img | |||
There was a problem hiding this comment.
update the onclick to be correct and use v5 syntax.
Comment on lines
+50
to
+53
| {#each images as _, i} | ||
| <enhanced:img src={get_image(i)} alt="opt-in test" /> | ||
| {/each} | ||
|
|
There was a problem hiding this comment.
extra test to make sure we can handle things that aren't just identifiers.
| @@ -1,4 +1,4 @@ | |||
| <script context="module"> | |||
| <script module> | |||
| @@ -0,0 +1,34 @@ | |||
| import type { AST } from 'svelte/compiler'; | |||
There was a problem hiding this comment.
Just some helpful types for internal use.
Rich-Harris
reviewed
Oct 16, 2024
Rich-Harris
reviewed
Oct 16, 2024
Co-authored-by: Rich Harris <richard.a.harris@gmail.com>
6 tasks
benmccann
approved these changes
Nov 1, 2024
|
thank you!! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates
enhanced-imageto support svelte 5, with updated tests and types.It was a little more involved than I anticipated, mostly due to type issues altho there were some changes in the AST from what I can see when witching to
modernmode.This PR includes the following changes:
asyncWalkerfromestree-walkerdidn't like the new tpes so i switched tozimmerframe.zimmerframe'swalkis not asynchronous, so I had to modify the logic slightly to wait for the AST updates to be performed (as the updates are asynchronous).ExpressionTaginstead ofMustacheTag.on:clicktoonclickand corrected the syntax.I will comment the code directly to clarify these changes.
Closes #12686.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits