Add client-id and reset as global flags (#4940)

### WHY are these changes introduced? Standardizes the handling of `client-id` and `reset` flags across all app commands by moving them to the shared app flags. ### WHAT is this pull request doing? - Moves `client-id` and `reset` flags to shared app flags - Updates all commands to use the shared flag implementations - Standardizes the usage of `client-id` and `reset` flags in `linkedAppContext` calls ### How to test your changes? 1. Run various app commands with `--client-id` flag 2. Run various app commands with `--reset` flag 3. Verify that both flags work consistently across all commands ### Checklist - [x] I've considered possible cross-platform impacts (Mac, Linux, Windows) - [x] I've considered possible documentation changes
Shopify · Nov 28, 2024 · f3d0396 · f3d0396
2 parents caab0fc + af36a6a
commit f3d0396
Show file tree

Hide file tree

Showing 41 changed files with 801 additions and 208 deletions.
diff --git a/docs-shopify.dev/commands/interfaces/app-build.interface.ts b/docs-shopify.dev/commands/interfaces/app-build.interface.ts
@@ -1,7 +1,7 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appbuild {
   /**
-   * Application's Client ID that will be exposed at build time.
+   * The Client ID of your app.
    * @environment SHOPIFY_FLAG_CLIENT_ID
    */
   '--client-id <value>'?: string
@@ -24,6 +24,12 @@ export interface appbuild {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Skips the installation of dependencies. Deprecated, use workspaces instead.
    * @environment SHOPIFY_FLAG_SKIP_DEPENDENCIES_INSTALLATION

diff --git a/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-link.interface.ts
@@ -24,6 +24,12 @@ export interface appconfiglink {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts b/docs-shopify.dev/commands/interfaces/app-config-use.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appconfiguse {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * Disable color output.
    * @environment SHOPIFY_FLAG_NO_COLOR
@@ -13,7 +19,7 @@ export interface appconfiguse {
   '--path <value>'?: string
 
   /**
-   * Reset current configuration.
+   * Reset all your settings.
    * @environment SHOPIFY_FLAG_RESET
    */
   '--reset'?: ''

diff --git a/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts b/docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appenvpull {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -24,6 +30,12 @@ export interface appenvpull {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts b/docs-shopify.dev/commands/interfaces/app-env-show.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appenvshow {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -18,6 +24,12 @@ export interface appenvshow {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-build.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appfunctionbuild {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -18,6 +24,12 @@ export interface appfunctionbuild {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts
@@ -1,7 +1,7 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appfunctionreplay {
   /**
-   * Application's Client ID
+   * The Client ID of your app.
    * @environment SHOPIFY_FLAG_CLIENT_ID
    */
   '--client-id <value>'?: string
@@ -36,6 +36,12 @@ export interface appfunctionreplay {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appfunctionrun {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -36,6 +42,12 @@ export interface appfunctionrun {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts
@@ -1,7 +1,7 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appfunctionschema {
   /**
-   * The Client ID to fetch the schema with.
+   * The Client ID of your app.
    * @environment SHOPIFY_FLAG_CLIENT_ID
    */
   '--client-id <value>'?: string
@@ -24,6 +24,12 @@ export interface appfunctionschema {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Output the schema to stdout instead of writing to a file.
    * @environment SHOPIFY_FLAG_STDOUT

diff --git a/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appfunctiontypegen {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -18,6 +24,12 @@ export interface appfunctiontypegen {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts b/docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts
@@ -24,6 +24,12 @@ export interface appimportextensions {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-info.interface.ts b/docs-shopify.dev/commands/interfaces/app-info.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appinfo {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -24,6 +30,12 @@ export interface appinfo {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts b/docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts
@@ -1,5 +1,11 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface applogssources {
+  /**
+   * The Client ID of your app.
+   * @environment SHOPIFY_FLAG_CLIENT_ID
+   */
+  '--client-id <value>'?: string
+
   /**
    * The name of the app configuration.
    * @environment SHOPIFY_FLAG_APP_CONFIG
@@ -18,6 +24,12 @@ export interface applogssources {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts b/docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts
@@ -1,7 +1,7 @@
 // This is an autogenerated file. Don't edit this file manually.
 export interface appversionslist {
   /**
-   * The Client ID to fetch versions for.
+   * The Client ID of your app.
    * @environment SHOPIFY_FLAG_CLIENT_ID
    */
   '--client-id <value>'?: string
@@ -30,6 +30,12 @@ export interface appversionslist {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Increase the verbosity of the output.
    * @environment SHOPIFY_FLAG_VERBOSE

diff --git a/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts b/docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts
@@ -53,6 +53,12 @@ export interface appwebhooktrigger {
    */
   '--path <value>'?: string
 
+  /**
+   * Reset all your settings.
+   * @environment SHOPIFY_FLAG_RESET
+   */
+  '--reset'?: ''
+
   /**
    * Deprecated. Please use client-secret.
    * @environment SHOPIFY_FLAG_SHARED_SECRET