Skip to content

Document suppress in supportedAstroFeatures #11825

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.

Sign up for GitHub

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

Merged
Parent: 5.9.0 Minor release docs
merged 6 commits into from
Jun 3, 2025
Merged

Document suppress in supportedAstroFeatures #11825

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f89f80
Document `suppress` in `supportedAstroFeatures`
yanthomasdev Jun 3, 2025
e4cf427
Apply suggestions from code review
yanthomasdev Jun 3, 2025
20179bc
Update adapter-reference.mdx
sarah11918 Jun 3, 2025
a76346c
Fix message
yanthomasdev Jun 3, 2025
f7436a8
more explicit about suppressing messages about support for a feature,…
sarah11918 Jun 3, 2025
9bdb63f
make definition clear messages are about supporting the feature, not …
sarah11918 Jun 3, 2025
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
51 changes: 51 additions & 0 deletions src/content/docs/en/reference/adapter-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export type AdapterSupportsKind = 'unsupported' | 'stable' | 'experimental' | 'd
export type AdapterSupportWithMessage = {
support: Exclude<AdapterSupportsKind, 'stable'>;
message: string;
suppress?: 'default' | 'all';
};

export type AdapterSupport = AdapterSupportsKind | AdapterSupportWithMessage;
Expand Down Expand Up @@ -428,6 +429,56 @@ export default function createIntegration() {
}
```

If the default log message sent along with your custom message can cause confusion, you can use `suppress: "default"` to suppress the default message:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of a structure like this (tell me what you think)

Up around line 375 at the beginning of this section, we have:

When using these properties, Astro will:

  • run specific validation;
  • emit contextual to the logs;

(Aside: should that be "emit contextual INFORMATION to the logs" ??)

These operations are run based on the features supported or not supported, their level of support, the desired amount of logging, and the user's own configuration.

Then here, we can actually have a proper heading for this option:

Suggested change
If the default log message sent along with your custom message can cause confusion, you can use `suppress: "default"` to suppress the default message:
### `suppress`
<p>
**Type:** `default | all`<br />
<Since v="5.9.0" />
</p>
An option to prevent showing some or all logged messages.
If Astro's default log message is confusing to the user in combination with your custom `message`, you can use `suppress: "default"` to suppress the default message and only log your message:

Copy link
Member Author

@yanthomasdev yanthomasdev Jun 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Aside: should that be "emit contextual INFORMATION to the logs" ??)

probably, yeah. We found a typo!


```js title="my-adapter.mjs" ins={13}
export default function createIntegration() {
return {
name: '@matthewp/my-adapter',
hooks: {
'astro:config:done': ({ setAdapter }) => {
setAdapter({
name: '@matthewp/my-adapter',
serverEntrypoint: '@matthewp/my-adapter/server.js',
supportedAstroFeatures: {
sharpImageService: {
support: 'limited',
message: 'This adapter has limited support for Sharp, certain features may not work as expected.',
suppress: 'default'
}
}
});
},
},
};
}
```

You can also use `suppress: "all"` to suppress all messages for a specific feature, useful if it doesn't impact users in a specific context:

```js title="my-adapter.mjs" ins={13}
export default function createIntegration() {
return {
name: '@matthewp/my-adapter',
hooks: {
'astro:config:done': ({ setAdapter }) => {
setAdapter({
name: '@matthewp/my-adapter',
serverEntrypoint: '@matthewp/my-adapter/server.js',
supportedAstroFeatures: {
sharpImageService: {
support: 'limited',
message: 'This adapter has limited support for Sharp, certain features may not work as expected.',
suppress: 'all'
}
}
});
},
},
};
}
```

## Adapter features

A set of features that changes the output of the emitted files. When an adapter opts in to these features, they will get additional information inside specific hooks.
Expand Down