Add experimental.directRenderScript option
#10102
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: 781afc5 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
bot
added
pkg: astro
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
lilnasy
reviewed
Feb 15, 2024
MoustaphaDev
approved these changes
Feb 16, 2024
|
We should update the PR, and replace the compiler dependency with the correct one |
|
!preview direct-render-script |
|
Snapshots have been released for the following packages:
Publish LogBuild Log |
ematipico
approved these changes
Feb 27, 2024
sarah11918
reviewed
Mar 3, 2024
There was a problem hiding this comment.
Thanks, @bluwy ! Took a pass at the changeset, mostly because I wanted to make sure it explicitly addressed removing the old option (whether or not they added the new one) since it's deleted from the docs (and, I'm assuming from the codebase? But could be wrong about that! Even if not, just as well to tell people the option is deleted and force them on to the new one! 😄 )
When we have the wording from the changeset finalized, I will take a look at the JSdoc again, just for consistency in case anything changes! 🙌
Co-authored-by: Sarah Rainsberger <[email protected]>
sarah11918
approved these changes
Mar 5, 2024
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.
Changes
Relies on withastro/compiler#969, The PR should be merged and released and updated here before merging.
Closes #7857 (Styles will be tackled separately)
This introduces
experimental.directRenderScriptand removesexperimental.optimizeHoistedScript. Both work differently but should achieve the same result. When directly rendering scripts, it will no longer be hoisted and will be rendered where it's declared. The compiled code will call${renderScript($$result, "/src/pages/...")}to render the script.This option is introduced due to the current caveats of our script handling. Today, it works by starting from each Astro pages, and crawling the module graph to find the imported Astro components's scripts, and include it to the Astro page. However, this is not ideal in many cases if Astro components are only used conditionally, or through barrel files, resulting in scripts added to a page when it shouldn't.
This new option prevents the caveat by only including the scripts when the components are actually rendered. That way it won't be possible for scripts to be included in a page that it shouldn't.
Testing
Lend the tests from the
experimental.optimizeHoistedScriptoption. I also tested enabling the option by default, and it seems to mostly work besides the known caveats,Docs
Added a changeset and jsdoc. Needs a review on this!