chore: add isDeprecated flag to ErrorDescriptor interface#7954
Closed
jose-blockchain wants to merge 2 commits intoNomicFoundation:mainfrom
Closed
chore: add isDeprecated flag to ErrorDescriptor interface#7954jose-blockchain wants to merge 2 commits intoNomicFoundation:mainfrom
jose-blockchain wants to merge 2 commits intoNomicFoundation:mainfrom
Conversation
Add optional `isDeprecated` field to ErrorDescriptor so unused error descriptors can be marked as deprecated instead of deleted. The CLI error handler now shows a deprecation notice for deprecated errors. Closes NomicFoundation#7732 Co-authored-by: Cursor <cursoragent@cursor.com>
🦋 Changeset detectedLatest commit: 0102d65 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
Add isDeprecated flag to ErrorDescriptor interface in Hardhat.
Member
|
Thanks for this PR, @jose-blockchain. Unfortunately, it's not really helpful. The reason is that we don't delete error descriptors, as we use them to generate the error documentation in the website. And we want older versions of Hardhat to still be able to print valid links to deprecated errors |
Author
|
Ok, got it @alcuadrado , thanks. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add optional
isDeprecatedfield to ErrorDescriptor so unused error descriptors can be marked as deprecated instead of deleted. The CLI error handler now shows a deprecation notice for deprecated errors.Closes #7732
Changes
isDeprecated?: truefield to theErrorDescriptorinterface inhardhat-errorshardhat-errors/test/errors.ts(4 tests)hardhat/test/internal/cli/error-handler.ts(2 tests)How it works
When an error descriptor has
isDeprecated: true, the CLI output includes:This allows the website to clearly mark deprecated errors and avoids deleting descriptors that older Hardhat versions may still throw.