[ci] yarn format

This commit is contained in:
natemoo-re 2021-07-07 20:10:09 +00:00 committed by GitHub Actions
parent 53fcae1a9a
commit 1bbe98ae54
52 changed files with 263 additions and 233 deletions

View file

@ -3,6 +3,7 @@ layout: ~/layouts/Main.astro
title: Island Architecture
draft: true
---
<!--
@aFuzzyBear: I have been spending most the day learning more about Island Architecture, wrote plenty of notes, listened to Fred K Schott's interview on Speakeasy(https://www.youtube.com/watch?v=mgkwZqVkrwo) and the interview with Jason Lengstrof (https://www.youtube.com/watch?v=z15YLsLMtu4)
Figured I might give writing this a wee go,
@ -29,7 +30,7 @@ In the summer of 2020, he managed to formulated his thoughts of how web architec
His seminal post outlines and discusses the general concept of 'islands' as an architectural design process that could be used in Web Development, allowing for better improvements in overall site performance, SEO, UX, and everywhere else. His given explanation describing this new paradigm, was extraordinarily succinct:
> "The general idea of an *“Islands”* architecture is deceptively simple: Render HTML pages on the server, and inject placeholders or slots around highly dynamic regions. These placeholders/slots contain the server-rendered HTML output from their corresponding widget. They denote regions that can then be "hydrated" on the client into small self-contained widgets, reusing their server-rendered initial HTML."-Jason Miller
> "The general idea of an _“Islands”_ architecture is deceptively simple: Render HTML pages on the server, and inject placeholders or slots around highly dynamic regions. These placeholders/slots contain the server-rendered HTML output from their corresponding widget. They denote regions that can then be "hydrated" on the client into small self-contained widgets, reusing their server-rendered initial HTML."-Jason Miller
To develop a better understanding of what Jason meant with his proposal, let's quickly explore the backdrop, before we explain 'Island Architecture' and how it is applied into Astro as our primary ethos.
@ -37,7 +38,7 @@ To develop a better understanding of what Jason meant with his proposal, let's q
Think of a simple webpage. On which are many different types of components that are shown on this page, components that are shared across the site, others contain fixed content, some are a bit more elaborate that may perhaps use different state's or need to fetch multiple data streams from external sources.
Such an site would would have very few actual 'moving' pieces, or *dynamic* elements. For the most part the content tends to be fixed, and static.
Such an site would would have very few actual 'moving' pieces, or _dynamic_ elements. For the most part the content tends to be fixed, and static.
In order to allow for dynamism and interactivity we are often left making overly complex solutions to deliver the slightest form of action on the application.
@ -47,13 +48,13 @@ Given the [catalogue of patterns](https://en.wikipedia.org/wiki/List_of_software
Web developers tend to gravitate towards tried and tested practices, and none fit the requirements better than the [Model-View-Controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) (**MVC**) design pattern.
Where the **Model** contains the data structures and logic that governs the use of the data in the application. **Views** are the visual representation of the data that the user sees, and the **Controller** connects the views to their relevant data *Models* based on their interactions with the User.
Where the **Model** contains the data structures and logic that governs the use of the data in the application. **Views** are the visual representation of the data that the user sees, and the **Controller** connects the views to their relevant data _Models_ based on their interactions with the User.
This design pattern works well for our [client-server](https://en.wikipedia.org/wiki/Client%E2%80%93server_model) based applications. Since the models are placed on the *servers*, the views that are sent back over the wire tend to be static *documents*, controllers are sent along with the static files to facilitate the behaviours that web developers created for their application, in the form of *scripts*.
This design pattern works well for our [client-server](https://en.wikipedia.org/wiki/Client%E2%80%93server_model) based applications. Since the models are placed on the _servers_, the views that are sent back over the wire tend to be static _documents_, controllers are sent along with the static files to facilitate the behaviours that web developers created for their application, in the form of _scripts_.
## Rise of the Frameworks
A vast swathe of libraries, frameworks and tooling rose up to meet the challenges of providing a Developer Experience (DX) that would let them create their applications, *'freely'*.
A vast swathe of libraries, frameworks and tooling rose up to meet the challenges of providing a Developer Experience (DX) that would let them create their applications, _'freely'_.
Helping to abstract away much of the complexity needed in implementing architectural design decisions into their application.
@ -137,7 +138,7 @@ Into this new age ESM world, we have had a dearth of innovation from the establi
Basic questions of : Websites or WebApp's were still unresolved. Where to render the site, on the server or on the client, perhaps a bit of both? What determines the need for dynamic content and what specifies content to be static?
Witnessing frameworks slowly go full circle and return to Server-Side-Rendering (*SSR*) their applications was in part only allowed to be considered in an ESM world, however it was bit of an admission of culpability of sorts.
Witnessing frameworks slowly go full circle and return to Server-Side-Rendering (_SSR_) their applications was in part only allowed to be considered in an ESM world, however it was bit of an admission of culpability of sorts.
By inadvertently admitting that the current model is flawed, opened up the space for a new form of discourse to enter, and help redefine the ecosystem moving forward.
@ -155,15 +156,15 @@ In the introduction we placed a quote from Jason, describing the general concept
Jason asks us to think of a Island architecture as a static HTML document. One that is rendered entirely on the server.
The document contains multiple separate embedded applications, that are injected into placeholders or '*slots*', which form dynamic regions on the page.
The document contains multiple separate embedded applications, that are injected into placeholders or '_slots_', which form dynamic regions on the page.
The Server renders HTML outputs form each of these dynamic components, and places them onto the static document being sent back down to the End-User.
These slots, of dynamic regions, can then be '*hydrated*'. [Hydration](https://en.wikipedia.org/wiki/Hydration_(web_development)) is a process that allows for Client-Sided JS to convert and make static HTML, dynamic, reusing their initial server-rendered HTML.
These slots, of dynamic regions, can then be '_hydrated_'. [Hydration](<https://en.wikipedia.org/wiki/Hydration_(web_development)>) is a process that allows for Client-Sided JS to convert and make static HTML, dynamic, reusing their initial server-rendered HTML.
This 'micro' architecture is similar to both 'micro-frontends' and 'micro-services'. Both share the concept of breaking applications into small indivisible units. But the problem is that a lot of the small modular units are rarely composed in HTML.
With Island-Architecture, he proposes a form of progressive enhancement for the dynamic components by using a technique known as *Partial Hydration*.
With Island-Architecture, he proposes a form of progressive enhancement for the dynamic components by using a technique known as _Partial Hydration_.
Lets look at this following analogy:
@ -181,7 +182,7 @@ This would then load the functionality for the carousel in-place, transforming i
## Island Hydration
By now the idea of Island-architecture must be settling in, and one must be thinking, this is just [Progressive Hydration](https://en.wikipedia.org/wiki/Hydration_(web_development)#Progressive_rehydration), and you wouldn't be overly off mark.
By now the idea of Island-architecture must be settling in, and one must be thinking, this is just [Progressive Hydration](<https://en.wikipedia.org/wiki/Hydration_(web_development)#Progressive_rehydration>), and you wouldn't be overly off mark.
Progressive Hydration that is used in frameworks like: Angluar, React, Preact, Vue. Are individual components, which are loaded and then initialised over a period of time.
@ -197,7 +198,7 @@ Since there is no outer `<div id='root'>` element that needs to be initialised b
Every region of the page is an isolated unit, an island, on its own, connected to others by the HTML page. With such an approach the benefits do begin to stack up.
A key benefit is seen with the site performance. Since isolation is inherent, if a single issue affects a component, it wouldn't affect the other *islands* on the page.
A key benefit is seen with the site performance. Since isolation is inherent, if a single issue affects a component, it wouldn't affect the other _islands_ on the page.
## Exploring the Island

View file

@ -3,8 +3,6 @@ layout: ~/layouts/Main.astro
title: Astro Components
---
## ✨ `.astro` Syntax
Astro comes with its own server-side, component-based templating language. Think of it as HTML enhanced with the full power of JavaScript.
@ -204,5 +202,3 @@ If youd prefer to organize assets alongside Astro components, you may import
### TODO: Composition (Slots)
[code-ext]: https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode

View file

@ -37,6 +37,7 @@ console.log(data);
<!-- Output the result to the page -->
<div>{JSON.stringify(data)}</div>
```
### `fetch()`
Astro pages have access to the global `fetch()` function in their setup script. `fetch()` is a native JavaScript API ([MDN](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch)) that lets you make HTTP requests for things like APIs and resources.
@ -67,6 +68,3 @@ All Astro components are responsible for returning HTML. Astro Pages return HTML
</body>
</html>
```

View file

@ -22,6 +22,7 @@ However, there are plenty of cases where you might like to include an interactiv
- A "Buy Now" button
With Astro, you can hydrate these components individually, without forcing the rest of the page to ship any other unnecesary JavaScript. This technique is called **partial hydration.**
## Hydrate Frontend Components
To hydrate your components in the client, you may use any of the following techniques:

View file

@ -54,12 +54,10 @@ import BaseLayout from '../layouts/BaseLayout.astro'
</BaseLayout>
```
## Nesting Layouts
You can nest layouts when you want to create more specific page types without copy-pasting. It is common in Astro to have one generic `BaseLayout` and then many more specific layouts (`PostLayout`, `ProductLayout`, etc.) that reuse and build on top of it.
```astro
---
// src/layouts/PostLayout.astro
@ -121,13 +119,14 @@ The one downside to this approach is that you'll need to define the `<html>`, `<
Layouts are essential for Markdown files. Markdown files can declare a layout in the file frontmatter. Each Markdown file will be rendered to HTML and then injected into the layout's `<slot />` location.
````markdown
```markdown
---
title: Blog Post
layout: ../layouts/PostLayout.astro
---
This blog post will be **rendered** inside of the `<PostLayout />` layout.
````
```
Markdown pages always pass a `content` prop to their layout, which is useful to grab information about the page, title, metadata, table of contents headers, and more.

View file

@ -10,6 +10,7 @@ Astro includes an opinionated folder layout for your project. Every Astro projec
- `package.json` - A project manifest.
The easiest way to set up your new project is with `npm init astro`. Check out our [Installation Guide](/docs/quick-start.md) for a walkthrough of how to set up your project automatically (with `npm init astro`) or manually.
## Project Structure
```

View file

@ -8,6 +8,7 @@ Astro support `fetch()` and "top-level await" to help you do remote data fetchin
**Important:** These are not yet available inside of non-page Astro components. Instead, do all of your data loading inside of your pages, and then pass them to your components as props.
## Example
```astro
// Example: src/pages/foo.astro
// top-level `fetch()` and `await` are both supported natively in Astro (pages only).

View file

@ -20,8 +20,6 @@ The following guides are based on some shared assumptions:
}
```
## Building The App
You may run `npm run build` command to build the app.
@ -64,6 +62,7 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
cd -
```
> You can also run the above script in your CI setup to enable automatic deployment on each push.
### GitHub Actions

View file

@ -4,6 +4,7 @@ title: Markdown Content
---
Astro comes with out-of-the-box Markdown support powered by the expansive [remark](https://remark.js.org/) ecosystem.
## Remark and Rehype Plugins
In addition to [custom components inside the `<Markdown>` component](#markdown-component), Astro comes with [GitHub-flavored Markdown](https://github.github.com/gfm/) support, [Footnotes](https://github.com/remarkjs/remark-footnotes) syntax, [Smartypants](https://github.com/silvenon/remark-smartypants), and syntax highlighting via [Prism](https://prismjs.com/) pre-enabled.
@ -42,10 +43,7 @@ You can provide names of the plugins as well as import them:
// astro.config.js
export default {
markdownOptions: {
remarkPlugins: [
import('remark-slug'),
[import('remark-autolink-headings'), { behavior: 'prepend' }],
],
remarkPlugins: [import('remark-slug'), [import('remark-autolink-headings'), { behavior: 'prepend' }]],
},
};
```

View file

@ -17,7 +17,7 @@ With Astro, you can use your favorite JavaScript framework and automatically shi
## 🔧 Quick Start
> __Important__: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is __14.16.1__.
> **Important**: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is **14.16.1**.
```bash
# create your project

View file

@ -90,4 +90,3 @@ Success! You're now ready to start developing! Jump over to our [Quickstart Guid
📚 Learn more about Astro's project structure in our [Project Structure guide](/docs/core-concepts/project-structure.md).
📚 Learn more about Astro's component syntax in our [Astro Components guide](/docs/core-concepts/astro-components.md).
📚 Learn more about Astro's file-based routing in our [Routing guide](core-concepts/astro-pages).

View file

@ -25,8 +25,6 @@ npm run build
To deploy your Astro site to production, upload the contents of the `/dist` folder (generated by running `npm run build`) to your favorite hosting provider.
## Start your project
Go back to your command-line terminal, and run the following command in your project directory:
@ -39,7 +37,6 @@ Your application is now running on [http://localhost:3000](http://localhost:3000
Astro will listen for file changes in your `src/` directory, so you do not need to restart the application as you make changes during development.
## Build your project
Go back to your command-line terminal, and run the following command in your project directory:

View file

@ -65,6 +65,7 @@ const data = Astro.fetchContent('../pages/post/*.md'); // returns an array of po
`Astro.site` returns a `URL` made from `buildOptions.site` in your Astro config. If undefined, this will return a URL generated from `localhost`.
## Collections API
### `collection` prop
```jsx
@ -179,4 +180,3 @@ export default function () {
[config]: ../README.md#%EF%B8%8F-configuration
[docs-collections]: ./collections.md
[rss]: #-rss-feed

View file

@ -17,8 +17,8 @@ import { Markdown } from 'astro/components';
```
See our [Markdown Guide](/docs/guides/markdown-content.md) for more info.
<!-- TODO: We should move some of the specific component info here. -->
<!-- TODO: We should move some of the specific component info here. -->
## `<Prism />`

View file

@ -21,7 +21,6 @@ Specifies should port to run on. Defaults to `3000`.
Builds your site for production.
## Global Flags
### `--config path`

View file

@ -108,7 +108,7 @@ export interface Ast {
// instance: Script;
meta: {
features: number;
}
};
}
export interface Warning {

View file

@ -29,7 +29,7 @@ export class Parser {
js: Script[] = [];
meta_tags = {};
last_auto_closed_tag?: LastAutoClosedTag;
feature_flags: 0
feature_flags: 0;
constructor(template: string, options: ParserOptions) {
if (typeof template !== 'string') {
@ -268,7 +268,7 @@ export default function parse(template: string, options: ParserOptions = {}): As
// instance: instance_scripts[0],
module: astro_scripts[0],
meta: {
features: parser.feature_flags
}
features: parser.feature_flags,
},
};
}

View file

@ -56,7 +56,6 @@ function parent_is_head(stack) {
return false;
}
export default function tag(parser: Parser) {
const start = parser.index++;

View file

@ -1,2 +1 @@
export const FEATURE_CUSTOM_ELEMENT = 1 << 0;

View file

@ -1,5 +1,5 @@
import type { ImportSpecifier, ImportDefaultSpecifier, ImportNamespaceSpecifier } from '@babel/types';
import type { AstroMarkdownOptions } from '@astrojs/markdown-support'
import type { AstroMarkdownOptions } from '@astrojs/markdown-support';
export interface AstroConfigRaw {
dist: string;
@ -10,7 +10,7 @@ export interface AstroConfigRaw {
jsx?: string;
}
export { AstroMarkdownOptions }
export { AstroMarkdownOptions };
export interface AstroConfig {
dist: string;
projectRoot: URL;

View file

@ -166,9 +166,11 @@ function getComponentWrapper(_name: string, { url, importSpecifier }: ComponentI
if (isCustomElementTag(name)) {
return {
wrapper: `__astro_component(...__astro_element_registry.astroComponentArgs("${name}", ${JSON.stringify({ hydrate: kind, displayName: _name })}))`,
wrapperImports: [`import {AstroElementRegistry} from 'astro/dist/internal/element-registry.js';`,`import {__astro_component} from 'astro/dist/internal/__astro_component.js';`],
wrapperImports: [
`import {AstroElementRegistry} from 'astro/dist/internal/element-registry.js';`,
`import {__astro_component} from 'astro/dist/internal/__astro_component.js';`,
],
};
} else {
const getComponentExport = () => {
switch (importSpecifier.type) {
@ -187,10 +189,12 @@ function getComponentWrapper(_name: string, { url, importSpecifier }: ComponentI
}
};
const importInfo = kind ? {
const importInfo = kind
? {
componentUrl: getComponentUrl(astroConfig, url, pathToFileURL(filename)),
componentExport: getComponentExport()
} : {};
componentExport: getComponentExport(),
}
: {};
return {
wrapper: `__astro_component(${name}, ${JSON.stringify({ hydrate: kind, displayName: _name, ...importInfo })})`,
@ -657,7 +661,7 @@ async function compileHtml(enterNode: TemplateNode, state: CodegenState, compile
if (componentName === 'Markdown') {
const { $scope } = attributes ?? {};
state.markers.insideMarkdown = typeof state.markers.insideMarkdown === 'object' ? { $scope, count: state.markers.insideMarkdown.count + 1 } : { $scope, count: 1 };
const keys = Object.keys(attributes).filter(attr => attr !== '$scope');
const keys = Object.keys(attributes).filter((attr) => attr !== '$scope');
if (keys.length > 0) {
if (curr === 'markdown') {
await pushMarkdownToBuffer();
@ -765,7 +769,7 @@ async function compileHtml(enterNode: TemplateNode, state: CodegenState, compile
if ((state.markers.insideMarkdown as Record<string, any>).count <= 0) {
state.markers.insideMarkdown = false;
}
const hasAttrs = (node.attributes.filter(({ name }: Attribute) => name !== '$scope')).length > 0;
const hasAttrs = node.attributes.filter(({ name }: Attribute) => name !== '$scope').length > 0;
if (hasAttrs) {
return;
}
@ -820,7 +824,7 @@ export async function codegen(ast: Ast, { compileOptions, filename, fileID }: Co
},
importStatements: new Set(),
exportStatements: new Set(),
customElementCandidates: new Map()
customElementCandidates: new Map(),
};
const { script, createCollection } = compileModule(ast, ast.module, state, compileOptions);
@ -837,6 +841,6 @@ export async function codegen(ast: Ast, { compileOptions, filename, fileID }: Co
css: state.css.length ? state.css.join('\n\n') : undefined,
createCollection,
hasCustomElements: Boolean(ast.meta.features & FEATURE_CUSTOM_ELEMENT),
customElementCandidates: state.customElementCandidates
customElementCandidates: state.customElementCandidates,
};
}

View file

@ -116,11 +116,17 @@ import fetch from 'node-fetch';
// <script astro></script>
${result.imports.join('\n')}
${result.hasCustomElements ? `
${
result.hasCustomElements
? `
const __astro_element_registry = new AstroElementRegistry({
candidates: new Map([${Array.from(result.customElementCandidates).map(([identifier, url]) => `[${identifier}, '${url}']`).join(', ')}])
candidates: new Map([${Array.from(result.customElementCandidates)
.map(([identifier, url]) => `[${identifier}, '${url}']`)
.join(', ')}])
});
`.trim() : ''}
`.trim()
: ''
}
// \`__render()\`: Render the contents of the Astro module.
import { h, Fragment } from 'astro/dist/internal/h.js';

View file

@ -80,7 +80,7 @@ export class ConfigManager {
const r = await import(entrypoint);
return {
raw: r.default,
options: _options
options: _options,
};
})
)
@ -106,8 +106,8 @@ export class ConfigManager {
throw new Error(`Expected the snowpackPlugin from ${name} to be a "string" but encountered "${typeof snowpackPluginName}"!`);
}
const polyfillsNormalized = (raw.polyfills || []).map((p: string) => p.startsWith('.') ? path.join(name, p) : p);
const hydrationPolyfillsNormalized = (raw.hydrationPolyfills || []).map((p: string) => p.startsWith('.') ? path.join(name, p) : p);
const polyfillsNormalized = (raw.polyfills || []).map((p: string) => (p.startsWith('.') ? path.join(name, p) : p));
const hydrationPolyfillsNormalized = (raw.hydrationPolyfills || []).map((p: string) => (p.startsWith('.') ? path.join(name, p) : p));
return {
name,
@ -118,7 +118,7 @@ export class ConfigManager {
knownEntrypoints: raw.knownEntrypoints,
external: raw.external,
polyfills: polyfillsNormalized,
hydrationPolyfills: hydrationPolyfillsNormalized
hydrationPolyfills: hydrationPolyfillsNormalized,
};
});
@ -129,20 +129,24 @@ export class ConfigManager {
const renderers = await this.buildRendererInstances();
const rendererServerPackages = renderers.map(({ server }) => server);
const rendererClientPackages = await Promise.all(renderers.filter(({ client }) => client).map(({ client }) => this.resolvePackageUrl(client!)));
const rendererPolyfills = await Promise.all(renderers.map(({ polyfills }) => Promise.all(polyfills.map(src => this.resolvePackageUrl(src)))));
const rendererHydrationPolyfills = await Promise.all(renderers.map(({ hydrationPolyfills }) => Promise.all(hydrationPolyfills.map(src => this.resolvePackageUrl(src)))));
const rendererPolyfills = await Promise.all(renderers.map(({ polyfills }) => Promise.all(polyfills.map((src) => this.resolvePackageUrl(src)))));
const rendererHydrationPolyfills = await Promise.all(renderers.map(({ hydrationPolyfills }) => Promise.all(hydrationPolyfills.map((src) => this.resolvePackageUrl(src)))));
const result = /* js */ `${rendererServerPackages.map((pkg, i) => `import __renderer_${i} from "${pkg}";`).join('\n')}
import { setRenderers } from 'astro/dist/internal/__astro_component.js';
let rendererInstances = [${renderers.map((r, i) => `{
let rendererInstances = [${renderers
.map(
(r, i) => `{
source: ${rendererClientPackages[i] ? `"${rendererClientPackages[i]}"` : 'null'},
renderer: __renderer_${i},
options: ${r.options ? JSON.stringify(r.options) : 'null'},
polyfills: ${JSON.stringify(rendererPolyfills[i])},
hydrationPolyfills: ${JSON.stringify(rendererHydrationPolyfills[i])}
}`).join(', ')}];
}`
)
.join(', ')}];
${contents}
`;

View file

@ -22,7 +22,7 @@ const astroRendererInstance: RendererInstance = {
renderer: astro as Renderer,
options: null,
polyfills: [],
hydrationPolyfills: []
hydrationPolyfills: [],
};
const astroHtmlRendererInstance: RendererInstance = {
@ -30,7 +30,7 @@ const astroHtmlRendererInstance: RendererInstance = {
renderer: astroHtml as Renderer,
options: null,
polyfills: [],
hydrationPolyfills: []
hydrationPolyfills: [],
};
let rendererInstances: RendererInstance[] = [];
@ -95,13 +95,15 @@ async function generateHydrateScript({ instance, astroId, props }: HydrateScript
let hydrationSource = '';
if (instance.hydrationPolyfills.length) {
hydrationSource += `await Promise.all([${instance.hydrationPolyfills.map(src => `import("${src}")`).join(', ')}]);\n`;
hydrationSource += `await Promise.all([${instance.hydrationPolyfills.map((src) => `import("${src}")`).join(', ')}]);\n`;
}
hydrationSource += source ? `
hydrationSource += source
? `
const [{ ${componentExport.value}: Component }, { default: hydrate }] = await Promise.all([import("${componentUrl}"), import("${source}")]);
return (el, children) => hydrate(el)(Component, ${serialize(props)}, children);
` : `
`
: `
await import("${componentUrl}");
return () => {};
`;
@ -157,7 +159,7 @@ export const __astro_component = (Component: any, componentProps: AstroComponent
let { html } = await instance.renderer.renderToStaticMarkup(Component, props, children, instance.options);
if (instance.polyfills.length) {
let polyfillScripts = instance.polyfills.map(src => `<script type="module" src="${src}"></script>`).join('');
let polyfillScripts = instance.polyfills.map((src) => `<script type="module" src="${src}"></script>`).join('');
html = html + polyfillScripts;
}

View file

@ -39,7 +39,7 @@ class AstroElementRegistry {
const specifier = this.findCached(tagName);
const outProps: AstroComponentProps = {
...props,
componentUrl: specifier || props.componentUrl
componentUrl: specifier || props.componentUrl,
};
return [tagName, outProps];
}

View file

@ -3,10 +3,8 @@ import { h } from './h';
async function renderToStaticMarkup(tag: string, props: Record<string, any>, children: string) {
const html = await h(tag, props, Promise.resolve(children));
return {
html
html,
};
}
export {
renderToStaticMarkup
};
export { renderToStaticMarkup };

View file

@ -418,7 +418,7 @@ async function createSnowpack(astroConfig: AstroConfig, options: CreateSnowpackO
packageOptions: {
knownEntrypoints,
external,
}
},
});
const polyfillNode = (snowpackConfig.packageOptions as any).polyfillNode as boolean;

View file

@ -24,6 +24,6 @@ MarkdownPlugin('Can render Astro <Markdown> with plugins', async ({ runtime }) =
const $ = doc(result.contents);
assert.equal($('.toc').length, 1, 'Added a TOC');
assert.ok($('#hello-world').hasClass('title'), 'Added .title to h1');
})
});
MarkdownPlugin.run();

View file

@ -138,7 +138,9 @@ StylesSSR('Astro scoped styles can be passed to child components', async ({ runt
const $ = doc(result.contents);
let scopedClass;
$('style').html().replace(/outer\.(astro-[A-Za-z0-9-]+)/, (match, p1) => {
$('style')
.html()
.replace(/outer\.(astro-[A-Za-z0-9-]+)/, (match, p1) => {
scopedClass = p1;
return match;
});

View file

@ -36,10 +36,14 @@ export function setup(Suite, fixturePath, { runtimeOptions = {} } = {}) {
runtime = await createRuntime(astroConfig, {
logging: { level: 'error', dest: process.stderr },
...runtimeOptions,
}).catch(err => { createRuntimeError = err; });
}).catch((err) => {
createRuntimeError = err;
});
if (createRuntimeError) {
setTimeout(() => { throw createRuntimeError });
setTimeout(() => {
throw createRuntimeError;
});
}
context.runtime = runtime;

View file

@ -37,7 +37,7 @@ PreactComponent('Can export a Fragment', async ({ runtime }) => {
if (result.error) throw new Error(result.error);
const $ = doc(result.contents);
assert.equal($('body').children().length, 0, 'nothing rendered but it didn\'t throw.');
assert.equal($('body').children().length, 0, "nothing rendered but it didn't throw.");
});
PreactComponent.run();

View file

@ -1,5 +1,6 @@
export const createConfig = ({ renderers }: { renderers: string[] }) => {
return [`export default {
return [
`export default {
// projectRoot: '.', // Where to resolve all URLs relative to. Useful if you have a monorepo project.
// pages: './src/pages', // Path to Astro components, pages, and data
// dist: './dist', // When running \`astro build\`, path to final static output
@ -12,8 +13,11 @@ export const createConfig = ({ renderers }: { renderers: string[] }) => {
// port: 3000, // The port to run the dev server on.
// tailwindConfig: '', // Path to tailwind.config.js if used, e.g. './tailwind.config.js'
},`,
` renderers: ${JSON.stringify(renderers, undefined, 2).split('\n').map((ln, i) => i !== 0 ? ` ${ln}` : ln).join('\n')},`,
` renderers: ${JSON.stringify(renderers, undefined, 2)
.split('\n')
.map((ln, i) => (i !== 0 ? ` ${ln}` : ln))
.join('\n')},`,
`};
`].join('\n')
}
`,
].join('\n');
};

View file

@ -17,7 +17,7 @@ export default function PreactCounter({ children }) {
</div>
);
}
`
`,
},
'@astrojs/renderer-react': {
filename: `src/components/ReactCounter.jsx`,
@ -36,7 +36,7 @@ export default function ReactCounter({ children }) {
</div>
);
}
`
`,
},
'@astrojs/renderer-svelte': {
filename: `src/components/SvelteCounter.svelte`,
@ -57,7 +57,7 @@ export default function ReactCounter({ children }) {
<pre>{ count }</pre>
<button on:click={add}>+</button>
</div>
`
`,
},
'@astrojs/renderer-vue': {
filename: `src/components/VueCounter.vue`,
@ -85,8 +85,8 @@ export default {
}
}
</script>
`
}
`,
},
};
export const FRAMEWORKS = [
@ -105,5 +105,5 @@ export const FRAMEWORKS = [
{
title: 'Vue',
value: '@astrojs/renderer-vue',
}
},
];

View file

@ -66,9 +66,7 @@ export async function main() {
const hash = args.commit ? `#${args.commit}` : '';
const templateTarget = options.template.includes('/') ?
options.template :
`snowpackjs/astro/examples/${options.template}`;
const templateTarget = options.template.includes('/') ? options.template : `snowpackjs/astro/examples/${options.template}`;
const emitter = degit(`${templateTarget}${hash}`, {
cache: false,
@ -76,7 +74,7 @@ export async function main() {
verbose: false,
});
const selectedTemplate = TEMPLATES.find(template => template.value === options.template);
const selectedTemplate = TEMPLATES.find((template) => template.value === options.template);
let renderers: string[] = [];
if (selectedTemplate?.renderers === true) {
@ -91,7 +89,7 @@ export async function main() {
renderers = result.renderers;
} else if (selectedTemplate?.renderers && Array.isArray(selectedTemplate.renderers)) {
renderers = selectedTemplate.renderers;
const titles = renderers.map(renderer => FRAMEWORKS.find(item => item.value === renderer)?.title).join(', ');
const titles = renderers.map((renderer) => FRAMEWORKS.find((item) => item.value === renderer)?.title).join(', ');
console.log(green(``) + bold(` Using template's default renderers`) + gray(' ') + titles);
}
@ -107,7 +105,8 @@ export async function main() {
}
// Post-process in parallel
await Promise.all(POSTPROCESS_FILES.map(async (file) => {
await Promise.all(
POSTPROCESS_FILES.map(async (file) => {
const fileLoc = path.resolve(path.join(cwd, file));
switch (file) {
@ -128,26 +127,35 @@ export async function main() {
const packageJSON = JSON.parse(await fs.promises.readFile(fileLoc, 'utf8'));
delete packageJSON.snowpack; // delete snowpack config only needed in monorepo (can mess up projects)
// Fetch latest versions of selected renderers
const rendererEntries = await Promise.all(['astro', ...renderers].map((renderer: string) => fetch(`https://registry.npmjs.org/${renderer}/latest`).then((res: any) => res.json()).then((res: any) => [renderer, `^${res['version']}`]))) as any;
packageJSON.devDependencies = { ...packageJSON.devDependencies ?? {}, ...Object.fromEntries(rendererEntries) }
const rendererEntries = (await Promise.all(
['astro', ...renderers].map((renderer: string) =>
fetch(`https://registry.npmjs.org/${renderer}/latest`)
.then((res: any) => res.json())
.then((res: any) => [renderer, `^${res['version']}`])
)
)) as any;
packageJSON.devDependencies = { ...(packageJSON.devDependencies ?? {}), ...Object.fromEntries(rendererEntries) };
await fs.promises.writeFile(fileLoc, JSON.stringify(packageJSON, undefined, 2));
break;
}
}
}));
})
);
// Inject framework components into starter template
if (selectedTemplate?.value === 'starter') {
let importStatements: string[] = [];
let components: string[] = [];
await Promise.all(renderers.map(async renderer => {
await Promise.all(
renderers.map(async (renderer) => {
const component = COUNTER_COMPONENTS[renderer as keyof typeof COUNTER_COMPONENTS];
const componentName = path.basename(component.filename, path.extname(component.filename));
const absFileLoc = path.resolve(cwd, component.filename);
importStatements.push(`import ${componentName} from '${component.filename.replace(/^src/, '..')}';`);
components.push(`<${componentName}:visible />`);
await fs.promises.writeFile(absFileLoc, component.content);
}));
})
);
const pageFileLoc = path.resolve(path.join(cwd, 'src', 'pages', 'index.astro'));
const content = (await fs.promises.readFile(pageFileLoc)).toString();
@ -162,9 +170,19 @@ export async function main() {
- See https://github.com/snowpackjs/astro/blob/main/docs/core-concepts/component-hydration.md
-->
`;
lines.splice(41, 0, importStatements.length > 0 ? doc.split('\n').map(ln => `${indent}${ln}`).join('\n') : '', ...components.map(ln => `${indent}${ln}`));
lines.splice(
41,
0,
importStatements.length > 0
? doc
.split('\n')
.map((ln) => `${indent}${ln}`)
.join('\n')
: '',
...components.map((ln) => `${indent}${ln}`)
);
lines.splice(3, 0, importStatements.length > 0 ? `// Framework Component Imports` : '', ...importStatements);
await fs.promises.writeFile(pageFileLoc, lines.join('\n'))
await fs.promises.writeFile(pageFileLoc, lines.join('\n'));
}
console.log(bold(green('✔') + ' Done!'));

View file

@ -7,16 +7,16 @@ export const TEMPLATES = [
{
title: 'Blog',
value: 'blog',
renderers: ['@astrojs/renderer-preact']
renderers: ['@astrojs/renderer-preact'],
},
{
title: 'Documentation',
value: 'docs',
renderers: ['@astrojs/renderer-preact']
renderers: ['@astrojs/renderer-preact'],
},
{
title: 'Portfolio',
value: 'portfolio',
renderers: ['@astrojs/renderer-preact']
renderers: ['@astrojs/renderer-preact'],
},
];

View file

@ -10,9 +10,7 @@ async function run(outdir, template) {
});
}
const testCases = [
['shopify', 'cassidoo/shopify-react-astro']
];
const testCases = [['shopify', 'cassidoo/shopify-react-astro']];
async function tests() {
for (let [dir, tmpl] of testCases) {
@ -23,7 +21,7 @@ async function tests() {
}
}
tests().catch(err => {
tests().catch((err) => {
console.error(err);
process.exit(1);
});

View file

@ -6,8 +6,4 @@ const GITHUB_SHA = process.env.GITHUB_SHA || execa.sync('git', ['rev-parse', 'HE
const FIXTURES_DIR = path.join(fileURLToPath(path.dirname(import.meta.url)), 'fixtures');
const FIXTURES_URL = pathToFileURL(FIXTURES_DIR + '/');
export {
GITHUB_SHA,
FIXTURES_DIR,
FIXTURES_URL
};
export { GITHUB_SHA, FIXTURES_DIR, FIXTURES_URL };

View file

@ -28,7 +28,9 @@ export async function renderMarkdownWithFrontmatter(contents: string, opts?: Mar
export async function renderMarkdown(content: string, opts?: MarkdownRenderingOptions | null) {
const { $: { scopedClassName = null } = {}, footnotes: useFootnotes = true, gfm: useGfm = true, remarkPlugins = [], rehypePlugins = [] } = opts ?? {};
const { headers, rehypeCollectHeaders } = createCollectHeaders();
let parser = unified().use(markdown).use([remarkExpressions, { addResult: true }]);
let parser = unified()
.use(markdown)
.use([remarkExpressions, { addResult: true }]);
if (remarkPlugins.length === 0) {
if (useGfm) {
@ -61,7 +63,12 @@ export async function renderMarkdown(content: string, opts?: MarkdownRenderingOp
let result: string;
try {
const vfile = await parser.use(raw).use(rehypeCollectHeaders).use(rehypeCodeBlock()).use(rehypeStringify, { entities: { useNamedReferences: true }}).process(content);
const vfile = await parser
.use(raw)
.use(rehypeCollectHeaders)
.use(rehypeCodeBlock())
.use(rehypeStringify, { entities: { useNamedReferences: true } })
.process(content);
result = vfile.contents.toString();
} catch (err) {
throw err;

View file

@ -1,5 +1,5 @@
import unified from "unified";
import type { Plugin, UnifiedPluginImport } from "./types";
import unified from 'unified';
import type { Plugin, UnifiedPluginImport } from './types';
async function importPlugin(p: string | UnifiedPluginImport): UnifiedPluginImport {
if (typeof p === 'string') {

View file

@ -1,12 +1,12 @@
import { map } from 'unist-util-map'
import { map } from 'unist-util-map';
export default function rehypeExpressions(): any {
return function (node: any): any {
return map(node, (child) => {
if (child.type === 'mdxTextExpression') {
return { type: 'text', value: `{${child.value}}` }
return { type: 'text', value: `{${child.value}}` };
}
return child;
})
}
});
};
}

View file

@ -1,18 +1,18 @@
import {mdxExpression} from 'micromark-extension-mdx-expression'
import {mdxExpressionFromMarkdown, mdxExpressionToMarkdown} from 'mdast-util-mdx-expression'
import { mdxExpression } from 'micromark-extension-mdx-expression';
import { mdxExpressionFromMarkdown, mdxExpressionToMarkdown } from 'mdast-util-mdx-expression';
function remarkExpressions(this: any, options: any) {
let settings = options || {}
let data = this.data()
let settings = options || {};
let data = this.data();
add('micromarkExtensions', mdxExpression({}))
add('fromMarkdownExtensions', mdxExpressionFromMarkdown)
add('toMarkdownExtensions', mdxExpressionToMarkdown)
add('micromarkExtensions', mdxExpression({}));
add('fromMarkdownExtensions', mdxExpressionFromMarkdown);
add('toMarkdownExtensions', mdxExpressionToMarkdown);
function add(field: any, value: any) {
/* istanbul ignore if - other extensions. */
if (data[field]) data[field].push(value)
else data[field] = [value]
if (data[field]) data[field].push(value);
else data[field] = [value];
}
}