Remove data-astro-source-file
and data-astro-source-loc
attributes in dev mode
#13602
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.
Changes
data-astro-source-file
anddata-astro-source-loc
attributes on every element in dev mode.WeakMap
that is keyed by eachElement
, and then remove the attributes.Impact
This admittedly might break some third-party dev toolbar apps that rely on these annotations. Ideally we would expose a public API to get the annotation info for an element.
Searching all of GitHub for
data-astro-source-file
yields a decent number of repos, but the vast majority of uses are workarounds to remove the attributes.Testing
Tested manually because it involves dev mode-specific client-side script behavior, which would be flaky to run in CI.
Docs
As far as I can tell, this is an internal API that we've never documented!
These attributes were added in #9016 and first released in
astro@3.5.0
in November 2023. I assume users have gotten used to ignoring them, but they're still visual noise. Since this approach allows us to reduce noise without removing functionality, I think we should.