Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds integration options #58

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/strong-monkeys-tell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"simple-stack-form": minor
---

Adds an adapter option to disable injection of middleware
17 changes: 12 additions & 5 deletions packages/form/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,22 @@ import type { AstroIntegration } from "astro";
const VIRTUAL_MOD_ID = "simple:form";
const RESOLVED_VIRTUAL_MOD_ID = "\0" + VIRTUAL_MOD_ID;

export default function integration(): AstroIntegration {
export type Options = {
injectMiddleware?: true | false;
};

export default function integration(opts?: Options): AstroIntegration {
return {
name: "simple-form",
hooks: {
"astro:config:setup"({ addMiddleware, updateConfig }) {
addMiddleware({
entrypoint: "simple-stack-form/middleware",
order: "pre",
});
const shouldInjectMiddleware: boolean = opts?.injectMiddleware ?? true;
if (shouldInjectMiddleware) {
addMiddleware({
entrypoint: "simple-stack-form/middleware",
order: "pre",
});
}

updateConfig({
vite: {
Expand Down
26 changes: 26 additions & 0 deletions www/src/content/docs/form/reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Reference
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
description: Reference for simple-stack-form
sidebar:
order: 4
---

## `injectMiddleware`

**Type:** `true | false`

The adapter option `injectMiddleware` allows to opt-out of the default behaviour, which injects a middleware. This could be useful if you want to add your own data retrivial and `POST` handling logic.
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved

```ts ins={3,7-9}
bholmesdev marked this conversation as resolved.
Show resolved Hide resolved
// astro.config.ts
import { defineConfig } from 'astro/config';
import simpleStackForm from 'simple-stack-form';

export default defineConfig({
integrations: [
simpleStackForm({
injectMiddleware: false,
}),
],
});
```