Skip to content
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

Jump to bottom

feat: Allow Name Generator to disable attach to DevTools #14425

Merged
merged 1 commit into from
Jan 31, 2024
Merged

feat: Allow Name Generator to disable attach to DevTools #14425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions packages/Avalonia/Avalonia.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<EnableAvaloniaXamlCompilation Condition="'$(EnableAvaloniaXamlCompilation)'==''">true</EnableAvaloniaXamlCompilation>
<AvaloniaXamlIlVerifyIl Condition="'$(AvaloniaXamlIlVerifyIl)'==''">false</AvaloniaXamlIlVerifyIl>
<AvaloniaUseCompiledBindingsByDefault Condition="'$(AvaloniaUseCompiledBindingsByDefault)'==''">false</AvaloniaUseCompiledBindingsByDefault>
<AvaloniaNameGeneratorAttachDevTools Condition="'$(AvaloniaNameGeneratorAttachDevTools)' == ''">true</AvaloniaNameGeneratorAttachDevTools>
</PropertyGroup>
<Import Project="$(MSBuildThisFileDirectory)\AvaloniaBuildTasks.props"/>
<Import Project="$(MSBuildThisFileDirectory)\Avalonia.Generators.props"/>
Expand Down
14 changes: 13 additions & 1 deletion packages/Avalonia/AvaloniaRules.Project.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<BoolProperty Name="AvaloniaNameGeneratorIsEnabled"
DisplayName="Use Name Generator"
Description="Enable/Disable Avalonia Name Source Generator"
HelpUrl="https://github.com/AvaloniaUI/Avalonia/blob/master/src/tools/Avalonia.Generators/README.md"
HelpUrl="https://github.com/AvaloniaUI/Avalonia/blob/master/src/tools/Avalonia.Generators/README.md#advanced-usage"
Copy link
Member

Choose a reason for hiding this comment

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

Side note: it should be moved to the docs page.

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#336

Category="NameGenerator" />

<EnumProperty Name="AvaloniaNameGeneratorBehavior"
Expand All @@ -67,6 +67,18 @@
</EnumProperty.Metadata>
</EnumProperty>

<BoolProperty Name="AvaloniaNameGeneratorAttachDevTools"
DisplayName="Attach Dev Tools"
Description="Allowed to automatic attach DevTools in Window InitializeComponent method."
Category="NameGenerator">
<BoolProperty.Metadata>
<NameValuePair Name="DependsOn" Value="Avalonia::AvaloniaNameGeneratorBehavior" />
<NameValuePair Name="VisibilityCondition">
<NameValuePair.Value>(has-evaluated-value "Avalonia" "AvaloniaNameGeneratorBehavior" "InitializeComponent")</NameValuePair.Value>
</NameValuePair>
</BoolProperty.Metadata>
</BoolProperty>

<EnumProperty Name="AvaloniaNameGeneratorDefaultFieldModifier"
DisplayName="Default Class Field/Property Modifier"
Description="Defines the access modifiers used for generated members"
Expand Down
2 changes: 2 additions & 0 deletions src/tools/Avalonia.Generators/Avalonia.Generators.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<AvaloniaNameGeneratorFilterByPath Condition="'$(AvaloniaNameGeneratorFilterByPath)' == ''">*</AvaloniaNameGeneratorFilterByPath>
<AvaloniaNameGeneratorFilterByNamespace Condition="'$(AvaloniaNameGeneratorFilterByNamespace)' == ''">*</AvaloniaNameGeneratorFilterByNamespace>
<AvaloniaNameGeneratorViewFileNamingStrategy Condition="'$(AvaloniaNameGeneratorViewFileNamingStrategy)' == ''">NamespaceAndClassName</AvaloniaNameGeneratorViewFileNamingStrategy>
<AvaloniaNameGeneratorAttachDevTools Condition="'$(AvaloniaNameGeneratorAttachDevTools)' == ''">true</AvaloniaNameGeneratorAttachDevTools>
</PropertyGroup>
<ItemGroup>
<CompilerVisibleItemMetadata Include="AdditionalFiles" MetadataName="SourceItemGroup"/>
Expand All @@ -15,6 +16,7 @@
<CompilerVisibleProperty Include="AvaloniaNameGeneratorFilterByPath" />
<CompilerVisibleProperty Include="AvaloniaNameGeneratorFilterByNamespace" />
<CompilerVisibleProperty Include="AvaloniaNameGeneratorViewFileNamingStrategy" />
<CompilerVisibleProperty Include="AvaloniaNameGeneratorAttachDevTools"/>
</ItemGroup>
<Target Name="_InjectAdditionalFiles" BeforeTargets="GenerateMSBuildEditorConfigFileShouldRun">
<ItemGroup>
Expand Down
6 changes: 5 additions & 1 deletion src/tools/Avalonia.Generators/GeneratorOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ internal enum BuildProperties
AvaloniaNameGeneratorFilterByPath = 3,
AvaloniaNameGeneratorFilterByNamespace = 4,
AvaloniaNameGeneratorViewFileNamingStrategy = 5,

