[Roadmap] Astro v1.0 #1

FredKSchott · 2021-11-23T19:21:35Z

FredKSchott
Nov 23, 2021
Maintainer

Summary

Astro v1.0 is our next goal, which means cleaning up and finalizing any APIs for a stable release. This document serves as a place to collect and organize all v1.0 proposals into a holistic view, so that the final API can be viewed in total. Larger tasks will be discussed and finalized in their own RFCs (linked to below).

v1.0 API Overview

✅ XSS Protection

Expand

Automatic Escaping 💪

<div foo="aaa">bbb</div>          ->  <div foo="aaa">bbb</div>
<div foo={'"aaa\" />'}>bbb</div>  ->  <div foo="&quot;aaa&quot; />">bbb</div>
<div>{'</div>'}</div>             ->  <div>&lt;/div&gt;</div>
<div>{'<script>alert("ohno")</script>'}</div>  ->  <div>&lt;script&gt;alert("ohno")&lt;/script&gt;</div>
{someHtml}          ->  &lt;script&gt;alert("ohno")&lt;/script&gt;
<SomeVariable />    ->  <somevariable></somevariable>
<{SomeVariable} />  ->  Syntax Error

Owner: @natemoo-re
Discussion: 💡 RFC: Deprecate and remove support for html inside of expressions astro#1828 (needs to be migrated to RFC or discussion in new repo)
RFC: TODO (everyone bought into the concept, mainly to flesh out implementation. could be prototyped first and then RFC just confirms prototype behavior before PR)
Implementation: TODO

Explicit Unescaped HTML Fallback 💪

<div set:html={unescapedHtml} />
<div set:text={someText} />

Owner: @natemoo-re
Discussion: 💡 RFC: Ability to set an element's innerHTML and textContent astro#1827 (needs to be migrated to RFC or discussion in new repo)
RFC: Link needed
Implementation: TODO

✅ SSR Required Changes

Expand

Enforce static of client directives 💪

Owner: @matthewp
Discussion: Enforce client directives to be added statically #30
RFC: Link needed
Implementation: Link needed, Behind flag

Remove Astro.resolve 💪

Owner: @matthewp
Discussion: Deprecate Astro.resolve #32
RFC: Link needed
Implementation: TODO

Move Hydration scripts back to being inline 💪💪

Owner: @matthewp
Discussion: Move hydration scripts back to being inline within the page #36
RFC: Not needed, implementation detail
Implementation: Link needed, Behind flag

Remove HTML post-processing 💪💪

improve build performance, align static site generation to match SSR requirements.
Owner: @matthewp
Discussion: Not needed, implementation detail
RFC: Not needed, implementation detail
Implementation: Link needed, Behind flag, needs polish

Where do assets like images live? `public/` or `src/`?

Needs reframing? This was tackled by other proposals for the SSR build problem, but we may need other improvements for things like icons, etc.

Owner: @FredKSchott
Discussion: TODO
RFC: Asset Primitive #106
Implementation: N/A

Resolve Style Loading

Owner: @matthewp
Discussion: [Early Feedback] External Style Import Unification #28
RFC: https://github.com/withastro/rfcs/blob/main/active-rfcs/0000-style-unification.md
Implementation: Done, behind experimental static build flag

Audit Build Performance for Large Sites 💪

Achieve linear performance in builds (tracked in "SSR Required Changes")
Owner: @matthewp
Benchmark: https://github.com/seancdavis/ssg-build-performance-tests

✅ Finalize `<head>`, `<body>`, and `<html>` Behavior 💪

Expand

Owner: @natemoo-re
RFC: Finalize <head>, <body>, <html> #26
Implementation: TODO

✅ Finalize Component Style and Script API 💪💪

Expand

Owner: @natemoo-re
RFC: finalize v1.0 component script and style behavior #41
RFC: Style/Script Defaults #150
Implementation: Implement new default script behavior, style is:global astro#2961

