fix(v5): format `adapter-reference.mdx` #9423

ArmandPhilippot · 2024-09-16T22:07:54Z

While I was reading a PR related to adapter-reference.mdx, I thought we could update the format to be consistent with configuration-reference.mdx and api-reference.mdx. Since v5 is set to replace the current version, I thought it might be more useful to update directly to that branch.

Description (required)

Add Type:, Default: and Since where appropriate
I moved some types from the section heading to Type:
Fix/Rename some types
Fix some line numbers to highlight in code blocks

A few hesitations:

Some properties are optional but are not explicitly marked with undefined as an accepted type. So in Type: I only put the accepted types (the property should not be added if it is undefined)
envGetSecret is in the Adapter features section but the type in the next branch of withastro/astro does not document it... So I obviously left it in, but I'm not sure of the type (I picked up the one in the sentence below) and I'm not sure if I should add Since (v5 I guess).
Some Defaults: that may not be explicit enough... I'll leave comments.

Related issues & labels (optional)

Suggested label: consistency/formatting

For Astro version: `5.0.0-beta`.

This PR targets the 5.0.0-beta branch.

netlify · 2024-09-16T22:08:12Z

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`df9c8d6`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/66e9bcfdb50ce700082ddfeb
😎 Deploy Preview	https://deploy-preview-9423--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ArmandPhilippot · 2024-09-16T22:08:46Z

src/content/docs/en/reference/adapter-reference.mdx

@@ -8,7 +8,7 @@ import { FileTree } from '@astrojs/starlight/components';

 Astro is designed to make it easy to deploy to any cloud provider for SSR (server-side rendering). This ability is provided by __adapters__, which are [integrations](/en/reference/integrations-reference/). See the [SSR guide](/en/guides/on-demand-rendering/) to learn how to use an existing adapter.

-## What is an adapter
+## What is an Adapter


The next heading uses a capitalized adapter so... either both are capitalized or neither.

ArmandPhilippot · 2024-09-16T22:09:25Z

src/content/docs/en/reference/adapter-reference.mdx

@@ -50,26 +50,30 @@ interface AstroAdapter {
 	exports?: string[];
 	args?: any;
 	adapterFeatures?: AstroAdapterFeatures;
-	supportedAstroFeatures?: AstroFeatureMap;
+	supportedAstroFeatures: AstroAdapterFeatureMap;


This was renamed.

ArmandPhilippot · 2024-09-16T22:09:58Z

src/content/docs/en/reference/adapter-reference.mdx

 }

-export type SupportsKind = 'unsupported' | 'stable' | 'experimental' | 'deprecated';
+export type AdapterSupportsKind = 'unsupported' | 'stable' | 'experimental' | 'deprecated' | 'limited';


This was renamed.

ArmandPhilippot · 2024-09-16T22:10:39Z

src/content/docs/en/reference/adapter-reference.mdx

+	/**
+	 * Determine the type of build output the adapter is intended for. Defaults to `server`;
+	 */
+	buildOutput?: 'static' | 'server';


buildOuput was missing.

ArmandPhilippot · 2024-09-16T22:11:20Z

src/content/docs/en/reference/adapter-reference.mdx


