Add deprecated aliases #5251
Draft
Add deprecated aliases #5251
Conversation
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
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.
This pull request adds a
deprecated-aliasrename transformer and a(define-deprecated-alias alias-id target-id)macro, which exportsalias-idas an alias oftarget-id.Checklist
Description of change
The
define-deprecated-aliasmacro providesalias-idas a rename transformer that expands totarget-id. It allows external tools to usesyntax-local-value/immediateon uses ofalias-idto determine that it's a deprecated alias and what identifier to use instead.This feature is intended for use in Typed Racket and Resyntax, as Typed Racket has several macros like
struct:,for:, etc. that are legacy aliases for non-colon-suffixed equivalents likestructandfor. Providing a standardized mechanism for defining deprecated aliases allows library authors to coerce Resyntax into automatically migrating client code when a library renames something. A full audit of main-distribution use cases remains to be performed, as there are likely other packages besides TR that could make use of this feature.