Merge branch 'main' into streaming-render-update

Author: JoviDeCroock

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ on:
       - '**'
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build_test:

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   release:

CHANGELOG.md

@@ -1,5 +1,44 @@
 # preact-render-to-string
 
+## 6.2.0
+
+### Minor Changes
+
+- [#305](https://github.com/preactjs/preact-render-to-string/pull/305) [`568f139`](https://github.com/preactjs/preact-render-to-string/commit/568f139a6c7916e0b6eebb7c51f1abf035850b7c) Thanks [@marvinhagemeister](https://github.com/marvinhagemeister)! - Add support for error boundaries via `componentDidCatch` and `getDerivedStateFromError`
+
+  This feature is disabled by default and can be enabled by toggling the `errorBoundaries` option:
+
+  ```js
+  import { options } from 'preact';
+
+  // Enable error boundaries
+  options.errorBoundaries = true;
+  ```
+
+## 6.1.0
+
+### Minor Changes
+
+- [#301](https://github.com/preactjs/preact-render-to-string/pull/301) [`659b456`](https://github.com/preactjs/preact-render-to-string/commit/659b45623093ae0a93cb29354b069a25cf6351b5) Thanks [@marvinhagemeister](https://github.com/marvinhagemeister)! - Add experimental ability to render HTML comments via `<Fragment UNSTABLE_comment="my-comment" />`. When the `UNSTABLE_comment` prop is present all children of that `Fragment` will be ignored and a HTML comment will be rendered instead. This feature is added to allow framework authors to experiment with marking DOM for hydration in the client. Note that it's marked as unstable and might change in the future.
+
+## 6.0.3
+
+### Patch Changes
+
+- [#298](https://github.com/preactjs/preact-render-to-string/pull/298) [`6a4b8ed`](https://github.com/preactjs/preact-render-to-string/commit/6a4b8edc3b60038d2dc539a9652db806c5c24616) Thanks [@shinyama-k](https://github.com/shinyama-k)! - Fix to add type file for jsx.js
+
+## 6.0.2
+
+### Patch Changes
+
+- [#294](https://github.com/preactjs/preact-render-to-string/pull/294) [`637b302`](https://github.com/preactjs/preact-render-to-string/commit/637b3021ff05a0729a1a7c0eb965ce3fc3556af6) Thanks [@marvinhagemeister](https://github.com/marvinhagemeister)! - Bring back exports from 5.x to make migration easier
+
+## 6.0.1
+
+### Patch Changes
+
+- [#292](https://github.com/preactjs/preact-render-to-string/pull/292) [`8f4692c`](https://github.com/preactjs/preact-render-to-string/commit/8f4692c49277591819acb74808a0e28f7cb30c2f) Thanks [@marvinhagemeister](https://github.com/marvinhagemeister)! - Fix error in commonjs entry point
+
 ## 6.0.0
 
 ### Major Changes

README.md

@@ -84,6 +84,17 @@ app.get('/:fox', (req, res) => {
 });
 ```
 
+### Error Boundaries
+
+Rendering errors can be caught by Preact via `getDerivedStateFromErrors` or `componentDidCatch`. To enable that feature in `preact-render-to-string` set `errorBoundaries = true`
+
+```js
+import { options } from 'preact';
+
+// Enable error boundaries in `preact-render-to-string`
+options.errorBoundaries = true;
+```
+
 ---
 
 ### `Suspense` & `lazy` components with [`preact/compat`](https://www.npmjs.com/package/preact) & [`preact-ssr-prepass`](https://www.npmjs.com/package/preact-ssr-prepass)
@@ -94,50 +105,48 @@ npm install preact preact-render-to-string preact-ssr-prepass
 
 ```jsx
 export default () => {
-  return (
-    <h1>Home page</h1>
-  )
-}
+	return <h1>Home page</h1>;
+};
 ```
 
 ```jsx
-import { Suspense, lazy } from "preact/compat"
+import { Suspense, lazy } from 'preact/compat';
 
 // Creation of the lazy component
-const HomePage = lazy(() => import("./pages/home"))
+const HomePage = lazy(() => import('./pages/home'));
 
 const Main = () => {
-  return (
-    <Suspense fallback={<p>Loading</p>}>
-      <HomePage />
-    </Suspense>
-  )
-}
+	return (
+		<Suspense fallback={<p>Loading</p>}>
+			<HomePage />
+		</Suspense>
+	);
+};
 ```
 
 ```jsx
-import { render } from "preact-render-to-string"
-import prepass from "preact-ssr-prepass"
-import { Main } from "./main"
+import { render } from 'preact-render-to-string';
+import prepass from 'preact-ssr-prepass';
+import { Main } from './main';
 
 const main = async () => {
-  // Creation of the virtual DOM
-  const vdom = <Main />
-  
-  // Pre-rendering of lazy components
-  await prepass(vdom)
-  
-  // Rendering of components 
-  const html = render(vdom)
-  
-  console.log(html)
-  // <h1>Home page</h1>
-}
+	// Creation of the virtual DOM
+	const vdom = <Main />;
+
+	// Pre-rendering of lazy components
+	await prepass(vdom);
+
+	// Rendering of components
+	const html = render(vdom);
+
+	console.log(html);
+	// <h1>Home page</h1>
+};
 
 // Execution & error handling
-main().catch(error => {
-  console.error(error)
-})
+main().catch((error) => {
+	console.error(error);
+});
 ```
 
 ---

config/node-commonjs.js

@@ -10,12 +10,23 @@ const filePath = (file) => path.join(process.cwd(), 'dist', file);
 fs.copyFileSync(filePath('index.js'), filePath('commonjs.js'));
 fs.copyFileSync(filePath('index.js.map'), filePath('commonjs.js.map'));
 
-const source = `module.exports = require('./commonjs').default;`;
+const source = [
+	`const mod = require('./commonjs');`,
+	`mod.default.renderToStaticMarkup = mod.default;`,
+	`mod.default.renderToString = mod.default;`,
+	`mod.default.render = mod.default;`,
+	`module.exports = mod.default;`
+].join('\n');
 fs.writeFileSync(filePath('index.js'), source, 'utf-8');
 
 // JSX entry
 fs.copyFileSync(filePath('jsx.js'), filePath('jsx-entry.js'));
 fs.copyFileSync(filePath('jsx.js.map'), filePath('jsx-entry.js.map'));
 
-const sourceJsx = `module.exports = require('./jsx-entry').default;`;
+const sourceJsx = [
+	`const entry = require('./jsx-entry');`,
+	`entry.default.render = entry.render;`,
+	`entry.default.shallowRender = entry.shallowRender;`,
+	`module.exports = entry.default;`
+].join('\n');
 fs.writeFileSync(filePath('jsx.js'), sourceJsx, 'utf-8');

config/node-verify-exports.js

@@ -0,0 +1,34 @@
+const path = require('path');
+const assert = require('assert/strict');
+
+const filePath = (file) => path.join(process.cwd(), 'dist', file);
+
+// Main CJS
+const mainCjs = require(filePath('index.js'));
+assert(typeof mainCjs === 'function');
+assert(typeof mainCjs.renderToString === 'function');
+assert(typeof mainCjs.renderToStaticMarkup === 'function');
+assert(typeof mainCjs.render === 'function');
+
+// Main ESM
+(async () => {
+	const mainESM = await import(filePath('index.mjs'));
+	assert(typeof mainESM.default === 'function');
+	assert(typeof mainESM.renderToString === 'function');
+	assert(typeof mainESM.renderToStaticMarkup === 'function');
+	assert(typeof mainESM.render === 'function');
+})();
+
+// JSX CJS
+const jsxCjs = require(filePath('jsx.js'));
+assert(typeof jsxCjs === 'function');
+assert(typeof jsxCjs.render === 'function');
+assert(typeof jsxCjs.shallowRender === 'function');
+
+// JSX ESM
+(async () => {
+	const jsxESM = await import(filePath('jsx.mjs'));
+	assert(typeof jsxESM.default === 'function');
+	assert(typeof jsxESM.render === 'function');
+	assert(typeof jsxESM.shallowRender === 'function');
+})();

package-lock.json

@@ -1,7 +1,7 @@
 {
 	"name": "preact-render-to-string",
 	"amdName": "preactRenderToString",
-	"version": "6.0.0",
+	"version": "6.2.0",
 	"description": "Render JSX to an HTML string, with support for Preact components.",
 	"main": "dist/index.js",
 	"umd:main": "dist/index.umd.js",
@@ -41,7 +41,7 @@
 		"bench": "BABEL_ENV=test node -r @babel/register benchmarks index.js",
 		"bench:v8": "BABEL_ENV=test microbundle benchmarks/index.js -f modern --alias benchmarkjs-pretty=benchmarks/lib/benchmark-lite.js --external none --target node --no-compress --no-sourcemap --raw -o benchmarks/.v8.mjs && v8 --module benchmarks/.v8.modern.js",
 		"build": "npm run -s transpile && npm run -s transpile:jsx && npm run -s copy-typescript-definition",
-		"postbuild": "node ./config/node-13-exports.js && node ./config/node-commonjs.js",
+		"postbuild": "node ./config/node-13-exports.js && node ./config/node-commonjs.js && node ./config/node-verify-exports.js",
 		"transpile": "microbundle src/index.js -f es,cjs,umd --target web --external preact",
 		"transpile:jsx": "microbundle src/jsx.js -o dist/jsx.js --target web --external preact && microbundle dist/jsx.js -o dist/jsx.js -f cjs --external preact",
 		"copy-typescript-definition": "copyfiles -f src/*.d.ts dist",
@@ -63,6 +63,7 @@
 		"src",
 		"dist",
 		"jsx.js",
+		"jsx.d.ts",
 		"typings.json"
 	],
 	"eslintConfig": {

package.json

@@ -1,3 +1,7 @@
 import { VNode } from 'preact';
 
 export default function renderToString(vnode: VNode, context?: any): string;
+
+export function render(vnode: VNode, context?: any): string;
+export function renderToString(vnode: VNode, context?: any): string;
+export function renderToStaticMarkup(vnode: VNode, context?: any): string;