shopify-cli 2.7.4 → 2.10.1

data/lib/project_types/script/ui/error_handler.rb

@@ -103,51 +103,65 @@ module Script
             cause_of_error: ShopifyCLI::Context.message("script.error.metadata_not_found_cause"),
             help_suggestion: ShopifyCLI::Context.message("script.error.metadata_not_found_help"),
           }
+        when Layers::Domain::Errors::MissingScriptConfigFieldError
+          {
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.missing_script_config_field_cause",
+              field: e.field,
+              filename: e.filename,
+            ),
+            help_suggestion: ShopifyCLI::Context.message("script.error.missing_script_config_field_help"),
+          }
         when Layers::Infrastructure::Errors::BuildError
           {
             cause_of_error: ShopifyCLI::Context.message("script.error.build_error_cause"),
             help_suggestion: ShopifyCLI::Context.message("script.error.build_error_help"),
           }
-        when Layers::Infrastructure::Errors::InvalidScriptConfigYmlDefinitionError
-          {
-            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_config_yml_definition_cause"),
-            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_config_yml_definition_help"),
-          }
-        when Layers::Infrastructure::Errors::InvalidScriptJsonDefinitionError
-          {
-            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_json_definition_cause"),
-            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_json_definition_help"),
-          }
-        when Layers::Infrastructure::Errors::MissingScriptConfigYmlFieldError
-          {
-            cause_of_error: ShopifyCLI::Context.message("script.error.missing_script_config_yml_field_cause", e.field),
-            help_suggestion: ShopifyCLI::Context.message("script.error.missing_script_config_yml_field_help"),
-          }
-        when Layers::Infrastructure::Errors::MissingScriptConfigYmlFieldError
+        when Layers::Infrastructure::Errors::ScriptConfigParseError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.missing_script_config_yml_field_cause", e.field),
-            help_suggestion: ShopifyCLI::Context.message("script.error.missing_script_config_yml_field_help"),
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.script_config_parse_error_cause",
+              filename: e.filename,
+              serialization_format: e.serialization_format,
+            ),
+            help_suggestion: ShopifyCLI::Context.message("script.error.script_config_parse_error_help"),
           }
-        when Layers::Infrastructure::Errors::MissingScriptJsonFieldError
+        when Layers::Infrastructure::Errors::NoScriptConfigFileError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.missing_script_json_field_cause", e.field),
-            help_suggestion: ShopifyCLI::Context.message("script.error.missing_script_json_field_help"),
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.no_script_config_file_cause",
+              filename: e.filename,
+            ),
+            help_suggestion: ShopifyCLI::Context.message("script.error.no_script_config_file_help"),
           }
-        when Layers::Infrastructure::Errors::NoScriptConfigYmlFileError
+        when Layers::Infrastructure::Errors::ScriptConfigurationDefinitionError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.no_script_config_yml_file_cause"),
-            help_suggestion: ShopifyCLI::Context.message("script.error.no_script_config_yml_file_help"),
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.configuration_definition_error_cause",
+              message: e.message,
+              filename: e.filename,
+            ),
+            help_suggestion: ShopifyCLI::Context.message("script.error.configuration_definition_error_help"),
           }
         when Layers::Infrastructure::Errors::ScriptConfigSyntaxError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.configuration_syntax_error_cause"),
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.configuration_syntax_error_cause",
+              filename: e.filename,
+            ),
             help_suggestion: ShopifyCLI::Context.message("script.error.configuration_syntax_error_help"),
           }
+        when Layers::Infrastructure::Errors::ScriptEnvAppNotConnectedError
+          {
+            cause_of_error: ShopifyCLI::Context.message("script.error.app_not_connected_cause"),
+            help_suggestion: ShopifyCLI::Context.message("script.error.app_not_connected_help"),
+          }
         when Layers::Infrastructure::Errors::ScriptConfigMissingKeysError
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.configuration_missing_keys_error_cause",
-              missing_keys: e.missing_keys
+              missing_keys: e.missing_keys,
+              filename: e.filename,
             ),
             help_suggestion: ShopifyCLI::Context.message("script.error.configuration_missing_keys_error_help"),
           }
