@shopify/cli-kit 3.38.0 → 3.40.0

package/assets/cli-ruby/lib/project_types/theme/commands/pull.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+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"
+require "project_types/theme/commands/common/root_helper"
+require "project_types/theme/commands/common/shop_helper"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
+
+module Theme
+  class Command
+    class Pull < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+      include Common::RootHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
+        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", Conversions::IncludeGlob) do |pattern|
+          flags[:includes] ||= []
+          flags[:includes] |= pattern
+        end
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
+          flags[:ignores] ||= []
+          flags[:ignores] |= pattern
+        end
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(_args, name)
+        root = root_value(options, name)
+        return if exist_and_not_empty?(root) && !valid_theme_directory?(root)
+
+        delete = !options.flags[:nodelete]
+        theme = find_theme(root, **options.flags)
+        return if theme.nil?
+
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(root, 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,
+          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
+            UI::SyncProgressBar.new(syncer).progress(:download_theme!, delete: delete)
+          end
+          if syncer.has_any_error?
+            @ctx.warn(@ctx.message("theme.pull.done_with_errors"))
+          else
+            @ctx.done(@ctx.message("theme.pull.done"))
+          end
+        rescue ShopifyCLI::API::APIRequestNotFoundError
+          @ctx.abort(@ctx.message("theme.pull.theme_not_found", "##{theme.id}"))
+        ensure
+          syncer.shutdown
+        end
+      end
+
+      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
+          dev_theme = ShopifyCLI::Theme::DevelopmentTheme.find(@ctx, root: root)
+          return dev_theme || @ctx.abort(@ctx.message("theme.pull.theme_not_found", "development"))
+        end
+
+        select_theme(root)
+      end
+
+      def select_theme(root)
+        form = Forms::Select.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.pull.select", shop),
+          root: root,
+        )
+        form&.theme
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/commands/push.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+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"
+require "project_types/theme/commands/common/root_helper"
+require "project_types/theme/commands/common/shop_helper"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
+
+module Theme
+  class Command
+    class Push < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+      include Common::RootHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
+        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("-s", "--stable") { flags[:stable] = true }
+        parser.on("-o", "--only=PATTERN", Conversions::IncludeGlob) do |pattern|
+          flags[:includes] ||= []
+          flags[:includes] |= pattern
+        end
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
+          flags[:ignores] ||= []
+          flags[:ignores] |= pattern
+        end
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(_args, name)
+        root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
+        delete = !options.flags[:nodelete]
+        theme = find_theme(root, **options.flags)
+        return if theme.nil?
+
+        if theme.live? && !options.flags[:allow_live]
+          question = @ctx.message("theme.push.live")
+          question += @ctx.message("theme.push.theme", theme.name, theme.id) if options.flags[:live]
+          return unless CLI::UI::Prompt.confirm(question)
+        end
+
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(root, 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,
+          include_filter: include_filter,
+          ignore_filter: ignore_filter,
+          stable: options.flags[:stable])
+        begin
+          syncer.start_threads
+          if options.flags[:json]
+            syncer.upload_theme!(delete: delete)
+          else
+            CLI::UI::Frame.open(@ctx.message("theme.push.info.pushing", theme.name, theme.id, theme.shop)) do
+              UI::SyncProgressBar.new(syncer).progress(:upload_theme!, delete: delete)
+            end
+          end
+          push_completion_handler(theme, syncer.has_any_error?)
+        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 push_completion_handler(theme, has_errors)
+        if options.flags[:json]
+          output = { theme: theme.to_h }
+          output[:warning] = @ctx.message("theme.push.with_errors") if has_errors
+
+          puts(JSON.generate(output))
+        elsif options.flags[:publish]
+          theme.publish
+          return @ctx.done(@ctx.message("theme.publish.done", theme.preview_url)) unless has_errors
+          @ctx.warn(@ctx.message("theme.publish.done_with_errors", theme.preview_url))
+        else
+          return @ctx.done(@ctx.message("theme.push.done", theme.preview_url, theme.editor_url)) unless has_errors
+          @ctx.warn(@ctx.message("theme.push.done_with_errors", theme.preview_url, theme.editor_url))
+        end
+        raise ShopifyCLI::AbortSilent if has_errors
+      end
+
+      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
+          return ShopifyCLI::Theme::DevelopmentTheme.find_or_create!(@ctx, root: root)
+        end
+
+        if unpublished
+          name = theme || ask_theme_name
+          return ShopifyCLI::Theme::Theme.create_unpublished(@ctx, root: root, name: name)
+        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", shop),
+          root: root,
+        )
+        form&.theme
+      end
+
+      def themes(root)
+        ShopifyCLI::Theme::Theme.all(@ctx, root: root)
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/commands/serve.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require "shopify_cli/theme/dev_server"
+require "project_types/theme/commands/common/root_helper"
+require "shopify_cli/theme/ignore_filter"
+require "shopify_cli/theme/include_filter"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
+
+module Theme
+  class Command
+    class Serve < ShopifyCLI::Command::SubCommand
+      include Common::RootHelper
+
+      recommend_default_ruby_range
+
+      DEFAULT_HTTP_HOST = "127.0.0.1"
+
+      options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
+        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) }
+        parser.on("-e", "--theme-editor-sync") { flags[:editor_sync] = true }
+        parser.on("--stable") { flags[:stable] = true }
+        parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
+        parser.on("-o", "--only=PATTERN", Conversions::IncludeGlob) do |pattern|
+          flags[:includes] ||= []
+          flags[:includes] |= pattern
+        end
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
+          flags[:ignores] ||= []
+          flags[:ignores] |= pattern
+        end
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(_args, name)
+        valid_authentication_method!
+
+        root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
+        flags = options.flags.dup
+        host = flags[:host] || DEFAULT_HTTP_HOST
+
+        ShopifyCLI::Theme::DevServer.start(@ctx, root, host: host, **flags) do |syncer|
+          UI::SyncProgressBar.new(syncer).progress(:upload_theme!, delay_low_priority_files: true)
+        end
+      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
+
+      private
+
+      def valid_authentication_method!
+        if exchange_token && !storefront_renderer_token
+          ShopifyCLI::Context.abort(error_message, help_message)
+        end
+      end
+
+      def error_message
+        ShopifyCLI::Context.message("theme.serve.auth.error_message", ShopifyCLI::TOOL_NAME)
+      end
+
+      def help_message
+        ShopifyCLI::Context.message("theme.serve.auth.help_message", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      def exchange_token
+        ShopifyCLI::DB.get(:shopify_exchange_token)
+      end
+
+      def storefront_renderer_token
+        ShopifyCLI::Environment.storefront_renderer_auth_token ||
+          ShopifyCLI::DB.get(:storefront_renderer_production_exchange_token)
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/commands/share.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "shopify_cli/theme/syncer"
+require "project_types/theme/commands/common/root_helper"
+
+module Theme
+  class Command
+    class Share < ShopifyCLI::Command::SubCommand
+      include Common::RootHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(_args, name)
+        root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
+        theme = create_theme(root)
+
+        upload(theme)
+
+        @ctx.done(done_message(theme))
+      end
+
+      def self.help
+        tool = ShopifyCLI::TOOL_NAME
+        @ctx.message("theme.share.help", tool, tool)
+      end
+
+      private
+
+      def create_theme(root)
+        ShopifyCLI::Theme::Theme.create_unpublished(@ctx, root: root)
+      end
+
+      def upload(theme)
+        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme)
+        syncer.start_threads
+
+        CLI::UI::Frame.open(upload_message(theme)) do
+          UI::SyncProgressBar.new(syncer).progress(:upload_theme!)
+        end
+
+        raise ShopifyCLI::AbortSilent if syncer.has_any_error?
+      ensure
+        syncer.shutdown
+      end
+
+      def upload_message(theme)
+        @ctx.message("theme.share.upload", theme.name, theme.id, theme.shop)
+      end
+
+      def done_message(theme)
+        @ctx.message("theme.share.done", theme.name, theme.preview_url, theme.editor_url)
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/conversions/base_glob.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Theme
+  module Conversions
+    class BaseGlob
+      class << self
+        def register(parser)
+          parser.accept(self) { |_val| convert(parser) }
+        end
+
+        def convert(parser)
+          argv = parser.default_argv
+          values = []
+
+          option_indexes(argv).each do |option_index|
+            values += option_values(argv, parser, option_index)
+          end
+
+          values
+        end
+
+        def options
+          raise "`#{self.class.name}#options` must be defined"
+        end
+
+        private
+
+        def option_values(argv, parser, option_index)
+          return [] if option_index.nil?
+
+          start_index = option_index + 1
+          option_by_key = options_map(parser)
+          values = []
+
+          argv[start_index..-1].each do |value|
+            return values unless option_by_key[value].nil?
+            values << value
+          end
+
+          values
+        end
+
+        def option_indexes(argv)
+          argv
+            .each_with_index
+            .select { |item, _index| options.include?(item) }
+            .map(&:last)
+        end
+
+        def options_map(parser)
+          map = {}
+          parser.top.list.each do |option|
+            map[option.short.first] = option
+            map[option.long.first] = option
+          end
+          map
+        end
+
+        def parameter?(value)
+          value.start_with?("-")
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/conversions/ignore_glob.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base_glob"
+
+module Theme
+  module Conversions
+    class IgnoreGlob < BaseGlob
+      class << self
+        def options
+          %w(-x --ignore)
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/conversions/include_glob.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base_glob"
+
+module Theme
+  module Conversions
+    class IncludeGlob < BaseGlob
+      class << self
+        def options
+          %w(-o --only)
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/forms/confirm_store.rb

