aboutsummaryrefslogtreecommitdiff
path: root/examples/integration
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/integration
downloadastro-e586d7d704d475afe3373a1de6ae20d504f79d6d.tar.gz
astro-e586d7d704d475afe3373a1de6ae20d504f79d6d.tar.zst
astro-e586d7d704d475afe3373a1de6ae20d504f79d6d.zip
Sync from a8e1c0a7402940e0fc5beef669522b315052df1blatest
Diffstat (limited to 'examples/integration')
-rw-r--r--examples/integration/.gitignore24
-rw-r--r--examples/integration/README.md33
-rw-r--r--examples/integration/index.ts23
-rw-r--r--examples/integration/package.json23
-rw-r--r--examples/integration/tsconfig.json3
5 files changed, 106 insertions, 0 deletions
diff --git a/examples/integration/.gitignore b/examples/integration/.gitignore
new file mode 100644
index 000000000..16d54bb13
--- /dev/null
+++ b/examples/integration/.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/integration/README.md b/examples/integration/README.md
new file mode 100644
index 000000000..4f0880031
--- /dev/null
+++ b/examples/integration/README.md
@@ -0,0 +1,33 @@
+# Astro Starter Kit: Integration Package
+
+This is a template for an Astro integration. Use this template for writing integrations to use in multiple projects or publish to NPM.
+
+```sh
+npm create astro@latest -- --template integration
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/integration)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/integration)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/integration/devcontainer.json)
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```text
+/
+├── index.ts
+├── tsconfig.json
+├── package.json
+```
+
+The `index.ts` file is the "entry point" for your integration. Export your integration in `index.ts` to make them importable from your package.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command | Action |
+| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `npm link` | Registers this package locally. Run `npm link my-integration` in an Astro project to install your integration |
+| `npm publish` | [Publishes](https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages#publishing-unscoped-public-packages) this package to NPM. Requires you to be [logged in](https://docs.npmjs.com/cli/v8/commands/npm-adduser) |
diff --git a/examples/integration/index.ts b/examples/integration/index.ts
new file mode 100644
index 000000000..1fafd4e15
--- /dev/null
+++ b/examples/integration/index.ts
@@ -0,0 +1,23 @@
+import type { AstroIntegration } from 'astro';
+
+export default function createIntegration(): AstroIntegration {
+ // See the Integration API docs for full details
+ // https://docs.astro.build/en/reference/integrations-reference/
+ return {
+ name: '@example/my-integration',
+ hooks: {
+ 'astro:config:setup': () => {
+ // See the @astrojs/react integration for an example
+ // https://github.com/withastro/astro/blob/main/packages/integrations/react/src/index.ts
+ },
+ 'astro:build:setup': () => {
+ // See the @astrojs/react integration for an example
+ // https://github.com/withastro/astro/blob/main/packages/integrations/react/src/index.ts
+ },
+ 'astro:build:done': () => {
+ // See the @astrojs/partytown integration for an example
+ // https://github.com/withastro/astro/blob/main/packages/integrations/partytown/src/index.ts
+ },
+ },
+ };
+}
diff --git a/examples/integration/package.json b/examples/integration/package.json
new file mode 100644
index 000000000..e6a3866fb
--- /dev/null
+++ b/examples/integration/package.json
@@ -0,0 +1,23 @@
+{
+ "name": "@example/integration",
+ "private": true,
+ "version": "0.0.1",
+ "type": "module",
+ "exports": {
+ ".": "./index.ts"
+ },
+ "files": [
+ "src",
+ "index.ts"
+ ],
+ "keywords": [
+ "withastro"
+ ],
+ "scripts": {},
+ "devDependencies": {
+ "astro": "^5.9.0"
+ },
+ "peerDependencies": {
+ "astro": "^4.0.0"
+ }
+}
diff --git a/examples/integration/tsconfig.json b/examples/integration/tsconfig.json
new file mode 100644
index 000000000..bcbf8b509
--- /dev/null
+++ b/examples/integration/tsconfig.json
@@ -0,0 +1,3 @@
+{
+ "extends": "astro/tsconfigs/strict"
+}