Display parameter names in a structured way

Fixes #817
KirillOsenkov · Sep 18, 2024 · 5761346 · 5761346
1 parent f9b61ee
commit 5761346
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 11 deletions.
diff --git a/src/StructuredLogViewer/themes/Generic.xaml b/src/StructuredLogViewer/themes/Generic.xaml
@@ -439,6 +439,28 @@
  </HierarchicalDataTemplate.Triggers>
  </HierarchicalDataTemplate>
 
+ <HierarchicalDataTemplate DataType="{x:Type l:TaskParameterItem}"
+ ItemsSource="{Binding Children}">
+ <StackPanel Orientation="Horizontal">
+ <Path x:Name="icon"
+ Data="{DynamicResource AddItemGeometry}"
+ VerticalAlignment="Center"
+ Width="14"
+ Height="11"
+ Margin="3,3,6,3"
+ Stroke="{DynamicResource ItemStroke}"
+ Fill="{DynamicResource ItemBrush}" />
+ <TextBlock x:Name="label" Text="Add Item " />
+ <TextBlock Text="{Binding Name}" />
+ <TextBlock x:Name="parameterName" Text="{Binding ParameterName}" Foreground="Gray" Margin="16,0,0,0" />
+ </StackPanel>
+ <HierarchicalDataTemplate.Triggers>
+ <DataTrigger Binding="{Binding IsSelected}" Value="False">
+ <Setter TargetName="label" Property="Foreground" Value="{DynamicResource AddItemStroke}" />
+ </DataTrigger>
+ </HierarchicalDataTemplate.Triggers>
+ </HierarchicalDataTemplate>
+
  <HierarchicalDataTemplate DataType="{x:Type l:RemoveItem}"
  ItemsSource="{Binding Children}">
  <StackPanel Orientation="Horizontal">
@@ -571,11 +593,26 @@
  </DataTemplate.Triggers>
  </DataTemplate>
 
+ <DataTemplate DataType="{x:Type l:TaskParameterProperty}">
+ <StackPanel Orientation="Horizontal">
+ <Rectangle x:Name="icon" Style="{StaticResource NodeIcon}" Stroke="{DynamicResource PropertyStroke}" Fill="{DynamicResource PropertyBrush}" />
+ <TextBlock x:Name="label" Text="{Binding NameAndEquals, Mode=OneTime}" />
+ <TextBlock Text="{Binding ShortenedValue}" />
+ <TextBlock x:Name="parameterName" Text="{Binding ParameterName}" Foreground="Gray" Margin="16,0,0,0" />
+ </StackPanel>
+ <DataTemplate.Triggers>
+ <DataTrigger Binding="{Binding IsSelected}" Value="False">
+ <Setter TargetName="label" Property="Foreground" Value="{DynamicResource PropertyStroke}" />
+ </DataTrigger>
+ </DataTemplate.Triggers>
+ </DataTemplate>
+
  <HierarchicalDataTemplate DataType="{x:Type l:Parameter}"
  ItemsSource="{Binding Children}">
  <StackPanel Orientation="Horizontal">
  <Rectangle x:Name="icon" Style="{StaticResource NodeIcon}" Stroke="{DynamicResource ParameterStroke}" Fill="{DynamicResource ParameterBrush}" />
  <TextBlock x:Name="name" Text="{Binding Name}" />
+ <TextBlock x:Name="parameterName" Text="{Binding ParameterName}" Foreground="Gray" Margin="16,0,0,0" />
  </StackPanel>
  <HierarchicalDataTemplate.Triggers>
  <DataTrigger Binding="{Binding IsSelected}" Value="False">

diff --git a/src/StructuredLogger/Construction/MessageProcessor.cs b/src/StructuredLogger/Construction/MessageProcessor.cs
@@ -198,11 +198,9 @@ private void ProcessTaskParameter(TaskParameterEventArgs args)
  parent = task.GetOrCreateNodeWithName<Folder>(folderName);
  parent.DisableChildrenCache = true;
 
- string itemName = isOutput && parameterName is not null
- ? $"{propertyName ?? itemType} from parameter {parameterName}"
- : propertyName ?? itemType;
+ string itemName = propertyName ?? itemType;
 
- node = CreateParameterNode(itemName, items, isOutput);
+ node = CreateParameterNode(itemName, items, isOutput, parameterName);
  }
  else if (
  kind == TaskParameterMessageKind.AddItem ||
@@ -254,26 +252,53 @@ private void ProcessTaskParameter(TaskParameterEventArgs args)
  }
  }
 
- private BaseNode CreateParameterNode(string itemName, IEnumerable items, bool isOutput = false)
+ private BaseNode CreateParameterNode(string itemName, IEnumerable items, bool isOutput = false, string parameterName = null)
  {
  if (items is IList<ITaskItem> list && list.Count == 1 && list[0] is ITaskItem scalar && scalar.MetadataCount == 0)
  {
- var property = new Property
+ BaseNode property;
+ if (parameterName != null && parameterName != itemName)
  {
- Name = itemName,
- Value = scalar.ItemSpec
- };
+ property = new TaskParameterProperty
+ {
+ Name = itemName,
+ Value = scalar.ItemSpec,
+ ParameterName = parameterName
+ };
+ }
+ else
+ {
+ property = new Property
+ {
+ Name = itemName,
+ Value = scalar.ItemSpec
+ };
+ }
+
  return property;
  }
 
  TreeNode parent;
  if (isOutput)
  {
- parent = new AddItem { Name = itemName };
+ if (!string.IsNullOrEmpty(parameterName) && parameterName != itemName)
+ {
+ parent = new TaskParameterItem { Name = itemName, ParameterName = parameterName };
+ }
+ else
+ {
+ parent = new AddItem { Name = itemName };
+ }
  }
  else
  {
- parent = new Parameter { Name = itemName };
+ // no need to display the same string twice
+ if (parameterName == itemName)
+ {
+ parameterName = null;
+ }
+
+ parent = new Parameter { Name = itemName, ParameterName = parameterName };
  parent.DisableChildrenCache = true;
  }
 

diff --git a/src/StructuredLogger/ObjectModel/AddItem.cs b/src/StructuredLogger/ObjectModel/AddItem.cs
@@ -11,4 +11,9 @@ public AddItem()
 
  public int? LineNumber { get; set; }
  }
+
+ public class TaskParameterItem : AddItem
+ {
+ public string ParameterName { get; set; }
+ }
 }
diff --git a/src/StructuredLogger/ObjectModel/Parameter.cs b/src/StructuredLogger/ObjectModel/Parameter.cs
@@ -3,5 +3,7 @@
  public class Parameter : NamedNode
  {
  public override string TypeName => nameof(Parameter);
+
+ public string ParameterName { get; set; }
  }
 }
diff --git a/src/StructuredLogger/ObjectModel/Property.cs b/src/StructuredLogger/ObjectModel/Property.cs
@@ -4,4 +4,9 @@ public class Property : NameValueNode
  {
  public override string TypeName => nameof(Property);
  }
+
+ public class TaskParameterProperty : Property
+ {
+ public string ParameterName { get; set; }
+ }
 }