Skip to content

Conversation

@yanthomasdev
Copy link
Member

@yanthomasdev yanthomasdev commented Jun 3, 2025

Description (required)

This adds documentation for suppress: "all" and suppress: "default" in the supportedAstroFeatures property of setAdapter().

Related issues & labels (optional)

@netlify
Copy link

netlify bot commented Jun 3, 2025

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 9bdb63f
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/683f2c5b071b790008ba5b98
😎 Deploy Preview https://deploy-preview-11825--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Jun 3, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/reference/adapter-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! labels Jun 3, 2025
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thank you Yan! See what you think about my idea for structuring this below, plus some questions about trying to get the code samples to help demonstrate the purpose behind setting them!

}
```
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

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!

@sarah11918
Copy link
Member

Sorry, my previous commit merged before I changed the commit message! Previous commit:

  • created a new suppress heading with type/version info
  • referenced this section at the beginning of the Astro Features section
  • updates all the @matthewp examples to @example

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Jun 3, 2025
@sarah11918 sarah11918 changed the base branch from main to 5.9.0 June 3, 2025 17:19
@sarah11918 sarah11918 merged commit 2cc4abc into 5.9.0 Jun 3, 2025
10 checks passed
@sarah11918 sarah11918 deleted the suppress-adapter-log branch June 3, 2025 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants