withastro · tony-sull · Oct 7, 2022 · Sep 26, 2022 · Sep 26, 2022 · Sep 26, 2022
diff --git a/examples/integration/demo/.gitignore b/examples/integration/demo/.gitignore
@@ -0,0 +1,19 @@
+# build output
+dist/
+
+# 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
diff --git a/examples/integration/demo/.npmrc b/examples/integration/demo/.npmrc
@@ -0,0 +1,2 @@
+# Expose Astro dependencies for `pnpm` users
+shamefully-hoist=true
diff --git a/examples/integration/demo/.stackblitzrc b/examples/integration/demo/.stackblitzrc
@@ -0,0 +1,6 @@
+{
+ "startCommand": "npm start",
+ "env": {
+ "ENABLE_CJS_IMPORTS": true
+ }
+}
diff --git a/examples/integration/demo/.vscode/extensions.json b/examples/integration/demo/.vscode/extensions.json
@@ -0,0 +1,4 @@
+{
+ "recommendations": ["astro-build.astro-vscode"],
+ "unwantedRecommendations": []
+}
diff --git a/examples/integration/demo/.vscode/launch.json b/examples/integration/demo/.vscode/launch.json
@@ -0,0 +1,11 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "command": "./node_modules/.bin/astro dev",
+ "name": "Development server",
+ "request": "launch",
+ "type": "node-terminal"
+ }
+ ]
+}
diff --git a/examples/integration/demo/README.md b/examples/integration/demo/README.md
@@ -0,0 +1,45 @@
+# Astro Starter Kit: Minimal
+
+```
+npm create astro@latest -- --template minimal
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```
+/
+├── public/
+├── src/
+│ └── pages/
+│ └── index.astro
+└── package.json
+```
+
+Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
+
+There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
+
+Any static assets, like images, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command | Action |
+| :--------------------- | :----------------------------------------------- |
+| `npm install` | Installs dependencies |
+| `npm run dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro --help` | Get help using the Astro CLI |
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
diff --git a/examples/integration/demo/astro.config.mjs b/examples/integration/demo/astro.config.mjs
@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import myIntegration from '@example/my-integration';
+
+// https://astro.build/config
+export default defineConfig({
+ integrations: [myIntegration()],
+});
diff --git a/examples/integration/demo/package.json b/examples/integration/demo/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "@example/my-integration-demo",
+ "type": "module",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "astro dev",
+ "start": "astro dev",
+ "build": "astro build",
+ "preview": "astro preview",
+ "astro": "astro"
+ },
+ "dependencies": {
+ "@example/my-integration": "workspace:*",
+ "astro": "^1.3.0"
+ }
+}
diff --git a/examples/integration/demo/public/favicon.svg b/examples/integration/demo/public/favicon.svg
diff --git a/examples/integration/demo/sandbox.config.json b/examples/integration/demo/sandbox.config.json
@@ -0,0 +1,11 @@
+{
+ "infiniteLoopProtection": true,
+ "hardReloadOnChange": false,
+ "view": "browser",
+ "template": "node",
+ "container": {
+ "port": 3000,
+ "startScript": "start",
+ "node": "14"
+ }
+}
diff --git a/examples/integration/demo/src/env.d.ts b/examples/integration/demo/src/env.d.ts
@@ -0,0 +1 @@
+/// <reference types="astro/client" />
diff --git a/examples/integration/demo/src/pages/index.astro b/examples/integration/demo/src/pages/index.astro
@@ -0,0 +1,15 @@
+---
+---
+
+<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/integration/demo/tsconfig.json b/examples/integration/demo/tsconfig.json
@@ -0,0 +1,3 @@
+{
+ "extends": "astro/tsconfigs/base"
+}
diff --git a/examples/integration/package.json b/examples/integration/package.json
@@ -0,0 +1,15 @@
+{
+ "name": "@example/integration",
+ "type": "module",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "astro --root demo dev",
+ "start": "astro --root demo dev",
+ "build": "astro --root demo build",
+ "preview": "astro --root demo preview"
+ },
+ "dependencies": {
+ "astro": "^1.3.0"
+ }
+}
diff --git a/examples/integration/packages/my-integration/index.ts b/examples/integration/packages/my-integration/index.ts
@@ -0,0 +1,36 @@
+import type { AstroIntegration } from 'astro';
+
+export default function createIntegration(): AstroIntegration {
+ return {
+ name: '@example/my-integration',
+ hooks: {
+ 'astro:config:setup': ({
+ config,
+ command,
+ updateConfig,
+ addRenderer,
+ injectScript,
+ injectRoute,
+ }) => {
+ // Used to extend the project config. This includes updating the Astro config,
+ // applying Vite plugins, adding component renderers, and injecting scripts onto the page.
+ console.log('astro:config:setup');
+ },
+ 'astro:server:setup': ({ server }) => {
+ // Used to update Vite server options and middleware.
+ console.log('astro:server:setup');
+ },
+ 'astro:build:start': ({ buildConfig }) => {
+ // Used to set up any global objects or clients needed during a production build.
+ // This can also extend the build configuration options in the adapter API.
+ console.log('astro:build:start');
+ },
+ 'astro:build:done': ({ dir, routes }) => {
+ // Used to access generated routes and assets for extension (ex. copy content into the generated /assets directory).
+ // If you plan to transform generated assets, we recommend exploring the Vite Plugin API and
+ // configuring via astro:config:setup instead.
+ console.log('astro:build:done');
+ },
+ },
+ };
+}
diff --git a/examples/integration/packages/my-integration/package.json b/examples/integration/packages/my-integration/package.json
@@ -0,0 +1,22 @@
+{
+ "name": "@example/my-integration",
+ "private": true,
+ "version": "0.0.1",
+ "type": "module",
+ "exports": {
+ ".": "./index.ts"
+ },
+ "files": [
+ "index.ts"
+ ],
+ "keywords": [
+ "astro-component"
+ ],
+ "scripts": {},
+ "devDependencies": {
+ "astro": "^1.3.0"
+ },
+ "peerDependencies": {
+ "astro": "^1.3.0"
+ }
+}
diff --git a/examples/integration/packages/my-integration/tsconfig.json b/examples/integration/packages/my-integration/tsconfig.json
@@ -0,0 +1,3 @@
+{
+ "extends": "astro/tsconfigs/base"
+}
diff --git a/examples/integration/pnpm-workspace.yaml b/examples/integration/pnpm-workspace.yaml
@@ -0,0 +1,3 @@
+packages:
+ - 'packages/**/*'
+ - 'demo'
diff --git a/examples/integration/sandbox.config.json b/examples/integration/sandbox.config.json
@@ -0,0 +1,11 @@
+{
+ "infiniteLoopProtection": true,
+ "hardReloadOnChange": false,
+ "view": "browser",
+ "template": "node",
+ "container": {
+ "port": 3000,
+ "startScript": "start",
+ "node": "14"
+ }
+}
diff --git a/examples/integration/tsconfig.json b/examples/integration/tsconfig.json
@@ -0,0 +1,3 @@
+{
+ "extends": "astro/tsconfigs/base"
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml