* Rename --stable to --legacy

* Add info banner in the new `shopify theme dev` command (mentioning the --legacy flag) * Update docs
Shopify · Sep 16, 2024 · 2b06d21 · 2b06d21
1 parent 56c5b46
commit 2b06d21
Show file tree

Hide file tree

Showing 20 changed files with 120 additions and 274 deletions.
diff --git a/.changeset/pretty-olives-promise.md b/.changeset/pretty-olives-promise.md
@@ -4,4 +4,4 @@
 '@shopify/cli': minor
 ---
 
-Default to Typescript implementation for theme commands. Legacy implementation is stil available via the `--stable` flag.
+Default to Typescript implementation for theme commands. Legacy implementation is stil available via the `--legacy` flag.
diff --git a/docs-shopify.dev/commands/interfaces/app-dev.interface.ts b/docs-shopify.dev/commands/interfaces/app-dev.interface.ts
@@ -54,12 +54,6 @@ export interface appdev {
    */
   '--skip-dependencies-installation'?: ''
 
-  /**
-   * Use the legacy Ruby implementation for managing theme app extensions.
-   * @environment SHOPIFY_FLAG_STABLE
-   */
-  '--stable'?: ''
-
   /**
    * Store URL. Must be an existing development or Shopify Plus sandbox store.
    * @environment SHOPIFY_FLAG_STORE

diff --git a/docs-shopify.dev/commands/interfaces/app-logs.interface.ts b/docs-shopify.dev/commands/interfaces/app-logs.interface.ts
@@ -42,12 +42,6 @@ export interface applogs {
    */
   '--source <value>'?: string
 
-  /**
-   * Use the legacy Ruby implementation for managing theme app extensions.
-   * @environment SHOPIFY_FLAG_STABLE
-   */
-  '--stable'?: ''
-
   /**
    * Filters output to the specified status (success or failure).
    * @environment SHOPIFY_FLAG_STATUS

diff --git a/docs-shopify.dev/commands/interfaces/theme-console.interface.ts b/docs-shopify.dev/commands/interfaces/theme-console.interface.ts
@@ -18,18 +18,6 @@ export interface themeconsole {
    */
   '--password <value>'?: string
 
-  /**
-   * Local port to serve authentication service.
-   * @environment SHOPIFY_FLAG_PORT
-   */
-  '--port <value>'?: string
-
-  /**
-   * Use the legacy Ruby implementation for the `theme console` command.
-   * @environment SHOPIFY_FLAG_STABLE
-   */
-  '--stable'?: ''
-
   /**
    * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
    * @environment SHOPIFY_FLAG_STORE

diff --git a/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts b/docs-shopify.dev/commands/interfaces/theme-dev.interface.ts
@@ -69,24 +69,12 @@ export interface themedev {
    */
   '--path <value>'?: string
 
-  /**
-   * Force polling to detect file changes.
-   * @environment SHOPIFY_FLAG_POLL
-   */
-  '--poll'?: ''
-
   /**
    * Local port to serve theme preview from.
    * @environment SHOPIFY_FLAG_PORT
    */
   '--port <value>'?: string
 
-  /**
-   * Use the legacy Ruby implementation for the `theme dev` command.
-   * @environment SHOPIFY_FLAG_STABLE
-   */
-  '--stable'?: ''
-
   /**
    * Store URL. It can be the store prefix (example) or the full myshopify.com URL (example.myshopify.com, https://example.myshopify.com).
    * @environment SHOPIFY_FLAG_STORE

diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json
diff --git a/docs-shopify.dev/generated/generated_static_pages.json b/docs-shopify.dev/generated/generated_static_pages.json
@@ -43,37 +43,6 @@
           ]
         }
       },
-      {
-        "type": "Generic",
-        "anchorLink": "requirements-themes",
-        "title": "Requirements for themes",
-        "sectionContent": "\nTo work with themes, your system must meet the following additional requirements:\n- [Ruby](https://www.ruby-lang.org/en/) version 2.7.5 or higher\n\n> Note: Theme requirements are automatically installed on macOS when you use Homebrew to install Shopify CLI.\n",
-        "codeblock": {
-          "title": "Installation requirements for themes",
-          "tabs": [
-            {
-              "title": "macOS: brew",
-              "code": "brew install ruby\n",
-              "language": "bash"
-            },
-            {
-              "title": "Windows",
-              "code": "Install Ruby+Devkit 3.0 using https://rubyinstaller.org/downloads/\n\nSelect the MSYS2 component and the MSYS2 base installation option\n",
-              "language": "bash"
-            },
-            {
-              "title": "Linux: apt",
-              "code": "\nsudo apt update && sudo apt upgrade\n\nsudo apt install curl gcc g++ make\n\nsudo apt install ruby-full\n\nsudo apt install ruby-dev\n# Ruby development environment\n\nsudo apt install git\n",
-              "language": "bash"
-            },
-            {
-              "title": "Linux: yum",
-              "code": "sudo yum install curl\n\nsudo yum group install \"Development Tools\"\n# Includes GCC, g++, and Make\n\nsudo yum install ruby\nsudo yum install ruby-devel\n# Ruby development environment\n\nsudo yum install git\n",
-              "language": "bash"
-            }
-          ]
-        }
-      },
       {
         "type": "Generic",
         "anchorLink": "commands",

diff --git a/docs-shopify.dev/static/cli.doc.ts b/docs-shopify.dev/static/cli.doc.ts
@@ -50,42 +50,6 @@ const data: LandingTemplateSchema = {
         ],
       },
     },
-    {
-      type: 'Generic',
-      anchorLink: 'requirements-themes',
-      title: 'Requirements for themes',
-      sectionContent: `
-To work with themes, your system must meet the following additional requirements:
-- [Ruby](https://www.ruby-lang.org/en/) version 2.7.5 or higher
-
-> Note: Theme requirements are automatically installed on macOS when you use Homebrew to install Shopify CLI.
-`,
-      codeblock: {
-        title: 'Installation requirements for themes',
-        tabs: [
-          {
-            title: 'macOS: brew',
-            code: 'examples/requirements.brew.example.sh',
-            language: 'bash',
-          },
-          {
-            title: 'Windows',
-            code: 'examples/requirements.win.example.sh',
-            language: 'bash',
-          },
-          {
-            title: 'Linux: apt',
-            code: 'examples/requirements.apt.example.sh',
-            language: 'bash',
-          },
-          {
-            title: 'Linux: yum',
-            code: 'examples/requirements.yum.example.sh',
-            language: 'bash',
-          },
-        ],
-      },
-    },
     {
       type: 'Generic',
       anchorLink: 'commands',

diff --git a/packages/app/src/cli/commands/app/dev.ts b/packages/app/src/cli/commands/app/dev.ts
@@ -131,9 +131,10 @@ If you're using the PHP or Ruby app template, then you need to complete the foll
         'Key used to authenticate GraphiQL requests. Should be specified if exposing GraphiQL on a publicly accessible URL. By default, no key is required.',
       env: 'SHOPIFY_FLAG_GRAPHIQL_KEY',
     }),
-    stable: Flags.boolean({
+    legacy: Flags.boolean({
+      hidden: true,
       description: 'Use the legacy Ruby implementation for managing theme app extensions.',
-      env: 'SHOPIFY_FLAG_STABLE',
+      env: 'SHOPIFY_FLAG_LEGACY',
     }),
   }
 
@@ -182,7 +183,7 @@ If you're using the PHP or Ruby app template, then you need to complete the foll
       notify: flags.notify,
       graphiqlPort: flags['graphiql-port'],
       graphiqlKey: flags['graphiql-key'],
-      devPreview: !flags.stable,
+      devPreview: !flags.legacy,
     }
 
     await dev(devOptions)

diff --git a/packages/app/src/cli/commands/app/logs.ts b/packages/app/src/cli/commands/app/logs.ts
@@ -37,7 +37,7 @@ export default class Logs extends Command {
     'no-tunnel': Dev.flags['no-tunnel'],
     'graphiql-port': Dev.flags['graphiql-port'],
     'graphiql-key': Dev.flags['graphiql-key'],
-    stable: Dev.flags.stable,
+    stable: Dev.flags.legacy,
     source: Flags.string({
       description: 'Filters output to the specified log source.',
       env: 'SHOPIFY_FLAG_SOURCE',

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -202,9 +202,9 @@ Run the app.
 ```
 USAGE
   $ shopify app dev [--checkout-cart-url <value>] [--client-id <value> | -c <value>] [--no-color]
-    [--no-update] [--notify <value>] [--path <value>] [--reset | ] [--skip-dependencies-installation] [--stable] [-s
-    <value>] [--subscription-product-url <value>] [-t <value>] [--theme-app-extension-port <value>] [--tunnel-url
-    <value> |  | ] [--verbose]
+    [--no-update] [--notify <value>] [--path <value>] [--reset | ] [--skip-dependencies-installation] [-s <value>]
+    [--subscription-product-url <value>] [-t <value>] [--theme-app-extension-port <value>] [--tunnel-url <value> |  | ]
+    [--verbose]
 
 FLAGS
   -c, --config=<value>                    The name of the app configuration.
@@ -221,7 +221,6 @@ FLAGS
       --path=<value>                      The path to your app directory.
       --reset                             Reset all your settings.
       --skip-dependencies-installation    Skips the installation of dependencies. Deprecated, use workspaces instead.
-      --stable                            Use the legacy Ruby implementation for managing theme app extensions.
       --subscription-product-url=<value>  Resource URL for subscription UI extension. Format: "/products/{productId}"
       --theme-app-extension-port=<value>  Local port of the theme app extension development server.
       --tunnel-url=<value>                Use a custom tunnel, it must be running before executing dev. Format:
@@ -548,7 +547,7 @@ Stream detailed logs for your Shopify app.
 ```
 USAGE
   $ shopify app logs [--client-id <value> | -c <value>] [-j] [--no-color] [--path <value>] [--reset | ]
-    [--source <value>] [--stable] [--status success|failure] [-s <value>] [--verbose]
+    [--source <value>] [--status success|failure] [-s <value>] [--verbose]
 
 FLAGS
   -c, --config=<value>     The name of the app configuration.
@@ -559,7 +558,6 @@ FLAGS
       --path=<value>       The path to your app directory.
       --reset              Reset all your settings.
       --source=<value>...  Filters output to the specified log source.
-      --stable             Use the legacy Ruby implementation for managing theme app extensions.
       --status=<option>    Filters output to the specified status (success or failure).
                            <options: success|failure>
       --verbose            Increase the verbosity of the output.
@@ -1712,8 +1710,6 @@ FLAGS
                                 (example.myshopify.com, https://example.myshopify.com).
       --no-color                Disable color output.
       --password=<value>        Password generated from the Theme Access app.
-      --port=<value>            Local port to serve authentication service.
-      --stable                  Use the legacy Ruby implementation for the `theme console` command.
       --store-password=<value>  The password for storefronts with password protection.
       --url=<value>             [default: /] The url to be used as context
       --verbose                 Increase the verbosity of the output.
@@ -1767,8 +1763,8 @@ Uploads the current theme as a development theme to the connected store, then pr
 ```
 USAGE
   $ shopify theme dev [-e <value>] [--host <value>] [-x <value>] [--live-reload hot-reload|full-page|off]
-    [--no-color] [-n] [--notify <value>] [-o <value>] [--open] [--password <value>] [--path <value>] [--poll] [--port
-    <value>] [--stable] [-s <value>] [--store-password <value>] [-t <value>] [--theme-editor-sync] [--verbose]
+    [--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
   -e, --environment=<value>
@@ -1817,15 +1813,9 @@ FLAGS
   --path=<value>
       The path to your theme directory.
 
-  --poll
-      Force polling to detect file changes.
-
   --port=<value>
       Local port to serve theme preview from.
 
-  --stable
-      Use the legacy Ruby implementation for the `theme dev` command.
-
   --store-password=<value>
       The password for storefronts with password protection.