@shopify/cli-kit 3.38.0 → 3.40.0

package/assets/cli-ruby/lib/project_types/script/loaders/project.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module Project
+      def self.load(directory:, api_key:, uuid:, api_secret:, context: ShopifyCLI::Context.new)
+        env_overrides = {
+          "SHOPIFY_API_KEY" => api_key,
+          "SHOPIFY_API_SECRET" => api_secret,
+          "UUID" => uuid,
+        }.compact
+        env_file_present = env_file_exists?(directory)
+        env = if env_file_present
+          ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)
+        else
+          ShopifyCLI::Resources::EnvFile.from_hash(env_overrides)
+        end
+
+        project = ShopifyCLI::Project.at(directory)
+        project.env = env
+        project
+      rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
+        handle_error(error, context: context)
+      end
+
+      def self.handle_error(error, context:)
+        if ShopifyCLI::Environment.interactive?
+          properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
+          missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          message = context.message("script.error.missing_env_file_variables", missing_env_variables)
+          message += context.message("script.error.missing_env_file_variables_solution", ShopifyCLI::TOOL_NAME)
+        else
+          properties_hash = { api_key: "--api-key", secret: "--api-secret" }
+          missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          message = context.message("script.error.missing_push_options_ci", missing_options)
+          message += context.message("script.error.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
+        end
+        raise ShopifyCLI::Abort, message
+      end
+
+      def self.env_file_exists?(directory)
+        File.exist?(ShopifyCLI::Resources::EnvFile.path(directory))
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/script/loaders/specification_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module SpecificationHandler
+      def self.load(project:, context:)
+        identifier = project.specification_identifier
+        Models::LazySpecificationHandler.new(identifier) do
+          specifications = Models::Specifications.new(
+            fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: context)
+          )
+
+          unless specifications.valid?(identifier)
+            context.abort(context.message("errors.unknown_type", project.specification_identifier))
+          end
+
+          specifications[identifier]
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/project_types/script/messages/messages.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Script
+  module Messages
+    MESSAGES = {
+      script: {
+        deprecated: "Script projects are no longer supported in CLI 2.0. Please upgrade to CLI 3.0.",
+      },
+    }.freeze
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Theme
+  class Project < ShopifyCLI::ProjectType
+    require Project.project_filepath("messages/messages")
+    register_messages(Theme::Messages.all)
+  end
+
+  class Command < ShopifyCLI::Command::ProjectCommand
+    subcommand :Init, "init", Project.project_filepath("commands/init")
+    subcommand :Serve, "serve", Project.project_filepath("commands/serve")
+    subcommand :Pull, "pull", Project.project_filepath("commands/pull")
+    subcommand :Push, "push", Project.project_filepath("commands/push")
+    subcommand :Delete, "delete", Project.project_filepath("commands/delete")
+    subcommand :Check, "check", Project.project_filepath("commands/check")
+    subcommand :Publish, "publish", Project.project_filepath("commands/publish")
+    subcommand :Package, "package", Project.project_filepath("commands/package")
+    subcommand :Open, "open", Project.project_filepath("commands/open")
+    subcommand :List, "list", Project.project_filepath("commands/list")
+    subcommand :Share, "share", Project.project_filepath("commands/share")
+    subcommand :LanguageServer, "language-server", Project.project_filepath("commands/language_server")
+  end
+  ShopifyCLI::Commands.register("Theme::Command", "theme")
+
+  module Forms
+    autoload :ConfirmStore, Project.project_filepath("forms/confirm_store")
+    autoload :Select, Project.project_filepath("forms/select")
+  end
+
+  module UI
+    autoload :SyncProgressBar, Project.project_filepath("ui/sync_progress_bar")
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "theme_check"
+
+module Theme
+  class Command
+    class Check < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      class Options < ShopifyCLI::Options
+        def initialize(theme_check)
+          super()
+          @theme_check = theme_check
+        end
+
+        def parse(_options_block, args)
+          @theme_check.parse(args)
+        end
+      end
+
+      def initialize(*)
+        super
+        @theme_check = ThemeCheck::Cli.new
+        self.options = Options.new(@theme_check)
+      end
+
+      def call(*)
+        @theme_check.run!
+      rescue ThemeCheck::Cli::Abort, ThemeCheck::ThemeCheckError => e
+        raise ShopifyCLI::Abort,
+          ShopifyCLI::Context.message("theme.check.error", e.full_message)
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.check.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "project_types/theme/models/specification_handlers/theme"
+
+module Theme
+  class Command
+    module Common
+      module RootHelper
+        def root_value(options, name)
+          argv = default_argv(options)
+          command_index = argv.index(name.to_s)
+
+          return "." if command_index.nil?
+
+          next_index = command_index + 1
+          option_by_key = options_map(options)
+
+          while next_index < argv.size
+            element = argv[next_index]
+            key, value = key_value_tuple(element)
+            option = option_by_key[key]
+
+            return element if option.nil?
+
+            # Skip the option argument
+            next_index += 1 if !option.arg.nil? && !value
+
+            # PATTERN arguments take precedence over the `root`
+            if option.arg =~ /PATTERN/ && !value
+              next_index += 1 while option_argument?(argv, next_index, option_by_key)
+              next
+            end
+
+            next_index += 1
+          end
+
+          "."
+        end
+
+        def valid_theme_directory?(root)
+          Theme::Models::SpecificationHandlers::Theme.new(root).valid? ||
+            current_directory_confirmed?
+        end
+
+        def exist_and_not_empty?(root)
+          Dir.exist?(root) && !Dir[File.join(root, "*")].empty?
+        end
+
+        private
+
+        def current_directory_confirmed?
+          raise "Current theme directory can't be confirmed during tests" if @ctx.testing?
+
+          Forms::ConfirmStore.ask(
+            @ctx,
+            [],
+            title: @ctx.message("theme.confirm_current_directory"),
+            force: options.flags[:force],
+          ).confirmed?
+        end
+
+        def default_argv(options)
+          options.parser.default_argv.compact
+        end
+
+        def options_map(options)
+          map = {}
+          options_list(options).each do |option|
+            map[option.short.first] = option
+            map[option.long.first] = option
+          end
+          map
+        end
+
+        def options_list(options)
+          options.parser.top.list
+        end
+
+        def option_argument?(argv, next_index, option_by_key)
+          return false unless next_index < argv.size
+
+          element = argv[next_index]
+          key, _value = key_value_tuple(element)
+          option_by_key[key].nil?
+        end
+
+        def key_value_tuple(element)
+          element.split("=")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Theme
+  class Command
+    module Common
+      module ShopHelper
+        def shop
+          ShopifyCLI::Theme::ThemeAdminAPI.new(@ctx).get_shop_or_abort
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "shopify_cli/theme/theme"
+require "shopify_cli/theme/development_theme"
+require "project_types/theme/commands/common/shop_helper"
+
+module Theme
+  class Command
+    class Delete < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        parser.on("-d", "--development") { flags[:development] = true }
+        parser.on("-a", "--show-all") { flags[:show_all] = true }
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(args, _name)
+        themes = if options.flags[:development]
+          [ShopifyCLI::Theme::DevelopmentTheme.new(@ctx)]
+        elsif args.any?
+          args.map { |id| ShopifyCLI::Theme::Theme.new(@ctx, id: id) }
+        else
+          form = Forms::Select.ask(
+            @ctx,
+            [],
+            title: @ctx.message("theme.delete.select", shop),
+            exclude_roles: ["live"],
+            include_foreign_developments: options.flags[:show_all],
+            cmd: :delete
+          )
+          return unless form
+          [form.theme]
+        end
+
+        deleted = 0
+        themes.each do |theme|
+          if theme.live?
+            @ctx.puts(@ctx.message("theme.delete.live", theme.id))
+            next
+          elsif !confirm?(theme)
+            next
+          end
+          theme.delete
+          deleted += 1
+        rescue ShopifyCLI::API::APIRequestNotFoundError
+          @ctx.puts(@ctx.message("theme.delete.not_found", theme.id))
+        end
+
+        @ctx.done(@ctx.message("theme.delete.done", deleted))
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.delete.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def confirm?(theme)
+        Forms::ConfirmStore.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.delete.confirm", theme.name, theme.shop),
+          force: options.flags[:force],
+        ).confirmed?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Theme
+  class Command
+    class Init < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        parser.on("-u", "--clone-url URL") { |url| flags[:clone_url] = url }
+      end
+
+      prerequisite_task :ensure_git_dependency
+
+      DEFAULT_CLONE_URL = "https://github.com/Shopify/dawn.git"
+
+      def call(args, _name)
+        name = args.first || ask_name
+        clone_url = options.flags[:clone_url] || DEFAULT_CLONE_URL
+        clone(clone_url, name)
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.init.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def ask_name
+        CLI::UI::Prompt.ask(@ctx.message("theme.init.ask_name"))
+      end
+
+      def clone(url, name)
+        ShopifyCLI::Git.clone(url, name)
+
+        @ctx.root = File.join(@ctx.root, name)
+
+        begin
+          @ctx.rm_r(".git")
+          @ctx.rm_r(".github")
+        rescue Errno::ENOENT => e
+          @ctx.debug(e)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require "theme_check"
+
+module Theme
+  class Command
+    class LanguageServer < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      def call(*)
+        ThemeCheck::LanguageServer.start
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.language_server.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "project_types/theme/presenters/themes_presenter"
+require "project_types/theme/commands/common/shop_helper"
+
+module Theme
+  class Command
+    class List < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+
+      recommend_default_ruby_range
+
+      def call(_args, _name)
+        @ctx.puts(@ctx.message("theme.list.title", shop))
+
+        themes_presenter.all.each do |theme|
+          @ctx.puts("  #{theme}")
+        end
+      end
+
+      def self.help
+        @ctx.message("theme.list.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def themes_presenter
+        Theme::Presenters::ThemesPresenter.new(@ctx, nil)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "shopify_cli/theme/development_theme"
+require "project_types/theme/commands/common/shop_helper"
+
+module Theme
+  class Command
+    class Open < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        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("-e", "--editor") { flags[:editor] = true }
+      end
+
+      def call(_args, _name)
+        theme = find_theme(**options.flags)
+
+        @ctx.puts(@ctx.message("theme.open.details", theme.name, theme.preview_url, theme.editor_url))
+        if options.flags[:editor]
+          @ctx.open_browser_url!(theme.editor_url)
+        else
+          @ctx.open_browser_url!(theme.preview_url)
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.open.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      def find_theme(theme: nil, live: nil, development: nil, **_args)
+        return theme_by_identifier(theme) if theme
+        return live_theme if live
+        return development_theme if development
+
+        select_theme
+      end
+
+      def theme_by_identifier(identifier)
+        theme = ShopifyCLI::Theme::Theme.find_by_identifier(@ctx, identifier: identifier)
+        theme || not_found_error(identifier)
+      end
+
+      def development_theme
+        theme = ShopifyCLI::Theme::DevelopmentTheme.find(@ctx)
+        theme || not_found_error("development")
+      end
+
+      def live_theme
+        ShopifyCLI::Theme::Theme.live(@ctx)
+      end
+
+      def not_found_error(identifier)
+        @ctx.abort(@ctx.message("theme.open.theme_not_found", identifier))
+      end
+
+      def select_theme
+        form = Forms::Select.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.open.select", shop),
+          root: nil
+        )
+        form&.theme
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require "pathname"
+require "json"
+
+module Theme
+  class Command
+    class Package < ShopifyCLI::Command::SubCommand
+      recommend_default_ruby_range
+
+      THEME_DIRECTORIES = %w[
+        assets
+        config
+        layout
+        locales
+        sections
+        snippets
+        templates
+        release-notes.md
+      ]
+
+      ZIP = "zip"
+      SEVEN_ZIP = "7z"
+
+      def call(args, _name)
+        path = args.first || "."
+
+        check_prereq_command
+        zip_name = theme_name(path) + ".zip"
+
+        zip(zip_name, path, THEME_DIRECTORIES)
+        @ctx.done(@ctx.message("theme.package.done", zip_name))
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.package.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def check_prereq_command
+        @ctx.abort(@ctx.message("theme.package.error.prereq_command_required")) if command.nil?
+      end
+
+      def zip(zip_name, path, files)
+        @ctx.system(command, command_flags, zip_name, *files, chdir: path)
+      end
+
+      def theme_name(path)
+        settings_schema = Pathname.new(path).join("config/settings_schema.json")
+        @ctx.abort(@ctx.message("theme.package.error.missing_config")) unless settings_schema.file?
+
+        content = settings_schema.read
+        theme_info = JSON.parse(content).find { |section| section["name"] == "theme_info" }
+        theme_name = theme_info&.dig("theme_name")
+        @ctx.abort(@ctx.message("theme.package.error.missing_theme_name")) unless theme_name
+
+        [theme_name, theme_info["theme_version"]].compact.join("-")
+      end
+
+      def command
+        @command ||= if @ctx.which(ZIP)
+          ZIP
+        elsif @ctx.which(SEVEN_ZIP)
+          SEVEN_ZIP
+        end
+      end
+
+      def command_flags
+        @command_flags ||= command == ZIP ? "-r" : "a"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "shopify_cli/theme/theme"
+require "project_types/theme/commands/common/shop_helper"
+
+module Theme
+  class Command
+    class Publish < ShopifyCLI::Command::SubCommand
+      include Common::ShopHelper
+
+      recommend_default_ruby_range
+
+      options do |parser, flags|
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
+      def call(args, *)
+        theme = if (theme_id = args.first)
+          ShopifyCLI::Theme::Theme.new(@ctx, id: theme_id)
+        else
+          form = Forms::Select.ask(
+            @ctx,
+            [],
+            title: @ctx.message("theme.publish.select", shop),
+            exclude_roles: ["live", "development", "demo"],
+            cmd: :publish
+          )
+          return unless form
+          form.theme
+        end
+
+        return unless Forms::ConfirmStore.ask(
+          @ctx,
+          [],
+          title: @ctx.message("theme.publish.confirm", theme.name, theme.shop),
+          force: options.flags[:force],
+        ).confirmed?
+
+        theme.publish
+        @ctx.done(@ctx.message("theme.publish.done", theme.preview_url))
+      rescue ShopifyCLI::API::APIRequestNotFoundError
+        @ctx.puts(@ctx.message("theme.publish.not_found", theme.id))
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("theme.publish.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end