0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
This commit is contained in:
github-actions[bot] 2024-12-16 19:52:14 +00:00
commit 7e31ca01a0
5 changed files with 106 additions and 0 deletions

24
.gitignore vendored Normal file
View file

@ -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/

33
README.md Normal file
View file

@ -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) |

23
index.ts Normal file
View file

@ -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
},
},
};
}

23
package.json Normal file
View file

@ -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"
}
}

3
tsconfig.json Normal file
View file

@ -0,0 +1,3 @@
{
"extends": "astro/tsconfigs/strict"
}