-export type AstroFeatureMap = {
+export type AstroAdapterFeatureMap = {


This was renamed.

ArmandPhilippot · 2024-09-16T22:12:07Z

src/content/docs/en/reference/adapter-reference.mdx

+  /**
+	 * The adapter is able to support i18n domains
+	 */
+	i18nDomains?: AdapterSupport;
+	/**
+	 * The adapter is able to support `getSecret` exported from `astro:env/server`
+	 */
+	envGetSecret?: AdapterSupport;


i18nDomains was missing and I moved envGetSecret (while fixing the comment).

ArmandPhilippot · 2024-09-16T22:14:21Z

src/content/docs/en/reference/adapter-reference.mdx

@@ -197,10 +211,21 @@ const response = await app.render(request);

 ##### `RenderOptions`

+<p>
+
+**Type:** `{addCookieHeader?: boolean; clientAddress?: string; locals?: object; routeData?: RouteData;}`


You can check the type here.

ArmandPhilippot · 2024-09-16T22:14:59Z

src/content/docs/en/reference/adapter-reference.mdx

+<p>
+
+**Type:** `string`<br />
+**Default:** `request[Symbol.for("astro.clientAddress")]`


Not sure if this default is really useful...

ArmandPhilippot · 2024-09-16T22:16:37Z

src/content/docs/en/reference/adapter-reference.mdx

+<p>
+
+**Type:** `RouteData`<br />
+**Default:** `app.match(request)`


It seems the default is the return type of app.match(request) and not app.match(request). But I wasn't sure about the value, maybe RouteData | undefined but it does not make sense as Default....

Should this now be IntegrationRouteData?

I hadn't paid attention to the sentence below, so I understand your question... I checked again:

By switching back to the next branch: the type is still RouteData.

So I checked IntegrationRouteData to make sure it's not an alias: this is a smaller version of RouteData.

So I don't think so, RouteData type still exists and it seems to be the one expected. And I guess the sentence below remains valid: we provide a full RouteData object which is passed to integrationRouteData in its smaller form.
But a check from someone more informed on how it works may be useful, this is marked as **Advanced API**: you probably do not need to use this.

ok, then sounds good! Thank you!

ArmandPhilippot · 2024-09-16T22:18:45Z

src/content/docs/en/reference/adapter-reference.mdx

+
+<p>
+
+**Type:** `(request: Request) => RouteData | undefined`


You can check the type here.

src/content/docs/en/reference/adapter-reference.mdx

sarah11918

Looks great, and thank you for jumping in to this! I just left a few comments!

sarah11918

Looks great, and thank you for jumping in to this! I just left a few comments!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

casungo

LGTM! Lots of small changes.

fix: v5/format-adapter-reference.mdx

abffa80

ArmandPhilippot commented Sep 16, 2024

View reviewed changes

fix code block highlighting for astro:build:ssr

86874a8

ArmandPhilippot commented Sep 17, 2024

View reviewed changes

src/content/docs/en/reference/adapter-reference.mdx Outdated Show resolved Hide resolved

fix envGetSecret type

e80da38

sarah11918 reviewed Sep 17, 2024

View reviewed changes

src/content/docs/en/reference/adapter-reference.mdx Show resolved Hide resolved

sarah11918 reviewed Sep 17, 2024

View reviewed changes

src/content/docs/en/reference/adapter-reference.mdx Outdated Show resolved Hide resolved

sarah11918 reviewed Sep 17, 2024

View reviewed changes

ArmandPhilippot and others added 3 commits September 17, 2024 19:15

question mark

18641b7

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

remove unecessary line break in middle of a sentence

dc4b693

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

Merge branch '5.0.0-beta' into fix/v5-format-adapter-reference.mdx

df9c8d6

sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. labels Sep 17, 2024

casungo approved these changes Sep 17, 2024

View reviewed changes

sarah11918 merged commit 2d7bacf into withastro:5.0.0-beta Sep 17, 2024
5 checks passed

ArmandPhilippot deleted the fix/v5-format-adapter-reference.mdx branch September 17, 2024 19:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(v5): format `adapter-reference.mdx` #9423

fix(v5): format `adapter-reference.mdx` #9423

ArmandPhilippot commented Sep 16, 2024

netlify bot commented Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024

ArmandPhilippot Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024 •

edited

Loading

sarah11918 Sep 17, 2024

ArmandPhilippot Sep 17, 2024

sarah11918 Sep 17, 2024

ArmandPhilippot Sep 16, 2024

sarah11918 left a comment

sarah11918 left a comment

casungo left a comment


		export type AstroFeatureMap = {
		export type AstroAdapterFeatureMap = {

fix(v5): format adapter-reference.mdx #9423

fix(v5): format adapter-reference.mdx #9423

Conversation

ArmandPhilippot commented Sep 16, 2024

Description (required)

Related issues & labels (optional)

For Astro version: 5.0.0-beta.

netlify bot commented Sep 16, 2024 • edited Loading

✅ Deploy Preview for astro-docs-2 ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArmandPhilippot Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArmandPhilippot Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

ArmandPhilippot Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

casungo left a comment

Choose a reason for hiding this comment

fix(v5): format `adapter-reference.mdx` #9423

fix(v5): format `adapter-reference.mdx` #9423

For Astro version: `5.0.0-beta`.

netlify bot commented Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024 •

edited

Loading

ArmandPhilippot Sep 16, 2024 •

edited

Loading