✅ Config Naming Audit 💪

Expand

Clean up confusing config, make sure all options are consistent and self-evident.
Owner: @natemoo-re
Discussion: Discord
RFC: Config Finalization #154
Implementation: Migrate to new config astro#2962

✅ Finalize Default Renderer/Framework Behavior 💪💪

Expand

To revisit and finalize two things: should every framework renderer come installed with Astro, and should every renderer be enabled by default?

Owner: @FredKSchott
RFC: Integration System #138
Implementation: Astro Integration System astro#2820

✅ Finalize Default Sass/PostCSS/Tailwind Behavior 💪💪

Expand

To revisit and finalize two things: should CSS addons come installed with Astro, and should every CSS addon be enabled by default?

Owner: @FredKSchott
RFC: Integration System #138
Implementation: Astro Integration System astro#2820

✅ Finalize `Astro.fetchContent()` API 💪

Expand

Rendering template as a part of fetchContent causes infinite loop. Implementation was mostly solved by v0.21 <Component /> export, but naming should be finalized. Remove old APIs and any properties that should no longer be used.

Owner: @FredKSchott
Discussion: Change fetchContent behaviour #5
RFC: New Markdown API #147
Implementation: New Markdown API astro#2862

✅ Finish `<Code>` prism->shiki migration

Expand

Owner: @bholmesdev
RFC: Accepted RFC
Implementation: Done

✅ `Astro.request` should be a real `Request`

Expand

Owner: @matthewp
RFC: Accepted RFC
Implementation: PR

v1.0.0 Beta => Stable

See [Roadmap] Astro v1.0.0 Beta => Stable

FredKSchott · 2021-12-03T23:48:39Z

FredKSchott Dec 3, 2021
Maintainer Author

Please add to the relevant discussion thread! Keeping this discussion focused on overall orchestration and not any one individual item.

jonathantneal · 2021-11-30T18:41:22Z

jonathantneal
Nov 30, 2021

Re: Astro.createComponent

Opinion: We already have a way to create Astro components; .astro files.

I think there are 2 reasons one would reach for Astro.createComponent.

Creating components in frontmatter. Alternative: Allow AstroHTML in Frontmatter again.
Astro superpowers. Scoping. Hoisting. Etc. Alternative: Allow these features from other built-in utilities.

2 replies

FredKSchott Dec 3, 2021
Maintainer Author

We should chat about this one, I'd really like to ship v1.0 without it if we can and I can't help but think that Svelte and Vue seem to get by just fine without this feature. But I'd also love to hear more if I'm missing some valuable use-case.

jonathantneal Dec 4, 2021

Sure thing. We probably agree, as I don’t think we need this feature. I felt enough community members missed it that it warranted a note.

The bit of my 'opinion' was that we already have a way to do this. The 'I think' bit was my interpretation of community feedback, and the 'alternative' bits were my suggestions to address that feedback.

My bias is that I don’t miss it. However, if AstroHTML in Frontmatter became a technical reality again, I’d support it. 🤷

jonathantneal · 2021-12-04T00:29:36Z

jonathantneal
Dec 4, 2021

Re: Explicit Unescaped HTML Fallback

(needs to be migrated to RFC or discussion in new repo)

It needs to be a new discussion. The related RFCs were not accepted.

Disclaimer: I will now reference the duplicate notes from the related RFCs and my own flawed memory.

Nearly Settled: Escaping by default

We came around on the need to escape strings and variables within expressions as the default. I believe this will pass easily now.

Not Settled: Escaping interface

We did not agree on the escape hatch API. I believe the suggested API methods for escape were an attribute, a utility, and an element.

Not Settled: Escaping effect

We did not agree on how escapes would be handled. I believe (at least?) one of us expected sanitization was the escape, (at least?) two of us expected the API to support sanitization, and (at least?) one of us did not want any kind of sanitization at all.

Nearly Settled: Naming

