michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fragment support

Browse source
This commit is contained in:
Matthew Phillips 2023-10-05 10:54:40 -04:00
parent 4e5cafa5d2
commit a6f42fa4d7
10 changed files with 76 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/astro/src/@types/astro.ts
View file

@ -1520,6 +1520,7 @@ export type AsyncRendererComponentFn<U> = (
export interface ComponentInstance {
default: AstroComponentFactory;
css?: string[];
fragment?: boolean;
prerender?: boolean;
/**
* Only used for logging if deprecated drafts feature is used
@ -2191,6 +2192,7 @@ export interface SSRResult {
*/
clientDirectives: Map<string, string>;
compressHTML: boolean;
fragment: boolean;
/**
* Only used for logging
*/

1
packages/astro/src/core/render/core.ts
View file

@ -49,6 +49,7 @@ export async function renderPage({ mod, renderContext, env, cookies }: RenderPag
clientDirectives: env.clientDirectives,
compressHTML: env.compressHTML,
request: renderContext.request,
fragment: !!mod.fragment,
site: env.site,
scripts: renderContext.scripts,
ssr: env.ssr,

2
packages/astro/src/core/render/result.ts
View file

@ -31,6 +31,7 @@ export interface CreateResultArgs {
renderers: SSRLoadedRenderer[];
clientDirectives: Map<string, string>;
compressHTML: boolean;
fragment: boolean;
resolve: (s: string) => Promise<string>;
/**
* Used for `Astro.site`
@ -155,6 +156,7 @@ export function createResult(args: CreateResultArgs): SSRResult {
renderers: args.renderers,
clientDirectives: args.clientDirectives,
compressHTML: args.compressHTML,
fragment: args.fragment,
pathname: args.pathname,
cookies,
/** This function returns the `Astro` faux-global */

4
packages/astro/src/runtime/server/render/astro/render.ts
View file

@ -33,7 +33,7 @@ export async function renderToString(
// Automatic doctype insertion for pages
if (isPage && !renderedFirstPageChunk) {
renderedFirstPageChunk = true;
if (!/<!doctype html/i.test(String(chunk))) {
if (!result.fragment && !/<!doctype html/i.test(String(chunk))) {
const doctype = result.compressHTML ? '<!DOCTYPE html>' : '<!DOCTYPE html>\n';
str += doctype;
}
@ -84,7 +84,7 @@ export async function renderToReadableStream(
// Automatic doctype insertion for pages
if (isPage && !renderedFirstPageChunk) {
renderedFirstPageChunk = true;
if (!/<!doctype html/i.test(String(chunk))) {
if (!result.fragment && !/<!doctype html/i.test(String(chunk))) {
const doctype = result.compressHTML ? '<!DOCTYPE html>' : '<!DOCTYPE html>\n';
controller.enqueue(encoder.encode(doctype));
}

4
packages/astro/src/runtime/server/render/common.ts
View file

@ -77,13 +77,13 @@ function stringifyChunk(
}
}
case 'head': {
if (result._metadata.hasRenderedHead) {
if (result._metadata.hasRenderedHead || result.fragment) {
return '';
}
return renderAllHeadContent(result);
}
case 'maybe-head': {
if (result._metadata.hasRenderedHead || result._metadata.headInTree) {
if (result._metadata.hasRenderedHead || result._metadata.headInTree || result.fragment) {
return '';
}
return renderAllHeadContent(result);

5
packages/astro/test/fixtures/fragments/astro.config.mjs vendored Normal file
View file

@ -0,0 +1,5 @@
import { defineConfig } from 'astro/config';
// https://astro.build/config
export default defineConfig({
});

8
packages/astro/test/fixtures/fragments/package.json vendored Normal file
View file

@ -0,0 +1,8 @@
{
"name": "@test/fragments",
"version": "0.0.0",
"private": true,
"dependencies": {
"astro": "workspace:*"
}
}

4
packages/astro/test/fixtures/fragments/src/pages/fragments/item.astro vendored Normal file
View file

@ -0,0 +1,4 @@
---
export const fragment = true;
---
<li>This is a single line item</li>

44
packages/astro/test/fragments.test.js Normal file
View file

@ -0,0 +1,44 @@
import { expect } from 'chai';
import * as cheerio from 'cheerio';
import { loadFixture } from './test-utils.js';
describe('Fragments', () => {
/** @type {import('./test-utils.js').Fixture} */
let fixture;
before(async () => {
fixture = await loadFixture({
root: './fixtures/fragments/',
});
});
describe('dev', () => {
/** @type {import('./test-utils.js').DevServer} */
let devServer;
before(async () => {
devServer = await fixture.startDevServer();
});
after(async () => {
await devServer.stop();
});
it('is only the written HTML', async () => {
const html = await fixture.fetch('/fragments/item/').then((res) => res.text());
expect(html.startsWith('<li>')).to.equal(true);
});
});
describe('build', () => {
before(async () => {
await fixture.build();
});
it('is only the written HTML', async () => {
const html = await fixture.readFile('/fragments/item/index.html');
expect(html.startsWith('<li>')).to.equal(true);
});
});
});

6
pnpm-lock.yaml
View file

@ -2689,6 +2689,12 @@ importers:
specifier: workspace:*
version: link:../../..
packages/astro/test/fixtures/fragments:
dependencies:
astro:
specifier: workspace:*
version: link:../../..
packages/astro/test/fixtures/get-static-paths-pages:
dependencies:
astro: