Implement the ability to deprecate a CommandOption#13
Open
ChristosMaragkos wants to merge 7 commits intospectreconsole:mainfrom
Open
Implement the ability to deprecate a CommandOption#13ChristosMaragkos wants to merge 7 commits intospectreconsole:mainfrom
CommandOption#13ChristosMaragkos wants to merge 7 commits intospectreconsole:mainfrom
Conversation
patriksvensson
requested changes
Dec 3, 2025
Contributor
patriksvensson
left a comment
There was a problem hiding this comment.
I think we should go the route of using the built-in ObsoleteAttribute here.
Author
|
I'm working on it. The semantics this provides are much cleaner compared to an optional ctor parameter. |
Author
|
This second iteration simply checks for the existence of [CommandOption("-d|--deprecated <VALUE>"]
[Obsolete("This option is deprecated. Please use <...>")]
public string? Deprecated { get; set; } |
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 is in regards to issue #1314 in the main repository, which has not yet been migrated.
This PR introduces the ability to mark a
CommandOptionas Deprecated, marking it as obsolete and subject to removal. In this first iteration of my implementation, developers can deprecateCommandOptions simply by specifying a deprecation message in theCommandOptionAttributector, like so:Deprecated options are parsed and consumed properly, while also printing their deprecation message as a warning to the console.
A unit test is also included, which I (successfully) ran locally. It can be found in
CommandOptionAttributeTests.Deprecation.cs.