@@ -155,7 +169,8 @@ module Script
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.configuration_invalid_value_error_cause",
-              valid_input_modes: e.valid_input_modes
+              valid_input_modes: e.valid_input_modes,
+              filename: e.filename,
             ),
             help_suggestion: ShopifyCLI::Context.message("script.error.configuration_invalid_value_error_help"),
           }
@@ -163,7 +178,8 @@ module Script
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.configuration_schema_field_missing_keys_error_cause",
-              missing_keys: e.missing_keys
+              missing_keys: e.missing_keys,
+              filename: e.filename,
             ),
             help_suggestion: ShopifyCLI::Context.message(
               "script.error.configuration_definition_schema_field_missing_keys_error_help"
@@ -173,7 +189,8 @@ module Script
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.configuration_schema_field_invalid_value_error_cause",
-              valid_types: e.valid_types
+              valid_types: e.valid_types,
+              filename: e.filename,
             ),
             help_suggestion: ShopifyCLI::Context.message(
               "script.error.configuration_schema_field_invalid_value_error_help"

data/lib/project_types/theme/commands/pull.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "shopify_cli/theme/theme"
 require "shopify_cli/theme/ignore_filter"
+require "shopify_cli/theme/include_filter"
 require "shopify_cli/theme/syncer"
 
 module Theme
@@ -9,7 +10,10 @@ module Theme
       options do |parser, flags|
         parser.on("-n", "--nodelete") { flags[:nodelete] = true }
         parser.on("-i", "--themeid=ID") { |theme_id| flags[:theme_id] = theme_id }
+        parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
         parser.on("-l", "--live") { flags[:live] = true }
+        parser.on("-d", "--development") { flags[:development] = true }
+        parser.on("-o", "--only=PATTERN") { |pattern| flags[:includes] = pattern }
         parser.on("-x", "--ignore=PATTERN") do |pattern|
           flags[:ignores] ||= []
           flags[:ignores] << pattern
@@ -19,26 +23,16 @@ module Theme
       def call(args, _name)
         root = args.first || "."
         delete = !options.flags[:nodelete]
+        theme = find_theme(root, **options.flags)
+        return if theme.nil?
 
-        theme = if (theme_id = options.flags[:theme_id])
-          ShopifyCLI::Theme::Theme.new(@ctx, root: root, id: theme_id)
-        elsif options.flags[:live]
-          ShopifyCLI::Theme::Theme.live(@ctx, root: root)
-        else
-          form = Forms::Select.ask(
-            @ctx,
-            [],
-            title: @ctx.message("theme.pull.select"),
-            root: root,
-          )
-          return unless form
-          form.theme
-        end
-
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(options.flags[:includes])
         ignore_filter = ShopifyCLI::Theme::IgnoreFilter.from_path(root)
         ignore_filter.add_patterns(options.flags[:ignores]) if options.flags[:ignores]
 
-        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme, ignore_filter: ignore_filter)
+        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme,
+                                               include_filter: include_filter,
+                                               ignore_filter: ignore_filter)
         begin
           syncer.start_threads
           CLI::UI::Frame.open(@ctx.message("theme.pull.pulling", theme.name, theme.id, theme.shop)) do
@@ -46,7 +40,7 @@ module Theme
           end
           @ctx.done(@ctx.message("theme.pull.done"))
         rescue ShopifyCLI::API::APIRequestNotFoundError
-          @ctx.abort(@ctx.message("theme.pull.theme_not_found", theme.id))
+          @ctx.abort(@ctx.message("theme.pull.theme_not_found", "##{theme.id}"))
         ensure
           syncer.shutdown
         end
@@ -55,6 +49,40 @@ module Theme
       def self.help
         ShopifyCLI::Context.message("theme.pull.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
+
+      private
+
+      def find_theme(root, theme_id: nil, theme: nil, live: nil, development: nil, **_args)
+        if theme_id
+          @ctx.warn(@ctx.message("theme.pull.deprecated_themeid"))
+          return ShopifyCLI::Theme::Theme.new(@ctx, root: root, id: theme_id)
+        end
+
+        if theme
+          selected_theme = ShopifyCLI::Theme::Theme.find_by_identifier(@ctx, root: root, identifier: theme)
+          return selected_theme || @ctx.abort(@ctx.message("theme.pull.theme_not_found", theme))
+        end
+
+        if live
+          return ShopifyCLI::Theme::Theme.live(@ctx, root: root)
+        end
+
+        if development
+          return ShopifyCLI::Theme::Theme.development(@ctx, root: root)
+        end
+
+        select_theme(root)
+      end
+
+      def select_theme(root)
+        form = Forms::Select.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.pull.select"),
+          root: root,
+        )
+        form&.theme
+      end
     end
   end
 end

data/lib/project_types/theme/commands/push.rb

@@ -2,6 +2,7 @@
 require "shopify_cli/theme/theme"
 require "shopify_cli/theme/development_theme"
 require "shopify_cli/theme/ignore_filter"
+require "shopify_cli/theme/include_filter"
 require "shopify_cli/theme/syncer"
 
 module Theme
@@ -10,12 +11,14 @@ module Theme
       options do |parser, flags|
         parser.on("-n", "--nodelete") { flags[:nodelete] = true }
         parser.on("-i", "--themeid=ID") { |theme_id| flags[:theme_id] = theme_id }
+        parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
         parser.on("-l", "--live") { flags[:live] = true }
         parser.on("-d", "--development") { flags[:development] = true }
         parser.on("-u", "--unpublished") { flags[:unpublished] = true }
         parser.on("-j", "--json") { flags[:json] = true }
         parser.on("-a", "--allow-live") { flags[:allow_live] = true }
         parser.on("-p", "--publish") { flags[:publish] = true }
+        parser.on("-o", "--only=PATTERN") { |pattern| flags[:includes] = pattern }
         parser.on("-x", "--ignore=PATTERN") do |pattern|
           flags[:ignores] ||= []
           flags[:ignores] << pattern
@@ -25,30 +28,8 @@ module Theme
       def call(args, _name)
         root = args.first || "."
         delete = !options.flags[:nodelete]
-
-        theme = if (theme_id = options.flags[:theme_id])
-          ShopifyCLI::Theme::Theme.new(@ctx, root: root, id: theme_id)
-        elsif options.flags[:live]
-          ShopifyCLI::Theme::Theme.live(@ctx, root: root)
-        elsif options.flags[:development]
-          theme = ShopifyCLI::Theme::DevelopmentTheme.new(@ctx, root: root)
-          theme.ensure_exists!
-          theme
-        elsif options.flags[:unpublished]
-          name = CLI::UI::Prompt.ask(@ctx.message("theme.push.name"), allow_empty: false)
-          theme = ShopifyCLI::Theme::Theme.new(@ctx, root: root, name: name, role: "unpublished")
-          theme.create
-          theme
-        else
-          form = Forms::Select.ask(
-            @ctx,
-            [],
-            title: @ctx.message("theme.push.select"),
-            root: root,
-          )
-          return unless form
-          form.theme
-        end
+        theme = find_theme(root, **options.flags)
+        return if theme.nil?
 
         if theme.live? && !options.flags[:allow_live]
           question = @ctx.message("theme.push.live")
@@ -56,10 +37,13 @@ module Theme
           return unless CLI::UI::Prompt.confirm(question)
         end
 
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(options.flags[:includes])
         ignore_filter = ShopifyCLI::Theme::IgnoreFilter.from_path(root)
         ignore_filter.add_patterns(options.flags[:ignores]) if options.flags[:ignores]
 
