Add feautre to generate ux metadata file (#1076)

* commit

* Update template

* Update template

* Update template

* Update template

* Update template

* update

* Update the logic of getting module name and description of cmdlet

Author: wyunchi-ms

.gitignore

@@ -381,3 +381,5 @@ package-deps.json
 /tests/**/license.txt
 
 !/tests/**/test/*
+
+.vscode/

docs/default-directory-layout.md

@@ -13,6 +13,7 @@ By default, AutoRest's PowerShell Generator will place all the generated files u
 - [/obj](#obj)
 - [/resources](#resources)
 - [/test](#test)
+- [/UX](#ux)
 - [/node-modules](#node-modules) (coming soon)
 - [.gitignore](#gitignore) 
 - [\<format-file>.format.ps1xml](#format-fileformatps1xml)
@@ -62,6 +63,9 @@ Contains files not consumed by *any* process. Only for the repo as reference ass
 ### /test
 Contains tests for the cmdlets. By default, it contains an example pester test and a httpipelinemock.ps1 script.
 
+### /UX
+Contains metadata files for portal UX. Portal use these to display the usage of cmdlet for the resource in portal page.
+
 ### /node_modules
 Contains the packages from which the projects depend on.
 

docs/repository-layout.md

@@ -13,6 +13,7 @@ In this repository
  - `powershell` - all the source code for the AutoRest.PowerShell extension.
  - `samples/` - a couple small non-azure examples to generate modules 
  - `tests/` - **WORK IN PROGRESS** scripts to generate some tests to validate the code generator.
+ - `UX/` - the portal UX metadata files use to display usage of powershell cmdlet for resource in portal page.
 
 ### The `powershell` plugin
 - `cmdlets/` - code for creating the cmdlet classes

powershell/autorest-configuration.md

@@ -75,6 +75,7 @@ docs-folder: $(current-folder)/docs
 dependency-module-folder: $(module-folder)/modules
 examples-folder: $(current-folder)/examples
 resources-folder: $(current-folder)/resources
+ux-folder: $(current-folder)/UX
 ```
 
 > File Paths

powershell/cmdlets/class.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-let ejs = require('ejs')
+const ejs = require('ejs');
 import { Schema as NewSchema, SchemaType, ArraySchema, SchemaResponse, HttpParameter, ObjectSchema, BinaryResponse, DictionarySchema, ChoiceSchema, SealedChoiceSchema } from '@azure-tools/codemodel';
 import { command, getAllProperties, JsonType, http, getAllPublicVirtualProperties, getVirtualPropertyFromPropertyName, ParameterLocation, getAllVirtualProperties, VirtualParameter, VirtualProperty } from '@azure-tools/codemodel-v3';
 import { CommandOperation, OperationType, VirtualParameter as NewVirtualParameter } from '../utils/command-operation';
@@ -15,7 +15,7 @@ import {
   Switch, System, TerminalCase, toExpression, Try, Using, valueOf, Field, IsNull, Or, ExpressionOrLiteral, TerminalDefaultCase, xmlize, TypeDeclaration, And, IsNotNull, PartialMethod, Case, While
 } from '@azure-tools/codegen-csharp';
 import { ClientRuntime, EventListener, Schema, ArrayOf, EnumImplementation } from '../llcsharp/exports';
-import { Alias, ArgumentCompleterAttribute, AsyncCommandRuntime, AsyncJob, CmdletAttribute, ErrorCategory, ErrorRecord, Events, InvocationInfo, OutputTypeAttribute, ParameterAttribute, PSCmdlet, PSCredential, SwitchParameter, ValidateNotNull, verbEnum, GeneratedAttribute, DescriptionAttribute, ExternalDocsAttribute, CategoryAttribute, ParameterCategory, ProfileAttribute, PSObject, InternalExportAttribute, ExportAsAttribute, DefaultRunspace, RunspaceFactory, AllowEmptyCollectionAttribute, DoNotExportAttribute } from '../internal/powershell-declarations';
+import { Alias, ArgumentCompleterAttribute, AsyncCommandRuntime, AsyncJob, CmdletAttribute, ErrorCategory, ErrorRecord, Events, InvocationInfo, OutputTypeAttribute, ParameterAttribute, PSCmdlet, PSCredential, SwitchParameter, ValidateNotNull, verbEnum, GeneratedAttribute, DescriptionAttribute, ExternalDocsAttribute, CategoryAttribute, ParameterCategory, ProfileAttribute, PSObject, InternalExportAttribute, ExportAsAttribute, DefaultRunspace, RunspaceFactory, AllowEmptyCollectionAttribute, DoNotExportAttribute, HttpPathAttribute } from '../internal/powershell-declarations';
 import { State } from '../internal/state';
 import { Channel } from '@azure-tools/autorest-extension-base';
 import { IParameter } from '@azure-tools/codemodel-v3/dist/code-model/components';
@@ -1243,8 +1243,8 @@ export class CmdletClass extends Class {
           yield Return();
         }),
         TerminalCase(Events.Progress.value, function* () {
-          yield 'var data = messageData();'
-          yield 'int progress = (int)data.Value;'
+          yield 'var data = messageData();';
+          yield 'int progress = (int)data.Value;';
           yield 'string activityMessage, statusDescription;';
           yield 'global::System.Management.Automation.ProgressRecordType recordType;';
 
@@ -1262,10 +1262,10 @@ export class CmdletClass extends Class {
           yield '}';
 
           // hardcode id = 1 because there is no need for nested progress bar
-          yield `WriteProgress(new global::System.Management.Automation.ProgressRecord(1, activityMessage, statusDescription)`;
+          yield 'WriteProgress(new global::System.Management.Automation.ProgressRecord(1, activityMessage, statusDescription)';
           yield '{';
           yield '    PercentComplete = progress,';
-          yield 'RecordType = recordType'
+          yield 'RecordType = recordType';
           yield '});';
           yield Return();
         }),
@@ -1288,15 +1288,15 @@ export class CmdletClass extends Class {
             yield '    return;';
             yield '}';
           });
-          yield Else(function * () {
+          yield Else(function* () {
             yield 'if (data.ResponseMessage is System.Net.Http.HttpResponseMessage response)';
             yield '{';
             yield '    int delay = (int)(response.Headers.RetryAfter?.Delta?.TotalSeconds ?? 30);';
             yield '    WriteDebug($"Delaying {delay} seconds before polling.");';
             yield '    for (var now = 0; now < delay; ++now)';
             yield '    {';
             // hardcode id = 1 because there is no need for nested progress bar
-            yield `        WriteProgress(new global::System.Management.Automation.ProgressRecord(1, "In progress", "Checking operation status")`;
+            yield '        WriteProgress(new global::System.Management.Automation.ProgressRecord(1, "In progress", "Checking operation status")';
             yield '        {';
             yield '            PercentComplete = now * 100 / delay';
             yield '        });';
@@ -1831,8 +1831,8 @@ export class CmdletClass extends Class {
     // If defines externalDocs for operation
     if (operation.details.default.externalDocs) {
       this.add(new Attribute(ExternalDocsAttribute, {
-        parameters: [`${new StringExpression(this.operation.details.default.externalDocs?.url ?? "")}`,
-        `${new StringExpression(this.operation.details.default.externalDocs?.description ?? "")}`]
+        parameters: [`${new StringExpression(this.operation.details.default.externalDocs?.url ?? '')}`,
+          `${new StringExpression(this.operation.details.default.externalDocs?.description ?? '')}`]
       }));
     }
 
@@ -1846,6 +1846,16 @@ export class CmdletClass extends Class {
 
       this.add(new Attribute(ProfileAttribute, { parameters: [...profileNames] }));
     }
+
+    this.operation.callGraph.forEach((operationInfo) => {
+      let apiVersion = 'null';
+      if (operationInfo.apiVersions) {
+        apiVersion = operationInfo.apiVersions[0].version;
+      }
+      operationInfo.requests?.forEach((request) => {
+        this.add(new Attribute(HttpPathAttribute, { parameters: [`Path = "${request.protocol?.http?.path}"`, `ApiVersion = "${apiVersion}"`] }));
+      });
+    });
   }
 }
 

powershell/internal/powershell-declarations.ts

@@ -48,6 +48,7 @@ export const ProfileAttribute: TypeDeclaration = new ClassType(rest, 'Profile');
 export const CategoryAttribute: TypeDeclaration = new ClassType(rest, 'Category');
 export const ExportAsAttribute: TypeDeclaration = new ClassType(rest, 'ExportAs');
 export const ParameterCategory: TypeDeclaration = new ClassType(rest, 'ParameterCategory');
+export const HttpPathAttribute: TypeDeclaration = new ClassType(rest, 'HttpPath');
 
 export function ErrorCategory(category: string): Expression {
   return new LiteralExpression(`${sma}.ErrorCategory.${category}`);