Add the `output` option by matthewp · Pull Request #4015 · withastro/astro

matthewp · 2022-07-21T20:07:54Z

Changes

Adds the new config option output: 'static' | 'server'
This opens up the ability for Adapters to add special support for static mode.
This API is used instead of the presence of an adapter to enable SSR features.
If an adapter is omitted and output === 'server' we through an error during build.

Testing

Tests added

Docs

Add mode and deploy options docs#1088

changeset-bot · 2022-07-21T20:07:57Z

🦋 Changeset detected

Latest commit: 3d179ab

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages

Name	Type
astro	Minor
@astrojs/cloudflare	Minor
@astrojs/deno	Minor
@astrojs/image	Minor
@astrojs/netlify	Minor
@astrojs/node	Minor
@astrojs/sitemap	Minor
@astrojs/vercel	Minor
@e2e/astro-component	Patch
@e2e/error-react-spectrum	Patch
@e2e/error-sass	Patch
@e2e/errors	Patch
@e2e/lit-component	Patch
@e2e/preact-component	Patch
@e2e/react-component	Patch
@e2e/solid-component	Patch
@e2e/svelte-component	Patch
@e2e/e2e-tailwindcss	Patch
@e2e/ts-resolution	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

FredKSchott

LGTM so far!

force people to rename adapter to deploy or stay back-compat with adapter and a deprecation notice?

I'd lean for back-compat + deprecation notice. It's cheap to do a config rename like that inside of validateConfig() iirc.

matthewp · 2022-07-22T13:13:30Z

TODO:

- Update adapters to throw when attempted to use with mode: 'static'.

natemoo-re

Blocking this PR. There is an ongoing discussion on Discord about overloading the name mode which is a well-defined Vite-ism.

As soon as that's resolved, I'm totally on board with the core changes here.

natemoo-re · 2022-07-22T21:53:06Z

+'@astrojs/vercel': minor
+---
+
+New `mode` configuration option


Changeset needs to be updated to refer to output

FredKSchott

Thanks for helping to get this over the line @matthewp. I took a quick pass to clean this up for you so that we can merge in time for the RC. Here's a summary of the changes made on top of your PR:

cleaned up some of the auto-doc generation types.
cleaned up some of the old code from my original PR that had made its way into this one (old changesets, old "exports' entry, etc)
Kept the config output and the term "output target"/"output mode" used to describe it.
Reverted the deploy change to keep it as adapter for now. I'm glad that we experimented with a new name here but after trying a few out first-hand I wasn't happy with anything to the point that it would be worth the switch and increased migration cost of the more important output change. Let's keep it as "adapter" for now and can revisit later if user feedback is that the word "adapter" is still too vague.

* Start of work on astroConfig.mode === 'server' * Add tests and more * adapter -> deploy in some places * Add fallback for `adapter` config * Update more tests * Update image tests * Fix clientAddress test * Updates based on PR review * Add a changeset * Update integrations tests + readme * Oops * Remove old option * Rename `mode` to `output` * Update Node adapter test * Update test * fred pass * fred pass * fred pass * fix test Co-authored-by: Fred K. Schott <fkschott@gmail.com>

github-actions Bot added pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope) pkg: integration Related to any renderer integration (scope) labels Jul 21, 2022

natemoo-re mentioned this pull request Jul 21, 2022

Astro v1.0.0 RC #4011

Closed

20 tasks

FredKSchott reviewed Jul 22, 2022

View reviewed changes

Comment thread examples/basics/astro.config.mjs Outdated