-        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme, ignore_filter: ignore_filter)
+        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme,
+                                               include_filter: include_filter,
+                                               ignore_filter: ignore_filter)
         begin
           syncer.start_threads
           if options.flags[:json]
@@ -78,16 +62,67 @@ module Theme
             end
           end
           raise ShopifyCLI::AbortSilent if syncer.has_any_error?
-        rescue ShopifyCLI::API::APIRequestNotFoundError
-          @ctx.abort(@ctx.message("theme.push.theme_not_found", theme.id))
         ensure
           syncer.shutdown
         end
+      rescue ShopifyCLI::API::APIRequestNotFoundError
+        @ctx.abort(@ctx.message("theme.push.theme_not_found", "##{theme.id}"))
       end
 
       def self.help
         ShopifyCLI::Context.message("theme.push.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
+
+      private
+
+      def find_theme(root, theme_id: nil, theme: nil, live: nil, development: nil, unpublished: nil, **_args)
+        if theme_id
+          @ctx.warn(@ctx.message("theme.push.deprecated_themeid"))
+          return ShopifyCLI::Theme::Theme.new(@ctx, root: root, id: theme_id)
+        end
+
+        if live
+          return ShopifyCLI::Theme::Theme.live(@ctx, root: root)
+        end
+
+        if development
+          new_theme = ShopifyCLI::Theme::DevelopmentTheme.new(@ctx, root: root)
+          new_theme.ensure_exists!
+          return new_theme
+        end
+
+        if unpublished
+          name = theme || ask_theme_name
+          new_theme = ShopifyCLI::Theme::Theme.new(@ctx, root: root, name: name, role: "unpublished")
+          new_theme.create
+          return new_theme
+        end
+
+        if theme
+          selected_theme = ShopifyCLI::Theme::Theme.find_by_identifier(@ctx, root: root, identifier: theme)
+          return selected_theme || @ctx.abort(@ctx.message("theme.push.theme_not_found", theme))
+        end
+
+        select_theme(root)
+      end
+
+      def ask_theme_name
+        CLI::UI::Prompt.ask(@ctx.message("theme.push.name"), allow_empty: false)
+      end
+
+      def select_theme(root)
+        form = Forms::Select.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.push.select"),
+          root: root,
+        )
+        form&.theme
+      end
+
+      def themes(root)
+        ShopifyCLI::Theme::Theme.all(@ctx, root: root)
+      end
     end
   end
 end

data/lib/project_types/theme/commands/serve.rb

@@ -10,6 +10,7 @@ module Theme
         parser.on("--host=HOST") { |host| flags[:host] = host.to_s }
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
         parser.on("--poll") { flags[:poll] = true }
+        parser.on("--live-reload=MODE") { |mode| flags[:mode] = as_reload_mode(mode) }
       end
 
       def call(*)
@@ -23,6 +24,10 @@ module Theme
           ShopifyCLI::Context.message("theme.serve.error.address_binding_error", ShopifyCLI::TOOL_NAME)
       end
 
+      def self.as_reload_mode(mode)
+        ShopifyCLI::Theme::DevServer::ReloadMode.get!(mode)
+      end
+
       def self.help
         ShopifyCLI::Context.message("theme.serve.help", ShopifyCLI::TOOL_NAME)
       end

data/lib/project_types/theme/messages/messages.rb

@@ -57,14 +57,16 @@ module Theme
               Usage: {{command:%s theme push [ ROOT ]}}
 
               Options:
