Skip to content

feat: Allow treat Avalonia Access Unstable Private Apis Warning as Error #13937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 14, 2023
Merged

feat: Allow treat Avalonia Access Unstable Private Apis Warning as Error #13937

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
490df95
feat: Allow treat Avalonia Access Unstable Private Apis Warning as Error
workgroupengineering Dec 13, 2023
566fd7e
fix: Address review
workgroupengineering Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/Avalonia/AvaloniaPrivateApis.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@
<ReferencePath Include="$(MSBuildThisFileDirectory)/../lib/$(AvaloniaUnstableApiFrameworkToUse)/*.dll"/>
<ReferencePathWithRefAssemblies Include="$(MSBuildThisFileDirectory)/../lib/$(AvaloniaUnstableApiFrameworkToUse)/*.dll"/>
</ItemGroup>
<Warning Text="AvaloniaAccessUnstablePrivateApis is Enabled: This means you are using unstable internal APIs, and your code may be depending on APIs which may change or be removed in future versions of Avalonia. Set AvaloniaAccessUnstablePrivateApis to 'False' to disable this warning." />
<Warning Code="AVLN1002" Text="AvaloniaAccessUnstablePrivateApis is Enabled: This means you are using unstable internal APIs, and your code may be depending on APIs which may change or be removed in future versions of Avalonia. Set AvaloniaAccessUnstablePrivateApis to 'False' to disable this warning." />
Copy link
Member

@maxkatz6 maxkatz6 Dec 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two problems here:

  1. AVLN prefix is used by the XAML compiler. We probably can change that to "AVX" as for "AValoniaXaml" before 11.1.
  2. Specifically AVLN1000 range is used by the XML parsing errors.

    Avalonia/src/Markup/Avalonia.Markup.Xaml.Loader/CompilerExtensions/AvaloniaXamlDiagnosticCodes.cs

    Line 14 in 73f7fd1

    public const string InvalidXAML = "AVLN1001";

Avalonia property analyzer uses AVP0000 prefix.
Avalonia property name generator uses AXN0000 prefix.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be another non-conflicting code

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @maxkatz6
I chose this prefix because I believe it was related to XAML compiler. What prefix do you suggest?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think Private APIs warning is related to the XAML compiler. You can avoid XAML completely and still get this warning.

Seems like we also have a bit more generic codes: AVA2001

Avalonia/src/tools/Avalonia.Analyzers/OnPropertyChangedOverrideAnalyzer.cs

Line 13 in 73f7fd1

public const string DiagnosticId = "AVA2001";

Let's go with simple AVA3001 for now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these codes should be documented later

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AvaloniaUI/avalonia-docs#285

</Target>
</Project>