From 7e31ca01a0e9b16ea13860f5c6026ccc65a0218f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Dec 2024 19:52:14 +0000 Subject: [PATCH] Sync from a44cfb874a6f066214e851c98a410d89c6866992 --- .gitignore | 24 ++++++++++++++++++++++++ README.md | 33 +++++++++++++++++++++++++++++++++ index.ts | 23 +++++++++++++++++++++++ package.json | 23 +++++++++++++++++++++++ tsconfig.json | 3 +++ 5 files changed, 106 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 index.ts create mode 100644 package.json create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..16d54bb13c --- /dev/null +++ b/.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/README.md b/README.md new file mode 100644 index 0000000000..4f08800312 --- /dev/null +++ b/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/index.ts b/index.ts new file mode 100644 index 0000000000..1fafd4e157 --- /dev/null +++ b/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/package.json b/package.json new file mode 100644 index 0000000000..2a05111f65 --- /dev/null +++ b/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.0.8" + }, + "peerDependencies": { + "astro": "^4.0.0" + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000..bcbf8b5090 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,3 @@ +{ + "extends": "astro/tsconfigs/strict" +}