-                {{command:-i, --themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
-                {{command:-l, --live}}            Push to your remote live theme, and update your live store.
-                {{command:-d, --development}}     Push to your remote development theme, and create it if needed.
-                {{command:-u, --unpublished}}     Create a new unpublished theme and push to it.
-                {{command:-n, --nodelete}}        Runs the push command without deleting remote files from Shopify.
-                {{command:-j, --json}}            Output JSON instead of a UI.
-                {{command:-a, --allow-live}}      Allow push to a live theme.
-                {{command:-p, --publish}}         Publish as the live theme after uploading.
+                {{command:-t, --theme=NAME_OR_ID}} Theme ID or name of the remote theme.
+                {{command:-l, --live}}             Push to your remote live theme, and update your live store.
+                {{command:-d, --development}}      Push to your remote development theme, and create it if needed.
+                {{command:-u, --unpublished}}      Create a new unpublished theme and push to it.
+                {{command:-n, --nodelete}}         Runs the push command without deleting remote files from Shopify.
+                {{command:-j, --json}}             Output JSON instead of a UI.
+                {{command:-a, --allow-live}}       Allow push to a live theme.
+                {{command:-p, --publish}}          Publish as the live theme after uploading.
+                {{command:-o, --only}}             Upload only the specified files.
+                {{command:-x, --ignore}}           Skip uploading the specified files.
 
               Run without options to select theme from a list.
           HELP
@@ -75,7 +77,10 @@ module Theme
           select: "Select theme to push to",
           live: "Are you sure you want to push to your live theme?",
           theme: "\n  Theme: {{blue:%s #%s}} {{green:[live]}}",
-          theme_not_found: "Theme #%s doesn't exist",
+          deprecated_themeid: <<~WARN,
+            {{warning:The {{command:-i, --themeid}} flag is deprecated. Use {{command:-t, --theme}} instead.}}
+          WARN
+          theme_not_found: "Theme \"%s\" doesn't exist",
           done: <<~DONE,
             {{green:Your theme was pushed successfully}}
 
@@ -94,10 +99,16 @@ module Theme
             Usage: {{command:%s theme serve}}
 
             Options:
-              {{command:--port=PORT}} Local port to serve theme preview from
-              {{command:--poll}}      Force polling to detect file changes
-              {{command:--host=HOST}} Set which network interface the web server listens on. The default value is 127.0.0.1.
+              {{command:--port=PORT}}        Local port to serve theme preview from.
+              {{command:--poll}}             Force polling to detect file changes.
+              {{command:--host=HOST}}        Set which network interface the web server listens on. The default value is 127.0.0.1.
+              {{command:--live-reload=MODE}} The live reload mode switches the server behavior when a file is modified:
+                                 - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
+                                 - {{command:full-page}}  Always refreshes the entire page
+                                 - {{command:off}}        Deactivate live reload
           HELP
+          reload_mode_is_not_valid: "The live reload mode `%s` is not valid.",
+          try_a_valid_reload_mode: "Try a valid live reload mode: %s.",
           viewing_theme: "Viewing theme…",
           syncing_theme: "Syncing theme #%s on %s",
           open_fail: "Couldn't open the theme",
@@ -131,9 +142,7 @@ module Theme
             You are not authorized to edit themes on %s.
             Make sure you are a user of that store, and allowed to edit themes.
           ENSURE_USER
-          already_in_use_error: "Error",
           address_already_in_use: "The address \"%s\" is already in use.",
-          try_this: "Try this",
           try_port_option: "Use the --port=PORT option to serve the theme in a different port.",
         },
         check: {
@@ -189,16 +198,22 @@ module Theme
             Usage: {{command:%s theme pull [ ROOT ]}}
 
             Options:
-              {{command:-i, --themeid=THEMEID}} The Theme ID. Must be an existing theme on your store.
-              {{command:-l, --live}}            Pull theme files from your remote live theme.
-              {{command:-n, --nodelete}}        Runs the pull command without deleting local files.
+              {{command:-t, --theme=NAME_OR_ID}} Theme ID or name of the remote theme.
+              {{command:-l, --live}}             Pull theme files from your remote live theme.
+              {{command:-d, --development}}      Pull theme files from your remote development theme.
+              {{command:-n, --nodelete}}         Runs the pull command without deleting local files.
+              {{command:-o, --only}}             Download only the specified files.
+              {{command:-x, --ignore}}           Skip downloading the specified files.
 
             Run without options to select theme from a list.
           HELP
           select: "Select a theme to pull from",
           pulling: "Pulling theme files from %s (#%s) on %s",
           done: "Theme pulled successfully",
-          not_found: "{{x}} Theme #%s doesn't exist",
+          deprecated_themeid: <<~WARN,
+            {{warning:The {{command:-i, --themeid}} flag is deprecated. Use {{command:-t, --theme}} instead.}}
+          WARN
+          theme_not_found: "Theme \"%s\" doesn't exist",
         },
       },
     }.freeze