@@ -0,0 +1,15 @@
+module Theme
+  module Forms
+    class ConfirmStore < ShopifyCLI::Form
+      flag_arguments :title, :force
+
+      def ask
+        @confirmed = force || CLI::UI::Prompt.confirm(title, default: false)
+      end
+
+      def confirmed?
+        @confirmed
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/theme/forms/select.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "project_types/theme/presenters/themes_presenter"
+
+module Theme
+  module Forms
+    class Select < ShopifyCLI::Form
+      attr_accessor :theme
+      flag_arguments :root, :title, :exclude_roles, :include_foreign_developments, :cmd
+
+      def ask
+        self.theme = CLI::UI::Prompt.ask(title, allow_empty: false) do |handler|
+          theme_presenters.each do |presenter|
+            theme = presenter.theme
+
+            next if exclude_roles&.include?(theme.role)
+            next if !include_foreign_developments && theme.foreign_development?
+
+            handler.option(presenter.to_s(:short)) { theme }
+          end
+          if handler.options.empty? && cmd
+            @ctx.abort(@ctx.message("theme.#{cmd}.no_themes_error"), @ctx.message("theme.#{cmd}.no_themes_resolution"))
+          end
+        end
+      end
+
+      private
+
+      def theme_presenters
+        Theme::Presenters::ThemesPresenter.new(ctx, root).all
+      end
+    end
+  end
+end