Add listing flag to dev, push, and share commands

Author: chrisberthe

.changeset/polite-eyes-warn.md

@@ -0,0 +1,7 @@
+---
+'@shopify/cli-kit': patch
+'@shopify/theme': patch
+'@shopify/cli': patch
+---
+
+Add --listing flag to theme dev, push, and share commands

docs-shopify.dev/commands/interfaces/theme-dev.interface.ts

@@ -10,7 +10,7 @@ export interface themedev {
    * Controls the visibility of the error overlay when an theme asset upload fails:
 - silent Prevents the error overlay from appearing.
 - default Displays the error overlay.
-      
+
    * @environment SHOPIFY_FLAG_ERROR_OVERLAY
    */
   '--error-overlay <value>'?: string
@@ -27,6 +27,12 @@ export interface themedev {
    */
   '-x, --ignore <value>'?: string
 
+  /**
+   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.
+   * @environment SHOPIFY_FLAG_LISTING
+   */
+  '--listing <value>'?: string
+
   /**
    * The live reload mode switches the server behavior when a file is modified:
 - hot-reload Hot reloads local changes to CSS and sections (default)

docs-shopify.dev/commands/interfaces/theme-push.interface.ts

@@ -30,6 +30,12 @@ export interface themepush {
    */
   '-j, --json'?: ''
 
+  /**
+   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.
+   * @environment SHOPIFY_FLAG_LISTING
+   */
+  '--listing <value>'?: string
+
   /**
    * Push theme files from your remote live theme.
    * @environment SHOPIFY_FLAG_LIVE

docs-shopify.dev/commands/interfaces/theme-share.interface.ts

@@ -6,6 +6,12 @@ export interface themeshare {
    */
   '-e, --environment <value>'?: string
 
+  /**
+   * The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.
+   * @environment SHOPIFY_FLAG_LISTING
+   */
+  '--listing <value>'?: string
+
   /**
    * Disable color output.
    * @environment SHOPIFY_FLAG_NO_COLOR

docs-shopify.dev/generated/generated_docs_data.json

@@ -5115,6 +5115,15 @@
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_HOST"
               },
+              {
+                "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "--listing <value>",
+                "value": "string",
+                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
+                "isOptional": true,
+                "environmentValue": "SHOPIFY_FLAG_LISTING"
+              },
               {
                 "filePath": "docs-shopify.dev/commands/interfaces/theme-dev.interface.ts",
                 "syntaxKind": "PropertySignature",
@@ -6352,6 +6361,15 @@
             "name": "themepush",
             "description": "",
             "members": [
+              {
+                "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "--listing <value>",
+                "value": "string",
+                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
+                "isOptional": true,
+                "environmentValue": "SHOPIFY_FLAG_LISTING"
+              },
               {
                 "filePath": "docs-shopify.dev/commands/interfaces/theme-push.interface.ts",
                 "syntaxKind": "PropertySignature",
@@ -6671,6 +6689,15 @@
             "name": "themeshare",
             "description": "",
             "members": [
+              {
+                "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "--listing <value>",
+                "value": "string",
+                "description": "The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name] directory.",
+                "isOptional": true,
+                "environmentValue": "SHOPIFY_FLAG_LISTING"
+              },
               {
                 "filePath": "docs-shopify.dev/commands/interfaces/theme-share.interface.ts",
                 "syntaxKind": "PropertySignature",
@@ -6778,4 +6805,4 @@
     "category": "general commands",
     "related": []
   }
-]
+]

packages/cli-kit/src/public/node/themes/types.ts

@@ -27,8 +27,9 @@ export type ThemeFSEventPayload<T extends ThemeFSEventName = 'add'> = (ThemeFSEv
 
 export interface ThemeFileSystemOptions {
   filters?: {ignore?: string[]; only?: string[]}
-  notify?: string
+  listing?: string
   noDelete?: boolean
+  notify?: string
 }
 
 /**

packages/cli/README.md

@@ -1824,9 +1824,9 @@ Uploads the current theme as a development theme to the connected store, then pr
 
 ```
 USAGE
-  $ shopify theme dev [-e <value>] [--error-overlay silent|default] [--host <value>] [-x <value>]
-    [--live-reload hot-reload|full-page|off] [--no-color] [-n] [--notify <value>] [-o <value>] [--open] [--password
-    <value>] [--path <value>] [--port <value>] [-s <value>] [--store-password <value>] [-t <value>]
+  $ shopify theme dev [-e <value>] [--error-overlay silent|default] [--host <value>] [-x <value>] [--listing
+    <value>] [--live-reload hot-reload|full-page|off] [--no-color] [-n] [--notify <value>] [-o <value>] [--open]
+    [--password <value>] [--path <value>] [--port <value>] [-s <value>] [--store-password <value>] [-t <value>]
     [--theme-editor-sync] [--verbose]
 
 FLAGS
@@ -1860,6 +1860,10 @@ FLAGS
   --host=<value>
       Set which network interface the web server listens on. The default value is 127.0.0.1.
 
+  --listing=<value>
+      The listing preset to use for multi-preset themes. Applies preset files from listings/[preset-name]
+      directory.
+
   --live-reload=<option>
       [default: hot-reload] The live reload mode switches the server behavior when a file is modified:
       - hot-reload Hot reloads local changes to CSS and sections (default)
@@ -2246,6 +2250,8 @@ FLAGS
   -t, --theme=<value>           Theme ID or name of the remote theme.
   -u, --unpublished             Create a new unpublished theme and push to it.
   -x, --ignore=<value>...       Skip uploading the specified files (Multiple flags allowed).
+      --listing=<value>         The listing preset to use for multi-preset themes. Applies preset files from
+                                listings/[preset-name] directory.
       --no-color                Disable color output.
       --password=<value>        Password generated from the Theme Access app.
       --path=<value>            The path where you want to run the command. Defaults to the current working directory.
@@ -2326,12 +2332,15 @@ Creates a shareable, unpublished, and new theme on your theme library with a ran
 
 ```
 USAGE
-  $ shopify theme share [-e <value>] [--no-color] [--password <value>] [--path <value>] [-s <value>] [--verbose]
+  $ shopify theme share [-e <value>] [--listing <value>] [--no-color] [--password <value>] [--path <value>] [-s
+    <value>] [--verbose]
 
 FLAGS
   -e, --environment=<value>...  The environment to apply to the current command.
   -s, --store=<value>           Store URL. It can be the store prefix (example) or the full myshopify.com URL
                                 (example.myshopify.com, https://example.myshopify.com).
+      --listing=<value>         The listing preset to use for multi-preset themes. Applies preset files from
+                                listings/[preset-name] directory.
       --no-color                Disable color output.
       --password=<value>        Password generated from the Theme Access app.
       --path=<value>            The path where you want to run the command. Defaults to the current working directory.