data/lib/shopify_cli/commands/login.rb

@@ -7,7 +7,7 @@ module ShopifyCLI
       PERMANENT_DOMAIN_SUFFIX = /\.myshopify\.(com|io)$/
 
       options do |parser, flags|
-        parser.on("--store=STORE") { |url| flags[:shop] = url }
+        parser.on("-s", "--store=STORE") { |url| flags[:shop] = url }
         # backwards compatibility allow 'shop' for now
         parser.on("--shop=SHOP") { |url| flags[:shop] = url }
         parser.on("--password=PASSWORD") { |password| flags[:password] = password }

data/lib/shopify_cli/commands/switch.rb

@@ -4,7 +4,7 @@ module ShopifyCLI
   module Commands
     class Switch < ShopifyCLI::Command
       options do |parser, flags|
-        parser.on("--store=STORE") { |url| flags[:shop] = url }
+        parser.on("-s", "--store=STORE") { |url| flags[:shop] = url }
         # backwards compatibility allow 'shop' for now
         parser.on("--shop=SHOP") { |url| flags[:shop] = url }
       end

data/lib/shopify_cli/constants.rb

@@ -30,17 +30,22 @@ module ShopifyCLI
 
     module EnvironmentVariables
       STACKTRACE = "SHOPIFY_CLI_STACKTRACE"
+      TTY = "SHOPIFY_CLI_TTY"
 
       # When true the CLI points to a local instance of
       # the partners dashboard and identity.
       LOCAL_PARTNERS = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
 
-      # When true the CLI points to a spin instance of spin
-      SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
+      # When true the CLI points to spin instances of services
+      SPIN = "SPIN"
+      INFER_SPIN = "INFER_SPIN"
       SPIN_WORKSPACE = "SPIN_WORKSPACE"
       SPIN_NAMESPACE = "SPIN_NAMESPACE"
       SPIN_HOST = "SPIN_HOST"
 
+      # Deprecated, equivalent to using SPIN=1
+      SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
+
       # Environments
       TEST = "SHOPIFY_CLI_TEST"
       ACCEPTANCE_TEST = "SHOPIFY_CLI_ACCEPTANCE_TEST"

data/lib/shopify_cli/context.rb

@@ -44,6 +44,56 @@ module ShopifyCLI
         str = Context.messages.dig(*key_parts)
         str ? str % params : key
       end
+
+      # a wrapper around Kernel.puts to allow for easy formatting
+      #
+      # #### Parameters
+      # * `text` - a string message to output
+      def puts(*args)
+        Kernel.puts(CLI::UI.fmt(*args))
+      end
+
+      # aborts the current running command and outputs an error message:
+      # - when the `help_message` is not provided, the error message appears in
+      #   a red frame, prefixed by an ✗ icon
+      # - when the `help_message` is provided, the error message appears in a
+      #   red frame, and the help message appears in a green frame
+      #
+      # #### Parameters
+      # * `error_message` - an error message to output
+      # * `help_message` - an optional help message
+      #
+      # #### Example
+      #
+      #   ShopifyCLI::Context.abort("Execution error")
+      #   # Output:
+      #   # ┏━━ Error ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #   # ┃ ✗ Execution error
+      #   # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #
+      #   ShopifyCLI::Context.abort("Execution error", "export EXECUTION=1")
+      #   # Output:
+      #   # ┏━━ Error ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #   # ┃ Execution error
+      #   # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #   # ┏━━ Try this ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #   # ┃ export EXECUTION=1
+      #   # ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+      #
+      def abort(error_message, help_message = nil)
+        raise ShopifyCLI::Abort, "{{x}} #{error_message}" if help_message.nil?
+
+        frame(message("core.error"), color: :red) { self.puts(error_message) }
+        frame(message("core.try_this"), color: :green) { self.puts(help_message) }
+
+        raise ShopifyCLI::AbortSilent
+      end
+
+      private
+
+      def frame(title, color:, &block)
+        CLI::UI::Frame.open(title, color: CLI::UI.resolve_color(color), timing: false, &block)
+      end
     end
 
     # is the directory root that the current command is running in. If you want to
