aboutsummaryrefslogtreecommitdiff
path: root/examples/container-with-vitest
diff options
context:
space:
mode:
authorGravatar github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2025-06-05 14:25:23 +0000
committerGravatar github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2025-06-05 14:25:23 +0000
commite586d7d704d475afe3373a1de6ae20d504f79d6d (patch)
tree7e3fa24807cebd48a86bd40f866d792181191ee9 /examples/container-with-vitest
downloadastro-e586d7d704d475afe3373a1de6ae20d504f79d6d.tar.gz
astro-e586d7d704d475afe3373a1de6ae20d504f79d6d.tar.zst
astro-e586d7d704d475afe3373a1de6ae20d504f79d6d.zip
Sync from a8e1c0a7402940e0fc5beef669522b315052df1blatest
Diffstat (limited to 'examples/container-with-vitest')
-rw-r--r--examples/container-with-vitest/.codesandbox/Dockerfile1
-rw-r--r--examples/container-with-vitest/.gitignore24
-rw-r--r--examples/container-with-vitest/README.md11
-rw-r--r--examples/container-with-vitest/astro.config.ts7
-rw-r--r--examples/container-with-vitest/package.json24
-rw-r--r--examples/container-with-vitest/public/favicon.svg9
-rw-r--r--examples/container-with-vitest/src/components/Card.astro8
-rw-r--r--examples/container-with-vitest/src/components/Counter.jsx14
-rw-r--r--examples/container-with-vitest/src/components/CounterLight.astro9
-rw-r--r--examples/container-with-vitest/src/components/ReactWrapper.astro5
-rw-r--r--examples/container-with-vitest/src/pages/[locale].astro20
-rw-r--r--examples/container-with-vitest/src/pages/api.ts11
-rw-r--r--examples/container-with-vitest/src/pages/index.astro16
-rw-r--r--examples/container-with-vitest/test/Card.test.ts29
-rw-r--r--examples/container-with-vitest/test/ReactWrapper.test.ts17
-rw-r--r--examples/container-with-vitest/test/[locale].test.ts16
-rw-r--r--examples/container-with-vitest/tsconfig.json5
-rw-r--r--examples/container-with-vitest/vitest.config.ts9
18 files changed, 235 insertions, 0 deletions
diff --git a/examples/container-with-vitest/.codesandbox/Dockerfile b/examples/container-with-vitest/.codesandbox/Dockerfile
new file mode 100644
index 000000000..c3b5c81a1
--- /dev/null
+++ b/examples/container-with-vitest/.codesandbox/Dockerfile
@@ -0,0 +1 @@
+FROM node:18-bullseye
diff --git a/examples/container-with-vitest/.gitignore b/examples/container-with-vitest/.gitignore
new file mode 100644
index 000000000..16d54bb13
--- /dev/null
+++ b/examples/container-with-vitest/.gitignore
@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/
diff --git a/examples/container-with-vitest/README.md b/examples/container-with-vitest/README.md
new file mode 100644
index 000000000..116268944
--- /dev/null
+++ b/examples/container-with-vitest/README.md
@@ -0,0 +1,11 @@
+# Astro + [Vitest](https://vitest.dev/) + Container API Example
+
+```sh
+npm create astro@latest -- --template container-with-vitest
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-vitest)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-vitest)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-vitest/devcontainer.json)
+
+This example showcases Astro working with [Vitest](https://vitest.dev/) and how to test components using the Container API.
diff --git a/examples/container-with-vitest/astro.config.ts b/examples/container-with-vitest/astro.config.ts
new file mode 100644
index 000000000..17257d4f1
--- /dev/null
+++ b/examples/container-with-vitest/astro.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import react from "@astrojs/react"
+
+// https://astro.build/config
+export default defineConfig({
+ integrations: [react()]
+});
diff --git a/examples/container-with-vitest/package.json b/examples/container-with-vitest/package.json
new file mode 100644
index 000000000..473e3f11b
--- /dev/null
+++ b/examples/container-with-vitest/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "@example/container-with-vitest",
+ "type": "module",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "astro dev",
+ "build": "astro build",
+ "preview": "astro preview",
+ "astro": "astro",
+ "test": "vitest run"
+ },
+ "dependencies": {
+ "@astrojs/react": "^4.3.0",
+ "astro": "^5.9.0",
+ "react": "^18.3.1",
+ "react-dom": "^18.3.1",
+ "vitest": "^3.1.1"
+ },
+ "devDependencies": {
+ "@types/react": "^18.3.20",
+ "@types/react-dom": "^18.3.6"
+ }
+}
diff --git a/examples/container-with-vitest/public/favicon.svg b/examples/container-with-vitest/public/favicon.svg
new file mode 100644
index 000000000..f157bd1c5
--- /dev/null
+++ b/examples/container-with-vitest/public/favicon.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
+ <path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
+ <style>
+ path { fill: #000; }
+ @media (prefers-color-scheme: dark) {
+ path { fill: #FFF; }
+ }
+ </style>
+</svg>
diff --git a/examples/container-with-vitest/src/components/Card.astro b/examples/container-with-vitest/src/components/Card.astro
new file mode 100644
index 000000000..a7e49f41c
--- /dev/null
+++ b/examples/container-with-vitest/src/components/Card.astro
@@ -0,0 +1,8 @@
+---
+
+---
+
+<div>
+ This is a card
+ <slot />
+</div>
diff --git a/examples/container-with-vitest/src/components/Counter.jsx b/examples/container-with-vitest/src/components/Counter.jsx
new file mode 100644
index 000000000..2148bf3d8
--- /dev/null
+++ b/examples/container-with-vitest/src/components/Counter.jsx
@@ -0,0 +1,14 @@
+import { useState } from 'react';
+
+export default function({ initialCount }) {
+ const [count, setCount] = useState(initialCount || 0);
+ return (
+ <div className="rounded-t-lg overflow-hidden border-t border-l border-r border-gray-400 text-center p-4">
+ <h2 className="font-semibold text-lg">Counter</h2>
+ <h3 className="font-medium text-lg">Count: {count}</h3>
+ <button
+ className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded"
+ onClick={() => setCount(count + 1)}>Increment</button>
+ </div>
+ )
+}
diff --git a/examples/container-with-vitest/src/components/CounterLight.astro b/examples/container-with-vitest/src/components/CounterLight.astro
new file mode 100644
index 000000000..7cee23bbe
--- /dev/null
+++ b/examples/container-with-vitest/src/components/CounterLight.astro
@@ -0,0 +1,9 @@
+---
+interface Props {
+ count?: number;
+}
+
+let { count = 0 } = Astro.props;
+---
+
+<p id="counter">{count}</p>
diff --git a/examples/container-with-vitest/src/components/ReactWrapper.astro b/examples/container-with-vitest/src/components/ReactWrapper.astro
new file mode 100644
index 000000000..73ac6baeb
--- /dev/null
+++ b/examples/container-with-vitest/src/components/ReactWrapper.astro
@@ -0,0 +1,5 @@
+---
+import Counter from './Counter.jsx';
+---
+
+<Counter initialCount={5} />
diff --git a/examples/container-with-vitest/src/pages/[locale].astro b/examples/container-with-vitest/src/pages/[locale].astro
new file mode 100644
index 000000000..b76d36d39
--- /dev/null
+++ b/examples/container-with-vitest/src/pages/[locale].astro
@@ -0,0 +1,20 @@
+---
+export function getStaticPaths() {
+ return [{ params: { locale: 'en' } }];
+}
+const { locale } = Astro.params;
+---
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+ <meta name="viewport" content="width=device-width" />
+ <meta name="generator" content={Astro.generator} />
+ <title>Astro</title>
+ </head>
+ <body>
+ <h1>Astro</h1>
+ <p>Locale: {locale}</p>
+ </body>
+</html>
diff --git a/examples/container-with-vitest/src/pages/api.ts b/examples/container-with-vitest/src/pages/api.ts
new file mode 100644
index 000000000..c30def5bb
--- /dev/null
+++ b/examples/container-with-vitest/src/pages/api.ts
@@ -0,0 +1,11 @@
+export function GET() {
+ const json = {
+ foo: 'bar',
+ number: 1,
+ };
+ return new Response(JSON.stringify(json), {
+ headers: {
+ 'content-type': 'application/json',
+ },
+ });
+}
diff --git a/examples/container-with-vitest/src/pages/index.astro b/examples/container-with-vitest/src/pages/index.astro
new file mode 100644
index 000000000..2d1410736
--- /dev/null
+++ b/examples/container-with-vitest/src/pages/index.astro
@@ -0,0 +1,16 @@
+---
+
+---
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+ <meta name="viewport" content="width=device-width" />
+ <meta name="generator" content={Astro.generator} />
+ <title>Astro</title>
+ </head>
+ <body>
+ <h1>Astro</h1>
+ </body>
+</html>
diff --git a/examples/container-with-vitest/test/Card.test.ts b/examples/container-with-vitest/test/Card.test.ts
new file mode 100644
index 000000000..119087a36
--- /dev/null
+++ b/examples/container-with-vitest/test/Card.test.ts
@@ -0,0 +1,29 @@
+import { experimental_AstroContainer as AstroContainer } from 'astro/container';
+import { expect, test } from 'vitest';
+import Card from '../src/components/Card.astro';
+import CounterLight from '../src/components/CounterLight.astro';
+
+test('Card with slots', async () => {
+ const container = await AstroContainer.create();
+ const result = await container.renderToString(Card, {
+ slots: {
+ default: 'Card content',
+ },
+ });
+
+ expect(result).toContain('This is a card');
+ expect(result).toContain('Card content');
+});
+
+test('Card with nested CounterLight', async () => {
+ const container = await AstroContainer.create();
+ const counterLight = await container.renderToString(CounterLight, { props: { count: 1 } });
+ const result = await container.renderToString(Card, {
+ slots: {
+ default: counterLight,
+ },
+ });
+
+ expect(result).toContain('This is a card');
+ expect(result).toContain(counterLight);
+});
diff --git a/examples/container-with-vitest/test/ReactWrapper.test.ts b/examples/container-with-vitest/test/ReactWrapper.test.ts
new file mode 100644
index 000000000..6adbff6cf
--- /dev/null
+++ b/examples/container-with-vitest/test/ReactWrapper.test.ts
@@ -0,0 +1,17 @@
+import { loadRenderers } from 'astro:container';
+import { getContainerRenderer } from '@astrojs/react';
+import { experimental_AstroContainer as AstroContainer } from 'astro/container';
+import { expect, test } from 'vitest';
+import ReactWrapper from '../src/components/ReactWrapper.astro';
+
+const renderers = await loadRenderers([getContainerRenderer()]);
+const container = await AstroContainer.create({
+ renderers,
+});
+
+test('ReactWrapper with react renderer', async () => {
+ const result = await container.renderToString(ReactWrapper);
+
+ expect(result).toContain('Counter');
+ expect(result).toContain('Count: <!-- -->5');
+});
diff --git a/examples/container-with-vitest/test/[locale].test.ts b/examples/container-with-vitest/test/[locale].test.ts
new file mode 100644
index 000000000..db450df53
--- /dev/null
+++ b/examples/container-with-vitest/test/[locale].test.ts
@@ -0,0 +1,16 @@
+import { experimental_AstroContainer as AstroContainer } from 'astro/container';
+import { expect, test } from 'vitest';
+import Locale from '../src/pages/[locale].astro';
+
+test('Dynamic route', async () => {
+ const container = await AstroContainer.create();
+ // @ts-ignore
+ const result = await container.renderToString(Locale, {
+ params: {
+ locale: 'en',
+ },
+ request: new Request('http://example.com/en'),
+ });
+
+ expect(result).toContain('Locale: en');
+});
diff --git a/examples/container-with-vitest/tsconfig.json b/examples/container-with-vitest/tsconfig.json
new file mode 100644
index 000000000..8bf91d3bb
--- /dev/null
+++ b/examples/container-with-vitest/tsconfig.json
@@ -0,0 +1,5 @@
+{
+ "extends": "astro/tsconfigs/strict",
+ "include": [".astro/types.d.ts", "**/*"],
+ "exclude": ["dist"]
+}
diff --git a/examples/container-with-vitest/vitest.config.ts b/examples/container-with-vitest/vitest.config.ts
new file mode 100644
index 000000000..a34f19bb1
--- /dev/null
+++ b/examples/container-with-vitest/vitest.config.ts
@@ -0,0 +1,9 @@
+/// <reference types="vitest" />
+import { getViteConfig } from 'astro/config';
+
+export default getViteConfig({
+ test: {
+ /* for example, use global to avoid globals imports (describe, test, expect): */
+ // globals: true,
+ },
+});