Skip to content

Commit

Permalink
fix: adapter features messaging (#11773)
Browse files Browse the repository at this point in the history
* fix: adapter features messaging

* Apply suggestions from code review

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

* Update .changeset/long-months-burn.md

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>

---------

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
  • Loading branch information
3 people committed Aug 20, 2024
1 parent fc81b01 commit 86a3391
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/long-months-burn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Changes messages logged when using unsupported, deprecated, or experimental adapter features for clarity
6 changes: 3 additions & 3 deletions packages/astro/src/integrations/features-validation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,20 +124,20 @@ function validateSupportKind(
}

function featureIsUnsupported(adapterName: string, logger: Logger, featureName: string) {
logger.error('config', `The feature "${featureName}" is not supported (used by ${adapterName}).`);
logger.error('config', `The adapter ${adapterName} doesn't currently support the feature "${featureName}".`);
}

function featureIsExperimental(adapterName: string, logger: Logger, featureName: string) {
logger.warn(
'config',
`The feature "${featureName}" is experimental and subject to change (used by ${adapterName}).`,
`The adapter ${adapterName} provides experimental support for "${featureName}". You may experience issues or breaking changes until this feature is fully supported by the adapter.`,
);
}

function featureIsDeprecated(adapterName: string, logger: Logger, featureName: string) {
logger.warn(
'config',
`The feature "${featureName}" is deprecated and will be removed in the future (used by ${adapterName}).`,
`The adapter ${adapterName} has deprecated its support for "${featureName}", and future compatibility is not guaranteed. The adapter may completely remove support for this feature without warning.`,
);
}

Expand Down

0 comments on commit 86a3391

Please sign in to comment.