@@ -61,14 +111,19 @@ module ShopifyCLI
     # will return which operating system that the cli is running on [:mac, :linux]
     def os
       host = uname
-      return :mac_m1 if /arm64-apple-darwin/i.match(host)
+      return :mac_m1 if /arm64.*darwin/i.match(host)
       return :mac if /darwin/i.match(host)
       return :windows if /mswin|mingw|cygwin/i.match(host)
       return :linux if /linux|bsd/i.match(host)
       :unknown
     end
 
-    # will return true if the cli is running on an apple computer.
+    # will return true if the cli is running on an ARM Apple computer.
+    def mac_m1?
+      os == :mac_m1
+    end
+
+    # will return true if the cli is running on a Intel x86 Apple computer.
     def mac?
       os == :mac
     end
@@ -90,7 +145,7 @@ module ShopifyCLI
 
     # will return true if being launched from a tty
     def tty?
-      !testing? && $stdin.tty?
+      $stdin.tty?
     end
 
     # will return true if the cli is being run from an installation, and not a
@@ -329,7 +384,7 @@ module ShopifyCLI
           system("xdg-open", uri.to_s)
         elsif windows?
           system("start \"\" \"#{uri}\"")
-        elsif mac?
+        elsif mac? || mac_m1?
           system("open", uri.to_s)
         else
           open_url!(uri)
@@ -349,13 +404,13 @@ module ShopifyCLI
       puts "{{yellow:*}} #{text}"
     end
 
-    # a wrapper around Kernel.puts to allow for easy formatting
+    # proxy call to Context.puts.
     #
     # #### Parameters
     # * `text` - a string message to output
     #
     def puts(*args)
-      Kernel.puts(CLI::UI.fmt(*args))
+      Context.puts(*args)
     end
 
     # a wrapper around $stderr.puts to allow for easy formatting
@@ -385,14 +440,13 @@ module ShopifyCLI
       puts("{{v}} #{text}")
     end
 
-    # aborts the current running command and outputs an error message, prefixed
-    # by a red x
+    # proxy call to Context.abort.
     #
     # #### Parameters
-    # * `text` - a string message to output
-    #
-    def abort(text)
-      raise ShopifyCLI::Abort, "{{x}} #{text}"
+    # * `error_message` - an error message to output
+    # * `help_message` - an optional help message
+    def abort(error_message, help_message = nil)
+      Context.abort(error_message, help_message)
     end
 
     # outputs a message, prefixed by a red `DEBUG` tag. This will only output to

data/lib/shopify_cli/core/executor.rb

@@ -3,10 +3,10 @@ require "shopify_cli"
 module ShopifyCLI
   module Core
     class Executor < CLI::Kit::Executor
-      def initialize(ctx, task_registry, *args, **kwargs)
-        @ctx = ctx || ShopifyCLI::Context.new
-        @task_registry = task_registry || ShopifyCLI::Tasks::TaskRegistry.new
-        super(*args, **kwargs)
+      ruby2_keywords def initialize(ctx, task_registry, *args)
+        @ctx = ctx || ShopifyCli::Context.new
+        @task_registry = task_registry || ShopifyCli::Tasks::TaskRegistry.new
+        super(*args)
       end
 
       def call(command, command_name, args)