chore: update `esrap` #620

manuel3108 · 2025-06-28T09:04:50Z

Figure out how to handle adding new comments during ast processing.

changeset-bot · 2025-06-28T09:04:54Z

⚠️ No Changeset found

Latest commit: 3afb161

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

pkg-pr-new · 2025-06-28T09:05:15Z

Open in StackBlitz

npx https://pkg.pr.new/sveltejs/cli/sv@620

npx https://pkg.pr.new/sveltejs/cli/svelte-migrate@620

commit: 3afb161

svelte-docs-bot · 2025-10-26T05:56:37Z

Preview: https://svelte-dev-git-preview-cli-620-svelte.vercel.app/

manuel3108 · 2025-10-26T07:35:05Z

This is ready as soon as we merge sveltejs/esrap#79 and update the referenced package here away from pkg.pr.new

sacrosanctic · 2025-11-28T15:57:46Z

sveltejs/esrap#90 was merged in lieu of sveltejs/esrap#79 and released as [email protected]

But I'm guessing it's not a simple package change anymore.

Copilot

Pull request overview

This PR updates the esrap library from ^1.4.9 to ^2.2.0 and adapts the codebase to handle the breaking changes in how comments are managed during AST processing. The new version requires explicit comment state management instead of automatically attaching comments to AST nodes.

Key Changes:

Introduces CommentState and Comments classes to manage comment associations with AST nodes
Updates parseScript to return both ast and commentState instead of pre-attaching comments to nodes
Modifies serializeScript to accept commentState parameter for proper comment serialization
Removes guessQuoteStyle function as esrap 2.x handles quote styles internally

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Updates esrap dependency from 1.4.9 to 2.2.0 and adjusts snapshots
packages/core/package.json	Updates esrap version specification to ^2.2.0
packages/core/tooling/index.ts	Implements new comment handling system with CommentState and Comments classes; removes guessQuoteStyle; updates parseScript and serializeScript signatures
packages/core/tooling/parsers.ts	Updates parseScript wrapper to expose comments and handle new API
packages/core/tooling/js/index.ts	Exports Comments type for external use
packages/core/tooling/js/common.ts	Updates comment manipulation functions to use Comments class methods instead of direct node property manipulation
packages/core/tests/utils.ts	Updates test utilities to use new API; removes guessQuoteStyle tests
packages/core/tests/js/index.ts	Updates test runner to pass comments parameter to test run functions
packages/core/tests/js/common/jsdoc-type-comment/run.ts	Updates to use new Comments API
packages/core/tests/js/common/jsdoc-comment/run.ts	Updates to use new Comments API
packages/core/tests/js/object/create/run.ts	Removes direct leadingComments manipulation
packages/core/tests/js/vite/with-satisfies/output.ts	Test snapshot update reflecting formatting changes from esrap 2.x
packages/core/tests/js/vite/add-plugin-mode/output.ts	Test snapshot update reflecting formatting changes from esrap 2.x
packages/core/tests/js/object/property-node/output.ts	Test snapshot update reflecting formatting changes from esrap 2.x
packages/core/tests/js/object/override-property/output.ts	Test snapshot update reflecting formatting changes from esrap 2.x
packages/core/tests/js/object/ensure-nested-property/output.ts	Test snapshot update reflecting formatting changes from esrap 2.x
packages/core/tests/js/object/create/output.ts	Test snapshot update reflecting formatting and removed prettier-ignore comment
packages/core/tests/js/common/jsdoc-type-comment/output.ts	Test snapshot update showing comment formatting change
packages/addons/sveltekit-adapter/index.ts	Updates to use new Comments API; implements comment filtering by modifying original array
packages/addons/eslint/index.ts	Updates to use new Comments API with addLeading method

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/core/tooling/index.ts

packages/addons/sveltekit-adapter/index.ts

packages/core/tooling/index.ts

Co-authored-by: Copilot <[email protected]>

…chore/esrap-2

jycouet

I think I need to pull it locally to see a bit more :)
Will do in coming days.

Thx 🎉

packages/core/tooling/index.ts

packages/core/tests/js/vite/with-satisfies/output.ts

jycouet

LGTM.

I did a small test with the test snapshot branch to see a bit the diff for users...
39cfdf8

Quite small 👍
Some are better than before!
Some can be improve in esrap later

manuel3108 · 2025-12-02T19:53:59Z

