Merge branch 'main' into fixWarnings

Author: MrHinsh

appsettings.json

@@ -181,10 +181,9 @@
             },
             "TfsWorkItemTypeValidatorTool": {
                 "Enabled": true,
-                "ExcludeWorkItemtypes": [],
+                "ExcludeWorkItemTypes": [],
                 "ExcludeDefaultWorkItemTypes": true,
-                "SourceFieldMappings": [],
-                "FixedTargetFields": []
+                "ExcludeSourceFields": {}
             }
         },
         "CommonToolSamples": {
@@ -196,15 +195,13 @@
             },
             "TfsWorkItemTypeValidatorTool": {
                 "Enabled": true,
-                "ExcludeWorkItemtypes": [
-                ],
-                "SourceFieldMappings": {
-                    "User Story": {
-                        "Microsoft.VSTS.Common.Prirucka": "Custom.Prirucka"
-                    }
-                },
-                "FixedTargetFields": {
-                    "User Story": ["Custom.Prirucka"]
+                "ExcludeWorkItemTypes": [],
+                "ExcludeDefaultWorkItemTypes": true,
+                "ExcludeSourceFields": {
+                    "Bug": [
+                        "Microsoft.VSTS.Common.AcceptanceCriteria",
+                        "Microsoft.VSTS.Scheduling.Effort"
+                    ]
                 }
             },
             "FieldMappingTool": {

docs/data/classes/reference.tools.tfsworkitemtypevalidatortool.yaml

@@ -12,9 +12,8 @@ configurationSamples:
           "TfsWorkItemTypeValidatorTool": {
             "Enabled": "True",
             "ExcludeDefaultWorkItemTypes": "True",
-            "ExcludeWorkItemtypes": null,
-            "FixedTargetFields": null,
-            "SourceFieldMappings": null
+            "ExcludeSourceFields": null,
+            "ExcludeWorkItemTypes": null
           }
         }
       }
@@ -30,17 +29,14 @@ configurationSamples:
         "CommonTools": {
           "TfsWorkItemTypeValidatorTool": {
             "Enabled": "True",
-            "ExcludeWorkItemtypes": null,
-            "FixedTargetFields": {
-              "User Story": [
-                "Custom.Prirucka"
+            "ExcludeDefaultWorkItemTypes": "True",
+            "ExcludeSourceFields": {
+              "Bug": [
+                "Microsoft.VSTS.Common.AcceptanceCriteria",
+                "Microsoft.VSTS.Scheduling.Effort"
               ]
             },
-            "SourceFieldMappings": {
-              "User Story": {
-                "Microsoft.VSTS.Common.Prirucka": "Custom.Prirucka"
-              }
-            }
+            "ExcludeWorkItemTypes": null
           }
         }
       }
@@ -56,7 +52,12 @@ configurationSamples:
       "IncludeWorkItemTypes": [],
       "ExcludeWorkItemTypes": [],
       "ExcludeDefaultWorkItemTypes": true,
-      "ExcludeSourceFields": {}
+      "ExcludeSourceFields": {
+        "Bug": [
+          "Microsoft.VSTS.Common.AcceptanceCriteria",
+          "Microsoft.VSTS.Scheduling.Effort"
+        ]
+      }
     }
   sampleFor: MigrationTools.Tools.TfsWorkItemTypeValidatorToolOptions
 description: >-
@@ -83,13 +84,13 @@ options:
 - parameterName: ExcludeSourceFields
   type: Dictionary
   description: >-
-    List of fields in source work itemt types, that are excluded from validation.
+    List of fields in source work item types, that are excluded from validation.
      Fields excluded from validation are still validated and all found issues are logged.
      But the result of the validation is 'valid' and the issues are logged as information instead of warning.
 
-     The key is the source work item type name.
-     You can also use `*` to exclude fields from all source work item types.
-  defaultValue: null
+     The key is the source work item type name. The value is list of fields' reference names which are excluded.
+     You can also use `*` as key to exclude fields from all source work item types.
+  defaultValue: Empty dictionary
   isRequired: false
   dotNetType: System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
 - parameterName: ExcludeWorkItemTypes

docs/static/schema/configuration.schema.json

@@ -2473,9 +2473,9 @@
                   "type": "boolean"
                 },
                 "ExcludeSourceFields": {
-                  "description": "List of fields in source work itemt types, that are excluded from validation.\r\n Fields excluded from validation are still validated and all found issues are logged.\r\n But the result of the validation is 'valid' and the issues are logged as information instead of warning.\r\n\n The key is the source work item type name.\r\n You can also use `*` to exclude fields from all source work item types.",
+                  "description": "List of fields in source work item types, that are excluded from validation.\r\n Fields excluded from validation are still validated and all found issues are logged.\r\n But the result of the validation is 'valid' and the issues are logged as information instead of warning.\r\n\n The key is the source work item type name. The value is list of fields' reference names which are excluded.\r\n You can also use `*` as key to exclude fields from all source work item types.",
                   "type": "object",
-                  "default": "null",
+                  "default": "Empty dictionary",
                   "additionalProperties": {
                     "type": "array",
                     "prefixItems": [

docs/static/schema/schema.tools.tfsworkitemtypevalidatortool.json

@@ -15,9 +15,9 @@
       "type": "boolean"
     },
     "ExcludeSourceFields": {
-      "description": "List of fields in source work itemt types, that are excluded from validation.\r\n Fields excluded from validation are still validated and all found issues are logged.\r\n But the result of the validation is 'valid' and the issues are logged as information instead of warning.\r\n\n The key is the source work item type name.\r\n You can also use `*` to exclude fields from all source work item types.",
+      "description": "List of fields in source work item types, that are excluded from validation.\r\n Fields excluded from validation are still validated and all found issues are logged.\r\n But the result of the validation is 'valid' and the issues are logged as information instead of warning.\r\n\n The key is the source work item type name. The value is list of fields' reference names which are excluded.\r\n You can also use `*` as key to exclude fields from all source work item types.",
       "type": "object",
-      "default": "null"
+      "default": "Empty dictionary"
     },
     "ExcludeWorkItemTypes": {
       "description": "List of work item types which will be excluded from validation.",

src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemTypeValidatorToolOptions.cs

@@ -43,16 +43,16 @@ public class TfsWorkItemTypeValidatorToolOptions : ToolOptions
 
         /// <summary>
         /// <para>
-        /// List of fields in source work itemt types, that are excluded from validation.
+        /// List of fields in source work item types, that are excluded from validation.
         /// Fields excluded from validation are still validated and all found issues are logged.
         /// But the result of the validation is 'valid' and the issues are logged as information instead of warning.
         /// </para>
         /// <para>
-        /// The key is the source work item type name.
-        /// You can also use <c>*</c> to exclude fields from all source work item types.
+        /// The key is the source work item type name. The value is list of fields' reference names which are excluded.
+        /// You can also use <c>*</c> as key to exclude fields from all source work item types.
         /// </para>
         /// </summary>
-        /// <default>null</default>
+        /// <default>Empty dictionary</default>
         public Dictionary<string, List<string>> ExcludeSourceFields { get; set; } = [];
 
         /// <summary>