Fix typos; Add concat-like Metadata.AddMetadata(Metadata); Add in-line docs for AvaloniaCompilationAssemblyProvider usage
#458
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
Public API members have backwards-compatibility maintained via aliases-like methods and properties ('=>' to correct definition).
Public API members receive aliases. Misnamed methods simply call correctly-named definitions and are aggressively-inlined.
…blyProvider usage
maxkatz6
reviewed
Mar 19, 2024
| @@ -27,7 +27,9 @@ public class ProjectOutputInfo | |||
| /// </summary> | |||
| public string RuntimeIdentifier { get; } | |||
|
|
|||
| public string TargetPlatfromIdentifier { get; } | |||
| [Obsolete($"Member name mispelled. Use {nameof(TargetPlatformIdentifier)} instead.")] | |||
There was a problem hiding this comment.
It's not part of the public API, do we need to keep old members?
There was a problem hiding this comment.
I used the following rules while refactoring:
- Private or local? Rename.
- If
InternalsVisibleTo, a new symbol with correct spelling is added to the Internal API. Else, symbols are renamed. - Public API receives a new symbol with the correct spelling.
The property you marked for review appears to be part of the public API. Is AvaloniaVS.Models somehow hidden from the public API? Should the property be treated as Internal?
There was a problem hiding this comment.
AvaloniaVS is not a library, these APIs are used only in the extension itself.
There was a problem hiding this comment.
Understood. I'll update references in the extension projects and remove the old symbols.
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.
TODO
Obsoletesymbols from AvaloniaVS.SharedAvaloniaVS.Shared\Models\ProjectOutputInfo.cs(30,10): Error CS0246: The type or namespace name 'ObsoleteAttribute' could not be found (are you missing a using directive or an assembly reference?)AvaloniaVS.Shared\Models\ProjectOutputInfo.cs(30,10): Error CS0246: The type or namespace name 'Obsolete' could not be found (are you missing a using directive or an assembly reference?)Features/Enhancements
Avalonia.Ide.CompletionEngine.Metadata.AddMetadata(Metadata metadata)to merge dictionaries from one Metadata into another. Keys are only added if they are not already present. Existing keys' values remain unchanged.This can be used to add metadata from various build contexts e.g. TargetFrameworks (build for multiple frameworks) and if-else compiler statements. Some TODO comments indicate potential improvements. How do we indicate which context a metadatum came from?
Miscellaneous Changes
AvaloniaCompilationAssemblyProviderctorandGetAssemblies(). The API's usage misunderstood in AvaloniaVSCode's AvaloniaLanguageServer, causing builds to fail.AvaloniaVS.SharedandAvalonia.Ide.CompletionEnginecorrected where understoodObsoleteannotation. Method aliases are aggressively in-lined.