msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

chore: deprecate html in favour of body for render() ()

Browse Source 
Closes
pull/11942/head
Dominic Gannaway 10 months ago committed by GitHub
parent 9f823b95e3
commit 7714c934fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 35 additions and 23 deletions

5
.changeset/hot-sloths-clap.md
Unescape View File

@ -0,0 +1,5 @@
---
"svelte": patch
---
chore: deprecate html in favour of body for render()

12
packages/svelte/src/internal/server/index.js
Unescape View File

@ -13,13 +13,6 @@ import { current_component, pop, push } from './context.js';
import { BLOCK_CLOSE, BLOCK_OPEN } from './hydration.js'; import { BLOCK_CLOSE, BLOCK_OPEN } from './hydration.js';
import { validate_store } from '../shared/validate.js'; import { validate_store } from '../shared/validate.js';
/**
* @typedef {{
* head: string;
* html: string;
* }} RenderOutput
*/
// https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
// https://infra.spec.whatwg.org/#noncharacter // https://infra.spec.whatwg.org/#noncharacter
const INVALID_ATTR_NAME_CHAR_REGEX = const INVALID_ATTR_NAME_CHAR_REGEX =
@ -105,7 +98,7 @@ export let on_destroy = [];
/** /**
* @param {typeof import('svelte').SvelteComponent} component * @param {typeof import('svelte').SvelteComponent} component
* @param {{ props: Record<string, any>; context?: Map<any, any> }} options * @param {{ props: Record<string, any>; context?: Map<any, any> }} options
* @returns {RenderOutput} * @returns {import('#server').RenderOutput}
*/ */
export function render(component, options) { export function render(component, options) {
const payload = create_payload(); const payload = create_payload();
@ -132,7 +125,8 @@ export function render(component, options) {
return { return {
head: payload.head.out || payload.head.title ? payload.head.out + payload.head.title : '', head: payload.head.out || payload.head.title ? payload.head.out + payload.head.title : '',
html: payload.out html: payload.out,
body: payload.out
}; };
} }

9
packages/svelte/src/internal/server/types.d.ts vendored
Unescape View File

@ -20,3 +20,12 @@ export interface Payload {
anchor: number; anchor: number;
}; };
} }
export interface RenderOutput {
/** HTML that goes into the `<head>` */
head: string;
/** @deprecated use `body` instead */
html: string;
/** HTML that goes somewhere into the `<body>` */
body: string;
}

2
packages/svelte/src/legacy/legacy-server.js
Unescape View File

@ -27,7 +27,7 @@ export function asClassComponent(component) {
return { return {
css: { code: '', map: null }, css: { code: '', map: null },
head: result.head, head: result.head,
html: result.html html: result.body
}; };
}; };
// @ts-expect-error this is present for SSR // @ts-expect-error this is present for SSR

8
packages/svelte/tests/runtime-browser/test-ssr.ts
Unescape View File