Thanks! That's really an elegant change to the snapshots, expect maybe for packages/cli/tests/snapshots/create-with-all-addons/vite.config.ts. But that needs to be fixed inside esrap as you said.

jycouet

👍

manuel3108 · 2025-12-05T14:02:25Z

This got way bigger than I initially expected. Glad we got it done.

chore: update esrap

25d0bbf

This was referenced Sep 5, 2025

Feat - Community add-on #684

Open

feat: add additionalComments option for programmatic comment insertion sveltejs/esrap#79

Closed

manuel3108 added 3 commits September 7, 2025 10:21

Merge remote-tracking branch 'origin/main' into chore/esrap-2

c5aa975

use esrap pkg.pr.new

9394c80

fix svelte-kit adapter addon

79f262e

manuel3108 added 8 commits October 26, 2025 07:00

remove useless comment

7c0c0d2

fix eslint

f41da14

fix eslint

7307cc4

add changed tests

6df65fc

thats ok too

ae78455

Merge branch 'main' into chore/esrap-2

23d569d

those are ok as well

1982ac4

fix last failing test

62444cc

manuel3108 mentioned this pull request Oct 26, 2025

chore: use parse & print from svelte/compiler #751

Merged

3 tasks

manuel3108 added 2 commits November 26, 2025 20:36

Merge branch 'main' into chore/esrap-2

d871736

update esrap

0b55155

manuel3108 added 4 commits November 30, 2025 10:38

adapt to new api

54685d8

improvements

0e56b56

cleanup

a89a0e9

remove useless comment

4efbc25

manuel3108 requested a review from Copilot November 30, 2025 10:04

manuel3108 marked this pull request as ready for review November 30, 2025 10:04

Copilot started reviewing on behalf of manuel3108 November 30, 2025 10:04 View session

Copilot finished reviewing on behalf of manuel3108 November 30, 2025 10:08

Copilot AI reviewed Nov 30, 2025

View reviewed changes

packages/core/tooling/index.ts Outdated Show resolved Hide resolved

packages/addons/sveltekit-adapter/index.ts Show resolved Hide resolved

packages/core/tooling/index.ts Outdated Show resolved Hide resolved

manuel3108 and others added 2 commits November 30, 2025 11:10

Update packages/core/tooling/index.ts

15d3400

Co-authored-by: Copilot <[email protected]>

Merge branch 'chore/esrap-2' of https://github.com/sveltejs/cli into …

c3ca656

…chore/esrap-2

jycouet reviewed Nov 30, 2025

View reviewed changes

packages/core/tooling/index.ts Show resolved Hide resolved

packages/core/tooling/index.ts Outdated Show resolved Hide resolved

packages/core/tests/js/vite/with-satisfies/output.ts Show resolved Hide resolved

manuel3108 and others added 4 commits December 1, 2025 19:46

re-add quote style

7160300

using esrap 2.2.1

748cc4e

simplifying?

d7ff4b2

good enough?

9ef38e3

jycouet approved these changes Dec 1, 2025

View reviewed changes

jycouet added 5 commits December 2, 2025 23:16

simplify

2e6b85d

add & remove

8053314

api?

44d7a85

Merge branch 'main' of github.com:sveltejs/cli into chore/esrap-2

061e94b

manual snapshot review OK

3afb161

jycouet self-requested a review December 2, 2025 22:58

jycouet approved these changes Dec 2, 2025

View reviewed changes

manuel3108 merged commit 16166b1 into main Dec 5, 2025
8 checks passed

manuel3108 deleted the chore/esrap-2 branch December 5, 2025 14:02

Uh oh!

chore: update esrap #620

chore: update esrap #620

Uh oh!

Conversation

manuel3108 commented Jun 28, 2025

Uh oh!

changeset-bot bot commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

pkg-pr-new bot commented Jun 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

svelte-docs-bot bot commented Oct 26, 2025

Uh oh!

manuel3108 commented Oct 26, 2025

Uh oh!

sacrosanctic commented Nov 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jycouet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jycouet left a comment

Choose a reason for hiding this comment

Uh oh!

manuel3108 commented Dec 2, 2025

Uh oh!

jycouet left a comment

Choose a reason for hiding this comment

Uh oh!

manuel3108 commented Dec 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: update `esrap` #620

chore: update `esrap` #620

changeset-bot bot commented Jun 28, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 28, 2025 •

edited

Loading