AvaloniaNameGeneratorAttachDevTools = 6,
// TODO add other generators properties here.
}

Expand Down Expand Up @@ -48,6 +48,10 @@ internal class GeneratorOptions
BuildProperties.AvaloniaNameGeneratorFilterByNamespace,
"*");

public bool AvaloniaNameGeneratorAttachDevTools => GetBoolProperty(
BuildProperties.AvaloniaNameGeneratorAttachDevTools,
true);

private string[] GetStringArrayProperty(BuildProperties name, string defaultValue)
{
var key = name.ToString();
Expand Down
2 changes: 1 addition & 1 deletion src/tools/Avalonia.Generators/NameGenerator/AvaloniaNameSourceGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ private static INameGenerator CreateNameGenerator(GeneratorExecutionContext cont
var types = new RoslynTypeSystem((CSharpCompilation)context.Compilation);
ICodeGenerator generator = options.AvaloniaNameGeneratorBehavior switch {
Behavior.OnlyProperties => new OnlyPropertiesCodeGenerator(),
Behavior.InitializeComponent => new InitializeComponentCodeGenerator(types),
Behavior.InitializeComponent => new InitializeComponentCodeGenerator(types, options.AvaloniaNameGeneratorAttachDevTools),
_ => throw new ArgumentOutOfRangeException()
};

Expand Down
5 changes: 3 additions & 2 deletions src/tools/Avalonia.Generators/NameGenerator/InitializeComponentCodeGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ private const string AttachDevToolsParameterDocumentation
= @" /// <param name=""attachDevTools"">Should the dev tools be attached.</param>
";

public InitializeComponentCodeGenerator(IXamlTypeSystem types)

public InitializeComponentCodeGenerator(IXamlTypeSystem types, bool avaloniaNameGeneratorAttachDevTools)
{
_diagnosticsAreConnected = types.FindAssembly("Avalonia.Diagnostics") != null;
_diagnosticsAreConnected = avaloniaNameGeneratorAttachDevTools && types.FindAssembly("Avalonia.Diagnostics") != null;
}

public string GenerateCode(string className, string nameSpace, IXamlType xamlType, IEnumerable<ResolvedName> names)
Expand Down
3 changes: 1 addition & 2 deletions tests/Avalonia.Generators.Tests/InitializeComponent/InitializeComponentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
using Avalonia.Generators.Compiler;
using Avalonia.Generators.NameGenerator;
using Avalonia.Generators.Tests.InitializeComponent.GeneratedInitializeComponent;
using Avalonia.Generators.Tests.OnlyProperties.GeneratedCode;
using Avalonia.Generators.Tests.Views;
using Microsoft.CodeAnalysis.CSharp;
using Xunit;
Expand Down Expand Up @@ -48,7 +47,7 @@ public async Task Should_Generate_FindControl_Refs_From_Avalonia_Markup_File(
var nameResolver = new XamlXNameResolver();
var names = nameResolver.ResolveNames(classInfo.Xaml);

var generator = new InitializeComponentCodeGenerator(types);
var generator = new InitializeComponentCodeGenerator(types, devToolsMode);

var code = generator
.GenerateCode("SampleView", "Sample.App", classInfo.XamlType, names)
Expand Down