There was consensus to avoid DOM property terminology in the API (i.e. textContent, innerHTML).

1 reply

FredKSchott Dec 4, 2021
Maintainer Author

It needs to be a new discussion. The related RFCs were not accepted.

Ah no, I meant "migrated to RFC" as in a new, open RFC Pull Request. If @natemoo-re is able to migrate his old RFC to the new RFC format, then great. Otherwise, copying over as-is as a Discussion would be a fine short-term move just to keep the discussion going.

Siilwyn · 2022-02-11T13:15:14Z

Siilwyn
Feb 11, 2022

What about HTML minification? Specifically stripping whitespace.

0 replies

jonathantneal · 2022-02-11T18:17:20Z

jonathantneal
Feb 11, 2022

I believe we are switching out <slot> for an alternative API. Could we add that here?

0 replies

Igloczek · 2022-02-19T14:04:30Z

Igloczek
Feb 19, 2022

I'd love to see some clarification regarding the styles optimizations:

How to handle inlining? Usage of set:html might be an option, but at least for now, it doesn't work in all cases, for example ignore styles coming from Vue components.
How to handle async CSS?
How to merge stylesheets together?
How to have some control over the place where the styles <link> tags will be injected?

So basically all things required to use critical CSS with Astro, without some custom solutions running post-build.

0 replies

This comment has been hidden.

Sign in to view

This comment has been hidden.

Sign in to view

This comment has been hidden.

Sign in to view

This comment was marked as off-topic.

Sign in to view

[Roadmap] Astro v1.0 #1

FredKSchott Nov 23, 2021 Maintainer

Summary

v1.0 API Overview

✅ XSS Protection

Automatic Escaping 💪

Explicit Unescaped HTML Fallback 💪

✅ SSR Required Changes

Enforce static of client directives 💪

Remove Astro.resolve 💪

Move Hydration scripts back to being inline 💪💪

Remove HTML post-processing 💪💪

Where do assets like images live? public/ or src/?

Resolve Style Loading

Audit Build Performance for Large Sites 💪

✅ Finalize <head>, <body>, and <html> Behavior 💪

✅ Finalize Component Style and Script API 💪💪

✅ Config Naming Audit 💪

✅ Finalize Default Renderer/Framework Behavior 💪💪

✅ Finalize Default Sass/PostCSS/Tailwind Behavior 💪💪

✅ Finalize Astro.fetchContent() API 💪

✅ Finish <Code> prism->shiki migration

✅ Astro.request should be a real Request

v1.0.0 Beta => Stable

Replies: 8 comments · 5 replies

This comment has been hidden.

This comment has been hidden.

This comment was marked as off-topic.

FredKSchott Dec 3, 2021 Maintainer Author

This comment was marked as off-topic.

jonathantneal Nov 30, 2021

FredKSchott Dec 3, 2021 Maintainer Author

jonathantneal Dec 4, 2021

jonathantneal Dec 4, 2021

FredKSchott Dec 4, 2021 Maintainer Author

Siilwyn Feb 11, 2022

jonathantneal Feb 11, 2022

Igloczek Feb 19, 2022

FredKSchott
Nov 23, 2021
Maintainer

Where do assets like images live? `public/` or `src/`?

✅ Finalize `<head>`, `<body>`, and `<html>` Behavior 💪

✅ Finalize `Astro.fetchContent()` API 💪

✅ Finish `<Code>` prism->shiki migration

✅ `Astro.request` should be a real `Request`

Replies: 8 comments 5 replies

FredKSchott Dec 3, 2021
Maintainer Author

jonathantneal
Nov 30, 2021

FredKSchott Dec 3, 2021
Maintainer Author

jonathantneal
Dec 4, 2021

FredKSchott Dec 4, 2021
Maintainer Author

Siilwyn
Feb 11, 2022

jonathantneal
Feb 11, 2022

Igloczek
Feb 19, 2022