[UX] Warning the usage of alias in example (#20150)

wyunchi-ms · web-flow · commit 70fe06535586 · 2022-11-17T11:34:38.000+08:00
* Add validation of examples and url for UX metadata files

* Add alias check
diff --git a/src/SpringCloud/UX/Microsoft.AppPlatform/spring-apps-deployments.json b/src/SpringCloud/UX/Microsoft.AppPlatform/spring-apps-deployments.json
@@ -16,7 +16,7 @@
           "parameterSets": [
             {
               "parameters": [
-                "-DeploymentName <String>",
+                "-Name <String>",
                 "-AppName <String>",
                 "-ServiceName <String>",
                 "-ResourceGroupName <String>",
@@ -42,7 +42,7 @@
                       "value": "[path.serviceName]"
                   },
                   {
-                      "name": "-DeploymentName",
+                      "name": "-Name",
                       "value": "[path.deploymentName]"
                   },
                   {
diff --git a/src/SpringCloud/UX/Microsoft.AppPlatform/spring-apps.json b/src/SpringCloud/UX/Microsoft.AppPlatform/spring-apps.json
@@ -16,7 +16,7 @@
           "parameterSets": [
             {
               "parameters": [
-                "-AppName <String>",
+                "-Name <String>",
                 "-ServiceName <String>",
                 "-ResourceGroupName <String>",
                 "[-SubscriptionId <String[]>]"
@@ -33,7 +33,7 @@
                       "value": "[path.resourceGroupName]"
                   },
                   {
-                      "name": "-AppName",
+                      "name": "-Name",
                       "value": "[path.appName]"
                   },
                   {
diff --git a/src/SpringCloud/UX/Microsoft.AppPlatform/spring.json b/src/SpringCloud/UX/Microsoft.AppPlatform/spring.json
@@ -16,7 +16,7 @@
           "parameterSets": [
             {
               "parameters": [
-                "-ServiceName <String>",
+                "-Name <String>",
                 "-ResourceGroupName <String>",
                 "[-SubscriptionId <String[]>]"
               ]
@@ -32,7 +32,7 @@
                       "value": "[path.resourceGroupName]"
                   },
                   {
-                      "name": "-ServiceName",
+                      "name": "-Name",
                       "value": "[path.serviceName]"
                   },
                   {
diff --git a/tools/StaticAnalysis/UXMetadataAnalyzer/UXMetadataAnalyzer.cs b/tools/StaticAnalysis/UXMetadataAnalyzer/UXMetadataAnalyzer.cs
@@ -184,6 +184,8 @@ private void ValidateExample(string moduleName, string resourceType, string subR
                     {
                         if (alias.Equals(parameterNameInExample, StringComparison.CurrentCultureIgnoreCase))
                         {
+                            string issueDescription = string.Format("Please use parameter {0} instead of alias {1}", parameterMetadata.Name, alias);
+                            issueLogger.LogUXMetadataIssue(moduleName, resourceType, subResourceType, commandName, 2, issueDescription);
                             return parameterMetadata.Name;
                         }
                     }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`"parameterSets": [`
`17`	`17`	`{`
`18`	`18`	`"parameters": [`
`19`		`- "-DeploymentName <String>",`
	`19`	`+ "-Name <String>",`
`20`	`20`	`"-AppName <String>",`
`21`	`21`	`"-ServiceName <String>",`
`22`	`22`	`"-ResourceGroupName <String>",`
`@@ -42,7 +42,7 @@`
`42`	`42`	`"value": "[path.serviceName]"`
`43`	`43`	`},`
`44`	`44`	`{`
`45`		`- "name": "-DeploymentName",`
	`45`	`+ "name": "-Name",`
`46`	`46`	`"value": "[path.deploymentName]"`
`47`	`47`	`},`
`48`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,8 @@ private void ValidateExample(string moduleName, string resourceType, string subR`
`184`	`184`	`{`
`185`	`185`	`if (alias.Equals(parameterNameInExample, StringComparison.CurrentCultureIgnoreCase))`
`186`	`186`	`{`
	`187`	`+ string issueDescription = string.Format("Please use parameter {0} instead of alias {1}", parameterMetadata.Name, alias);`
	`188`	`+ issueLogger.LogUXMetadataIssue(moduleName, resourceType, subResourceType, commandName, 2, issueDescription);`
`187`	`189`	`return parameterMetadata.Name;`
`188`	`190`	`}`
`189`	`191`	`}`