Use third-person verb forms in command help

.changeset/tidy-command-help.md

@@ -0,0 +1,4 @@
+---
+'@shopify/cli': patch
+---
+Use third-person verb forms in command help summaries and opening descriptions.

packages/app/src/cli/commands/app/app-logs/sources.ts

@@ -7,7 +7,7 @@ import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-l
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class Sources extends AppLinkedCommand {
-  static summary = 'Print out a list of sources that may be used with the logs command.'
+  static summary = 'Prints out a list of sources that may be used with the logs command.'
 
   static descriptionWithMarkdown = `The output source names can be used with the \`--source\` argument of \`shopify app logs\` to filter log output. Currently only function extensions are supported as sources.`
 

packages/app/src/cli/commands/app/build.ts

@@ -10,7 +10,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 
 export default class Build extends AppUnlinkedCommand {
-  static summary = 'Build the app, including extensions.'
+  static summary = 'Builds the app, including extensions.'
 
   static descriptionWithMarkdown = `This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to [App configuration](https://shopify.dev/docs/apps/tools/cli/configuration).
 

packages/app/src/cli/commands/app/bulk/cancel.ts

@@ -11,7 +11,7 @@ import {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operation
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 
 export default class BulkCancel extends AppLinkedCommand {
-  static summary = 'Cancel a bulk operation.'
+  static summary = 'Cancels a bulk operation.'
 
   static descriptionWithMarkdown = 'Cancels a running bulk operation by ID.'
 

packages/app/src/cli/commands/app/bulk/execute.ts

@@ -8,7 +8,7 @@ import {prepareExecuteContext} from '../../../utilities/execute-command-helpers.
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class BulkExecute extends AppLinkedCommand {
-  static summary = 'Execute bulk operations.'
+  static summary = 'Executes bulk operations.'
 
   static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.
 

packages/app/src/cli/commands/app/bulk/status.ts

@@ -11,9 +11,9 @@ import {normalizeBulkOperationId} from '@shopify/cli-kit/node/api/bulk-operation
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 
 export default class BulkStatus extends AppLinkedCommand {
-  static summary = 'Check the status of bulk operations.'
+  static summary = 'Checks the status of bulk operations.'
 
-  static descriptionWithMarkdown = `Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.
+  static descriptionWithMarkdown = `Checks the status of a specific bulk operation by ID, or lists all bulk operations belonging to this app on this store in the last 7 days.
 
   Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).
 

packages/app/src/cli/commands/app/config/link.ts

@@ -7,7 +7,7 @@ import {globalFlags, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli'
 import {AbortError} from '@shopify/cli-kit/node/error'
 
 export default class ConfigLink extends AppLinkedCommand {
-  static summary = 'Fetch your app configuration from the Developer Dashboard.'
+  static summary = 'Fetches your app configuration from the Developer Dashboard.'
 
   static descriptionWithMarkdown = `Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.
 

packages/app/src/cli/commands/app/config/pull.ts

@@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {basename} from '@shopify/cli-kit/node/path'
 
 export default class ConfigPull extends AppLinkedCommand {
-  static summary = 'Refresh an already-linked app configuration without prompts.'
+  static summary = 'Refreshes an already-linked app configuration without prompts.'
 
   static descriptionWithMarkdown = `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.
 

packages/app/src/cli/commands/app/config/use.ts

@@ -11,7 +11,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 const {config, ...appFlagsWithoutConfig} = appFlags
 
 export default class ConfigUse extends AppUnlinkedCommand {
-  static summary = 'Activate an app configuration.'
+  static summary = 'Activates an app configuration.'
 
   static descriptionWithMarkdown = `Sets default configuration when you run app-related CLI commands. If you omit the \`config-name\` parameter, then you'll be prompted to choose from the configuration files in your project.`
 

packages/app/src/cli/commands/app/config/validate.ts

@@ -21,7 +21,7 @@ async function recordValidationFailure(issueCount: number, fileCount: number) {
 }
 
 export default class Validate extends AppLinkedCommand {
-  static summary = 'Validate your app configuration and extensions.'
+  static summary = 'Validates your app configuration and extensions.'
 
   static descriptionWithMarkdown = `Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.`
 

packages/app/src/cli/commands/app/demo/watcher.ts

@@ -8,7 +8,7 @@ import {outputInfo} from '@shopify/cli-kit/node/output'
 import {endHRTimeInMs} from '@shopify/cli-kit/node/hrtime'
 
 export default class DemoWatcher extends AppLinkedCommand {
-  static summary = 'Watch and prints out changes to an app.'
+  static summary = 'Watches and prints out changes to an app.'
   static hidden = true
 
   static flags = {

packages/app/src/cli/commands/app/deploy.ts

@@ -13,7 +13,7 @@ import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command'
 
 export default class Deploy extends AppLinkedCommand {
-  static summary = 'Deploy your Shopify app.'
+  static summary = 'Deploys your Shopify app.'
 
   static descriptionWithMarkdown = `[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.
 

packages/app/src/cli/commands/app/dev.ts

@@ -15,7 +15,7 @@ export default class Dev extends AppLinkedCommand {
     return true
   }
 
-  static summary = 'Run the app.'
+  static summary = 'Runs the app.'
 
   static descriptionWithMarkdown = `Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).`
 

packages/app/src/cli/commands/app/dev/clean.ts

@@ -12,7 +12,7 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 export default class DevClean extends AppLinkedCommand {
   static summary = 'Cleans up the dev preview from the selected store.'
 
-  static descriptionWithMarkdown = `Stop the dev preview that was started with \`shopify app dev\`.
+  static descriptionWithMarkdown = `Stops the dev preview that was started with \`shopify app dev\`.
 
   It restores the app's active version to the selected development store.
   `

packages/app/src/cli/commands/app/env/pull.ts

@@ -9,7 +9,7 @@ import {outputResult} from '@shopify/cli-kit/node/output'
 import {resolvePath} from '@shopify/cli-kit/node/path'
 
 export default class EnvPull extends AppLinkedCommand {
-  static summary = 'Pull app and extensions environment variables.'
+  static summary = 'Pulls app and extensions environment variables.'
 
   static descriptionWithMarkdown = `Creates or updates an \`.env\` files that contains app and app extension environment variables.
 

packages/app/src/cli/commands/app/env/show.ts

@@ -6,7 +6,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {outputResult} from '@shopify/cli-kit/node/output'
 
 export default class EnvShow extends AppLinkedCommand {
-  static summary = 'Display app and extensions environment variables.'
+  static summary = 'Displays app and extensions environment variables.'
 
   static descriptionWithMarkdown = `Displays environment variables that can be used to deploy apps and app extensions.`
 

packages/app/src/cli/commands/app/execute.ts

@@ -7,7 +7,7 @@ import {prepareExecuteContext} from '../../utilities/execute-command-helpers.js'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class Execute extends AppLinkedCommand {
-  static summary = 'Execute GraphQL queries and mutations.'
+  static summary = 'Executes GraphQL queries and mutations.'
 
   static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.
 

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

@@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {renderSuccess} from '@shopify/cli-kit/node/ui'
 
 export default class FunctionBuild extends AppUnlinkedCommand {
-  static summary = 'Compile a function to wasm.'
+  static summary = 'Compiles a function to wasm.'
 
   static descriptionWithMarkdown = `Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.`
 

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

@@ -9,7 +9,7 @@ import {outputResult} from '@shopify/cli-kit/node/output'
 import {AlertCustomSection, renderInfo} from '@shopify/cli-kit/node/ui'
 
 export default class FunctionInfo extends AppUnlinkedCommand {
-  static summary = 'Print basic information about your function.'
+  static summary = 'Prints basic information about your function.'
 
   static descriptionWithMarkdown = `The information returned includes the following:
 

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

@@ -11,7 +11,7 @@ import {outputDebug} from '@shopify/cli-kit/node/output'
 const DEFAULT_FUNCTION_EXPORT = '_start'
 
 export default class FunctionRun extends AppUnlinkedCommand {
-  static summary = 'Run a function locally for testing.'
+  static summary = 'Runs a function locally for testing.'
 
   static descriptionWithMarkdown = `Runs the function from your current directory for [testing purposes](https://shopify.dev/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](https://shopify.dev/docs/api/functions/errors).`
 

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

@@ -7,7 +7,7 @@ import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 
 export default class FetchSchema extends AppLinkedCommand {
-  static summary = 'Fetch the latest GraphQL schema for a function.'
+  static summary = 'Fetches the latest GraphQL schema for a function.'
 
   static descriptionWithMarkdown = `Generates the latest [GraphQL schema](https://shopify.dev/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.
 

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

@@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {renderSuccess} from '@shopify/cli-kit/node/ui'
 
 export default class FunctionTypegen extends AppUnlinkedCommand {
-  static summary = 'Generate GraphQL types for a function.'
+  static summary = 'Generates GraphQL types for a function.'
 
   static descriptionWithMarkdown = `Creates GraphQL types based on your [input query](https://shopify.dev/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the \`build.typegen_command\` configuration.`
 

packages/app/src/cli/commands/app/generate/extension.ts

@@ -8,7 +8,7 @@ import {Flags} from '@oclif/core'
 import {globalFlags, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli'
 
 export default class AppGenerateExtension extends AppLinkedCommand {
-  static summary = 'Generate a new app Extension.'
+  static summary = 'Generates a new app Extension.'
 
   static descriptionWithMarkdown = `Generates a new [app extension](https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions).
 

packages/app/src/cli/commands/app/graphiql.ts

@@ -7,7 +7,7 @@ import {globalFlags, portFlag} from '@shopify/cli-kit/node/cli'
 import {Flags} from '@oclif/core'
 
 export default class AppGraphiQL extends AppLinkedCommand {
-  static summary = 'Open a local GraphiQL UI for your app and store.'
+  static summary = 'Opens a local GraphiQL UI for your app and store.'
 
   static descriptionWithMarkdown = `Opens an authenticated Admin API GraphiQL UI for your app and selected store.
 

packages/app/src/cli/commands/app/import/channel-config.ts

@@ -11,7 +11,7 @@ export default class ImportChannelConfig extends AppLinkedCommand {
   // Only available to allowlisted channel partners for now
   static hidden = true
 
-  static summary = "Import your app's default channel spec as a channel_config extension."
+  static summary = "Imports your app's default channel spec as a channel_config extension."
 
   static descriptionWithMarkdown = `Imports the Shopify-authored channel spec for your app as a \`channel_config\` extension.
 

packages/app/src/cli/commands/app/import/custom-data-definitions.ts

@@ -13,9 +13,9 @@ import {renderSingleTask} from '@shopify/cli-kit/node/ui'
 import {outputContent} from '@shopify/cli-kit/node/output'
 
 export default class ImportCustomDataDefinitions extends AppLinkedCommand {
-  static summary = 'Import metafield and metaobject definitions.'
+  static summary = 'Imports metafield and metaobject definitions.'
 
-  static descriptionWithMarkdown = `Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).`
+  static descriptionWithMarkdown = `Imports metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](https://shopify.dev/docs/apps/build/custom-data/declarative-custom-data-definitions).`
 
   static get jsonOutputSchema() {
     return importCustomDataDefinitionsJsonOutputSchema

packages/app/src/cli/commands/app/import/dashboard-extensions.ts

@@ -28,7 +28,7 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {renderSuccess} from '@shopify/cli-kit/node/ui'
 
 export default class ImportDashboardExtensions extends AppLinkedCommand {
-  static descriptionWithMarkdown = 'Import dashboard-managed extensions into your app.'
+  static descriptionWithMarkdown = 'Imports dashboard-managed extensions into your app.'
 
   static get jsonOutputSchema() {
     return importDashboardExtensionsJsonOutputSchema

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

@@ -8,7 +8,7 @@ import {Flags} from '@oclif/core'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class AppInfo extends AppLinkedCommand {
-  static summary = 'Print basic information about your app and extensions.'
+  static summary = 'Prints basic information about your app and extensions.'
 
   static descriptionWithMarkdown = `The information returned includes the following:
 

packages/app/src/cli/commands/app/init.ts

@@ -25,7 +25,7 @@ export default class Init extends AppLinkedCommand {
     return true
   }
 
-  static summary?: string | undefined = 'Create a new app project'
+  static summary?: string | undefined = 'Creates a new app project'
 
   static examples = [
     '<%= config.bin %> <%= command.id %> --name my-app --organization-id 123 --template reactRouter --flavor typescript',

packages/app/src/cli/commands/app/logs.ts

@@ -9,7 +9,7 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class Logs extends AppLinkedCommand {
-  static summary = 'Stream detailed logs for your Shopify app.'
+  static summary = 'Streams detailed logs for your Shopify app.'
 
   static descriptionWithMarkdown = `
   Opens a real-time stream of detailed app logs from the selected app and store.

packages/app/src/cli/commands/app/release.ts

@@ -8,7 +8,7 @@ import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 import type {NonTTYFlagRequirement} from '@shopify/cli-kit/node/base-command'
 
 export default class Release extends AppLinkedCommand {
-  static summary = 'Release an app version.'
+  static summary = 'Releases an app version.'
 
   static usage = `app release --version <version>`
 

packages/app/src/cli/commands/app/security/check.ts

@@ -7,7 +7,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 
 export default class SecurityCheck extends BaseCommand {
   static summary =
-    'Check an app for Shopify-specific security issues and write deterministic-findings.json and agent-checks.json.'
+    'Checks an app for Shopify-specific security issues and writes deterministic-findings.json and agent-checks.json.'
 
   static descriptionWithMarkdown = `Runs an app security check locally and writes \`deterministic-findings.json\` and \`agent-checks.json\` to the results directory, \`.shopify/app-security/<results key>/\`. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`; the other \`app security\` commands take the same selection flags and find the same directory. Every run replaces both files, so it's always safe to run the check again.
 

packages/app/src/cli/commands/app/security/clean.ts

@@ -7,7 +7,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 
 export default class SecurityClean extends BaseCommand {
-  static summary = 'Remove local app security check results.'
+  static summary = 'Removes local app security check results.'
 
   static descriptionWithMarkdown = `Deletes the results directory, \`.shopify/app-security/<results key>/\`, without asking. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`. Other results directories are left alone. Prints each removed path.
 

packages/app/src/cli/commands/app/security/instructions.ts

@@ -8,7 +8,7 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {resolvePath} from '@shopify/cli-kit/node/path'
 
 export default class SecurityInstructions extends BaseCommand {
-  static summary = 'Provide app security check instructions to a coding agent.'
+  static summary = 'Provides app security check instructions to a coding agent.'
 
   static descriptionWithMarkdown = `Prints the complete workflow that a coding agent should follow to review app security check results.
 

packages/app/src/cli/commands/app/security/record.ts

@@ -6,7 +6,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 
 export default class SecurityRecord extends BaseCommand {
-  static summary = 'Record agent findings from an app security check.'
+  static summary = 'Records agent findings from an app security check.'
 
   static descriptionWithMarkdown = `Reads a coding agent's complete findings document from stdin, validates it, and replaces \`agent-findings.json\` in the results directory, \`.shopify/app-security/<results key>/\`. The results key is \`--client-id\` when you pass it, and otherwise the name of the app configuration file without \`.toml\`. \`--client-id\` is checked against your Shopify account before anything is read, so it needs you to be logged in.
 

packages/app/src/cli/commands/app/security/review.ts

@@ -6,7 +6,7 @@ import BaseCommand from '@shopify/cli-kit/node/base-command'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 
 export default class SecurityReview extends BaseCommand {
-  static summary = 'Show the combined app security check results.'
+  static summary = 'Shows the combined app security check results.'
 
   static descriptionWithMarkdown = `Combines the deterministic results (\`deterministic-findings.json\`, written by \`shopify app security check\`) with the recorded agent results (\`agent-findings.json\`, written by \`shopify app security record\`) and shows one view of every check: its findings, status and source. Both files are in the results directory, \`.shopify/app-security/<results key>/\`. \`--client-id\` is checked against your Shopify account before any results are read, so it needs you to be logged in.
 

packages/app/src/cli/commands/app/versions/list.ts

@@ -7,7 +7,7 @@ import {linkedAppContext} from '../../../services/app-context.js'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 
 export default class VersionsList extends AppLinkedCommand {
-  static summary = 'List deployed versions of your app.'
+  static summary = 'Lists deployed versions of your app.'
 
   static descriptionWithMarkdown = `Lists the deployed app versions. An app version is a snapshot of your app extensions.`
 

packages/app/src/cli/commands/app/webhook/trigger.ts

@@ -10,7 +10,7 @@ import {Flags} from '@oclif/core'
 import {globalFlags, jsonFlag, requiredIfNonInteractive} from '@shopify/cli-kit/node/cli'
 
 export default class WebhookTrigger extends AppLinkedCommand {
-  static summary = 'Trigger delivery of a sample webhook topic payload to a designated address.'
+  static summary = 'Triggers delivery of a sample webhook topic payload to a designated address.'
 
   static descriptionWithMarkdown = `
   Triggers the delivery of a sample Admin API event topic payload to a designated address.