Better description, more configs in function info

Author: saga-dasgupta

.changeset/hungry-ravens-sip.md

@@ -2,4 +2,4 @@
 '@shopify/app': minor
 ---
 
-Added shopify app function info command to display function run arguments.
+Added a `function info` command to display function information.

docs-shopify.dev/commands/app-function-info.doc.ts

@@ -3,8 +3,16 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function info',
-  description: `Returns information about the function.`,
-  overviewPreviewDescription: `Get information about the function.`,
+  description: `The information returned includes the following:
+
+  - The function handle
+  - The function name
+  - The function API version
+  - The function runner path
+  - The schema path
+  - The WASM path
+  - The targeting configuration`,
+  overviewPreviewDescription: `Print basic information about your function.`,
   type: 'command',
   isVisualComponent: false,
   defaultExample: {

docs-shopify.dev/generated/generated_docs_data.json

@@ -1000,8 +1000,8 @@
   },
   {
     "name": "app function info",
-    "description": "Returns information about the function.",
-    "overviewPreviewDescription": "Get information about the function.",
+    "description": "The information returned includes the following:\n\n  - The function handle\n  - The function name\n  - The function API version\n  - The function runner path\n  - The schema path\n  - The WASM path\n  - The targeting configuration",
+    "overviewPreviewDescription": "Print basic information about your function.",
     "type": "command",
     "isVisualComponent": false,
     "defaultExample": {

packages/app/src/cli/commands/app/function/info.ts

@@ -8,9 +8,19 @@ import {outputContent, outputResult, outputToken} from '@shopify/cli-kit/node/ou
 import {renderInfo} from '@shopify/cli-kit/node/ui'
 
 export default class FunctionInfo extends AppUnlinkedCommand {
-  static summary = 'Get information about the function.'
+  static summary = 'Print basic information about your function.'
 
-  static description = 'Returns information about the function.'
+  static descriptionWithMarkdown = `The information returned includes the following:
+
+  - The function handle
+  - The function name
+  - The function API version
+  - The function runner path
+  - The schema path
+  - The WASM path
+  - The targeting configuration`
+
+  static description = this.descriptionWithoutMarkdown()
 
   static flags = {
     ...globalFlags,
@@ -53,32 +63,47 @@ export default class FunctionInfo extends AppUnlinkedCommand {
       outputResult(
         JSON.stringify(
           {
+            handle: ourFunction.configuration.handle,
+            name: ourFunction.name,
+            apiVersion: ourFunction.configuration.api_version,
             functionRunnerPath: functionRunner.path,
-            targeting,
             schemaPath,
             wasmPath: ourFunction.outputPath,
+            targeting,
           },
           null,
           2,
         ),
       )
     } else {
       const sections: {title: string; body: {list: {items: string[]}}}[] = [
+        {
+          title: 'CONFIGURATION',
+          body: {
+            list: {
+              items: [
+                outputContent`Handle: ${ourFunction.configuration.handle ?? 'N/A'}`.value,
+                outputContent`Name: ${ourFunction.name ?? 'N/A'}`.value,
+                outputContent`API Version: ${ourFunction.configuration.api_version ?? 'N/A'}`.value,
+              ],
+            },
+          },
+        },
         {
           title: 'FUNCTION RUNNER',
           body: {
             list: {
-              items: [outputContent`Path: ${outputToken.path(functionRunner.path)}`.value],
+              items: [outputContent`Path: ${functionRunner.path}`.value],
             },
           },
         },
         {
-          title: 'FUNCTION BUILD',
+          title: 'BUILD',
           body: {
             list: {
               items: [
                 outputContent`Schema Path: ${outputToken.path(schemaPath ?? 'N/A')}`.value,
-                outputContent`WASM Path: ${outputToken.path(ourFunction.outputPath)}`.value,
+                outputContent`Wasm Path: ${outputToken.path(ourFunction.outputPath)}`.value,
               ],
             },
           },
@@ -108,7 +133,6 @@ export default class FunctionInfo extends AppUnlinkedCommand {
       }
 
       renderInfo({
-        headline: 'FUNCTION INFORMATION.',
         customSections: sections,
       })
     }

packages/cli/README.md

@@ -349,7 +349,7 @@ DESCRIPTION
 
 ## `shopify app function info`
 
-Get information about the function.
+Print basic information about your function.
 
 ```
 USAGE
@@ -366,9 +366,17 @@ FLAGS
       --verbose            Increase the verbosity of the output.
 
 DESCRIPTION
-  Get information about the function.
+  Print basic information about your function.
 
-  Returns information about the function.
+  The information returned includes the following:
+
+  - The function handle
+  - The function name
+  - The function API version
+  - The function runner path
+  - The schema path
+  - The WASM path
+  - The targeting configuration
 ```
 
 ## `shopify app function replay`

packages/cli/oclif.manifest.json

@@ -893,7 +893,8 @@
       "args": {
       },
       "customPluginName": "@shopify/app",
-      "description": "Returns information about the function.",
+      "description": "The information returned includes the following:\n\n  - The function handle\n  - The function name\n  - The function API version\n  - The function runner path\n  - The schema path\n  - The WASM path\n  - The targeting configuration",
+      "descriptionWithMarkdown": "The information returned includes the following:\n\n  - The function handle\n  - The function name\n  - The function API version\n  - The function runner path\n  - The schema path\n  - The WASM path\n  - The targeting configuration",
       "flags": {
         "client-id": {
           "description": "The Client ID of your app.",
@@ -972,7 +973,7 @@
       "pluginName": "@shopify/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Get information about the function."
+      "summary": "Print basic information about your function."
     },
     "app:function:replay": {
       "aliases": [