Merge pull request #3622 from IvenBach/Issue3485_Inspection_Sorting_Order

Sort inspections in settings dialog

Author: retailcoder

RetailCoder.VBE/UI/Settings/InspectionSettings.xaml

@@ -293,8 +293,12 @@
                                                          Content="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=SettingsCaption_ExportSettings}"/>
                             </Grid>
                             </StackPanel>
-                            <StackPanel Orientation="Horizontal" DockPanel.Dock="Right"/>
-                        </DockPanel>
+                        <StackPanel Orientation="Horizontal" DockPanel.Dock="Right">
+                            <Label Content="Description Filter"/>
+                            <TextBox MinWidth="75"
+                                     Text="{Binding InspectionSettingsFilter, UpdateSourceTrigger=PropertyChanged}"/>
+                        </StackPanel>
+                    </DockPanel>
                     </Label>  
                 <Border BorderBrush="DarkGray" BorderThickness="1" CornerRadius="2">
                     <controls:GroupingGrid ItemsSource="{Binding InspectionSettings}"

RetailCoder.VBE/UI/Settings/InspectionSettingsViewModel.cs

@@ -15,7 +15,10 @@ public class InspectionSettingsViewModel : SettingsViewModelBase, ISettingsViewM
         public InspectionSettingsViewModel(Configuration config)
         {
             InspectionSettings = new ListCollectionView(
-                    config.UserSettings.CodeInspectionSettings.CodeInspections.ToList());
+                        config.UserSettings.CodeInspectionSettings.CodeInspections
+                                        .OrderBy(inspection => inspection.TypeLabel)
+                                        .ThenBy(inspection => inspection.Description)
+                                        .ToList());
 
             WhitelistedIdentifierSettings = new ObservableCollection<WhitelistedIdentifierSetting>(
                 config.UserSettings.CodeInspectionSettings.WhitelistedIdentifiers.OrderBy(o => o.Identifier).Distinct());
@@ -39,10 +42,36 @@ public void UpdateCollection(CodeInspectionSeverity severity)
             InspectionSettings.CommitEdit();
         }
 
+        private string _inspectionSettingsFilter;
+        public string InspectionSettingsFilter
+        {
+            get => _inspectionSettingsFilter;
+            set
+            {
+                if (_inspectionSettingsFilter != value)
+                {
+                    _inspectionSettingsFilter = value;
+                    OnPropertyChanged(nameof(InspectionSettings));
+                }
+            }
+        }
+
         private ListCollectionView _inspectionSettings;
         public ListCollectionView InspectionSettings
         {
-            get => _inspectionSettings;
+            get
+            {
+                if (string.IsNullOrEmpty(_inspectionSettingsFilter))
+                {
+                    _inspectionSettings.Filter = null;
+                }
+                else
+                {
+                    _inspectionSettings.Filter = filter => FilterInspectionSettings(filter);
+                }
+                return _inspectionSettings;
+            }
+
             set
             {
                 if (_inspectionSettings != value)
@@ -53,6 +82,12 @@ public ListCollectionView InspectionSettings
             }
         }
 
+        private bool FilterInspectionSettings(object filter)
+        {
+            var cis = filter as CodeInspectionSetting;
+            return cis.Description.ToUpper().Contains(_inspectionSettingsFilter.ToUpper());
+        }
+
         private bool _runInspectionsOnSuccessfulParse;
         public bool RunInspectionsOnSuccessfulParse
         {

Rubberduck.Parsing/Inspections/Resources/InspectionsUI.resx

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -59,7 +59,7 @@
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
-  <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
     <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
     <xsd:element name="root" msdata:IsDataSet="true">
       <xsd:complexType>
@@ -887,4 +887,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="EmptyModuleInspectionResultFormat" xml:space="preserve">
     <value>Module/class {0} is empty.</value>
   </data>
-</root>
+  <data name="ObsoleteErrorSyntaxInspectionName" xml:space="preserve">
+    <value>Use of 'Error' statement</value>
+  </data>
+</root>

Rubberduck.Parsing/Inspections/Resources/InspectionsUI1.Designer.cs

@@ -20,9 +20,10 @@ private Configuration GetDefaultConfig()
                     new CodeInspectionSetting("HintInspection", "I'm a hint", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Hint, CodeInspectionSeverity.Hint),
                     new CodeInspectionSetting("SuggestionInspection", "I'm a suggestion", CodeInspectionType.MaintainabilityAndReadabilityIssues, CodeInspectionSeverity.Suggestion, CodeInspectionSeverity.Suggestion),
                     new CodeInspectionSetting("WarningInspection", "I'm a warning", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Warning, CodeInspectionSeverity.Warning),
-                    new CodeInspectionSetting("ErrorInspection", "FIX ME!", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Error, CodeInspectionSeverity.Error),
-                    new CodeInspectionSetting("NondefaultSeverityInspection", "I do not have my original severity", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Warning, CodeInspectionSeverity.DoNotShow)
-                })
+                    new CodeInspectionSetting("NondefaultSeverityInspection", "I do not have my original severity", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Warning, CodeInspectionSeverity.DoNotShow),
+                    new CodeInspectionSetting("ErrorInspection", "FIX ME!", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Error, CodeInspectionSeverity.Error)
+                }.OrderBy(cis => cis.TypeLabel)
+                    .ThenBy(cis => cis.Description)) // Explicit sorting is to match InspectionSettingsViewModel.cs
             };
 
             var userSettings = new UserSettings(null, null, null, inspectionSettings, null, null, null);
@@ -39,9 +40,10 @@ private Configuration GetNondefaultConfig()
                     new CodeInspectionSetting("HintInspection", "I'm a hint", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Hint, CodeInspectionSeverity.Suggestion),
                     new CodeInspectionSetting("SuggestionInspection", "I'm a suggestion", CodeInspectionType.MaintainabilityAndReadabilityIssues, CodeInspectionSeverity.Suggestion, CodeInspectionSeverity.Hint),
                     new CodeInspectionSetting("WarningInspection", "I'm a warning", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Warning, CodeInspectionSeverity.Error),
-                    new CodeInspectionSetting("ErrorInspection", "FIX ME!", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Error, CodeInspectionSeverity.DoNotShow),
-                    new CodeInspectionSetting("NondefaultSeverityInspection", "I do not have my original severity", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Warning, CodeInspectionSeverity.Error)
-                })
+                    new CodeInspectionSetting("NondefaultSeverityInspection", "I do not have my original severity", CodeInspectionType.LanguageOpportunities, CodeInspectionSeverity.Warning, CodeInspectionSeverity.Error),
+                    new CodeInspectionSetting("ErrorInspection", "FIX ME!", CodeInspectionType.CodeQualityIssues, CodeInspectionSeverity.Error, CodeInspectionSeverity.DoNotShow)
+                }.OrderBy(cis => cis.TypeLabel)
+                    .ThenBy(cis => cis.Description)) // Explicit sorting is to match InspectionSettingsViewModel.cs
             };
 
             var userSettings = new UserSettings(null, null, null, inspectionSettings, null, null, null);