@ -20,16 +20,16 @@ export async function run_ssr_test(
await compile_directory(test_dir, 'server', config.compileOptions); await compile_directory(test_dir, 'server', config.compileOptions);
const Component = (await import(`${test_dir}/_output/server/main.svelte.js`)).default; const Component = (await import(`${test_dir}/_output/server/main.svelte.js`)).default;
const { html } = render(Component, { props: config.props || {} }); const { body } = render(Component, { props: config.props || {} });
fs.writeFileSync(`${test_dir}/_output/rendered.html`, html); fs.writeFileSync(`${test_dir}/_output/rendered.html`, body);
if (config.ssrHtml) { if (config.ssrHtml) {
assert_html_equal_with_options(html, config.ssrHtml, { assert_html_equal_with_options(body, config.ssrHtml, {
preserveComments: config.compileOptions?.preserveComments preserveComments: config.compileOptions?.preserveComments
}); });
} else if (config.html) { } else if (config.html) {
assert_html_equal_with_options(html, config.html, { assert_html_equal_with_options(body, config.html, {
preserveComments: config.compileOptions?.preserveComments preserveComments: config.compileOptions?.preserveComments
}); });
} }

8
packages/svelte/tests/server-side-rendering/test.ts
Unescape View File

@ -23,18 +23,18 @@ const { test, run } = suite<SSRTest>(async (config, test_dir) => {
const Component = (await import(`${test_dir}/_output/server/main.svelte.js`)).default; const Component = (await import(`${test_dir}/_output/server/main.svelte.js`)).default;
const expected_html = try_read_file(`${test_dir}/_expected.html`); const expected_html = try_read_file(`${test_dir}/_expected.html`);
const rendered = render(Component, { props: config.props || {} }); const rendered = render(Component, { props: config.props || {} });
const { html, head } = rendered; const { body, head } = rendered;
fs.writeFileSync(`${test_dir}/_actual.html`, html); fs.writeFileSync(`${test_dir}/_actual.html`, body);
try { try {
assert_html_equal_with_options(html, expected_html || '', { assert_html_equal_with_options(body, expected_html || '', {
preserveComments: config.compileOptions?.preserveComments, preserveComments: config.compileOptions?.preserveComments,
withoutNormalizeHtml: config.withoutNormalizeHtml withoutNormalizeHtml: config.withoutNormalizeHtml
}); });
} catch (error: any) { } catch (error: any) {
if (should_update_expected()) { if (should_update_expected()) {
fs.writeFileSync(`${test_dir}/_expected.html`, html); fs.writeFileSync(`${test_dir}/_expected.html`, body);
console.log(`Updated ${test_dir}/_expected.html.`); console.log(`Updated ${test_dir}/_expected.html.`);
} else { } else {
error.message += '\n' + `${test_dir}/main.svelte`; error.message += '\n' + `${test_dir}/main.svelte`;

8
packages/svelte/types/index.d.ts vendored
Unescape View File

@ -2112,10 +2112,14 @@ declare module 'svelte/server' {
props: Record<string, any>; props: Record<string, any>;
context?: Map<any, any>; context?: Map<any, any>;
}): RenderOutput; }): RenderOutput;
type RenderOutput = { interface RenderOutput {
/** HTML that goes into the `<head>` */
head: string; head: string;
/** @deprecated use `body` instead */
html: string; html: string;
}; /** HTML that goes somewhere into the `<body>` */
body: string;
}
} }
declare module 'svelte/store' { declare module 'svelte/store' {

2
playgrounds/demo/server.js
Unescape View File

@ -28,7 +28,7 @@ async function createServer() {
const template = fs.readFileSync(path.resolve(__dirname, 'index.html'), 'utf-8'); const template = fs.readFileSync(path.resolve(__dirname, 'index.html'), 'utf-8');
const transformed_template = await vite.transformIndexHtml(req.originalUrl, template); const transformed_template = await vite.transformIndexHtml(req.originalUrl, template);
const { html: appHtml, head: headHtml } = await vite.ssrLoadModule('./src/entry-server.ts'); const { body: appHtml, head: headHtml } = await vite.ssrLoadModule('./src/entry-server.ts');
const html = transformed_template const html = transformed_template
.replace(`<!--ssr-html-->`, appHtml) .replace(`<!--ssr-html-->`, appHtml)

2
playgrounds/demo/src/entry-server.ts
Unescape View File

@ -4,4 +4,4 @@ import { render } from 'svelte/server';
import App from './App.svelte'; import App from './App.svelte';
// @ts-ignore // @ts-ignore
export const { head, html, css } = render(App, { props: { initialCount: 0 } }); export const { head, body, css } = render(App, { props: { initialCount: 0 } });

2
sites/svelte-5-preview/src/routes/docs/content/01-api/05-imports.md
Unescape View File

@ -119,7 +119,7 @@ Svelte provides reactive `Map`, `Set`, `Date` and `URL` classes. These can be im
### `render` ### `render`
Only available on the server and when compiling with the `server` option. Takes a component and returns an object with `html` and `head` properties on it, which you can use to populate the HTML when server-rendering your app: Only available on the server and when compiling with the `server` option. Takes a component and returns an object with `body` and `head` properties on it, which you can use to populate the HTML when server-rendering your app:
```js ```js
// @errors: 2724 2305 2307 // @errors: 2724 2305 2307

Write Preview
Loading…
Cancel
Save