Improve error message with invalid configuration #2656
Merged
+16
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: c3470c4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
size-limit report 📦
|
delucis
approved these changes
Dec 6, 2024
Merged
HiDeoo
added a commit
to HiDeoo/starlight
that referenced
this pull request
Dec 13, 2024
* main: [ci] release (withastro#2634) ci: update file icons (withastro#2663) i18n(ru): update ru.json (withastro#2642) Improve error message with invalid configuration (withastro#2656) docs: use single listener in icons reference (withastro#2657) fix: use seti ui repo to generate file icons (withastro#2648) Fix favicon support for query and fragment in URLs (withastro#2645)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The integration expects an object for its configuration and we assume that this user input is always an object and we unpack it into variables from the integration parameters.
This can lead to confusing error messages when the user inputs an invalid configuration or even no configuration at all, e.g. after running
npx astro add starlight.This PR adds an extra check to ensure that the configuration is an object and throws a more helpful error message if it is not.