shopify-cli 2.12.0 → 2.13.0

data/lib/project_types/script/layers/infrastructure/languages/typescript_project_creator.rb

@@ -5,10 +5,6 @@ module Script
     module Infrastructure
       module Languages
         class TypeScriptProjectCreator < ProjectCreator
-          def self.config_file
-            "package.json"
-          end
-
           def setup_dependencies
             task_runner = Infrastructure::Languages::TypeScriptTaskRunner.new(ctx)
             task_runner.set_npm_config
@@ -22,6 +18,25 @@ module Script
             if ctx.file_exist?("package-lock.json")
               ctx.rm("package-lock.json")
             end
+
+            update_package_json_name
+          end
+
+          private
+
+          def update_package_json_name
+            file_content = ctx.read("package.json")
+            hash = file_content_to_hash(file_content)
+            hash["name"] = project_name
+            ctx.write("package.json", hash_to_file_content(hash))
+          end
+
+          def file_content_to_hash(content)
+            JSON.parse(content)
+          end
+
+          def hash_to_file_content(hash)
+            JSON.pretty_generate(hash)
           end
         end
       end

data/lib/project_types/script/layers/infrastructure/languages/wasm_project_creator.rb

@@ -5,9 +5,6 @@ module Script
     module Infrastructure
       module Languages
         class WasmProjectCreator < ProjectCreator
-          def self.config_file
-            "script.config.yml"
-          end
         end
       end
     end

data/lib/project_types/script/layers/infrastructure/push_package_repository.rb

@@ -15,6 +15,8 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
+            title: script_project.title,
+            description: script_project.description,
             script_content: script_content,
             metadata: metadata,
             script_config: script_project.script_config,
@@ -31,6 +33,8 @@ module Script
             id: build_file_path,
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
+            title: script_project.title,
+            description: script_project.description,
             script_content: script_content,
             metadata: metadata,
             script_config: script_project.script_config,

data/lib/project_types/script/layers/infrastructure/script_project_repository.rb

@@ -27,7 +27,7 @@ module Script
           change_directory(directory: initial_directory)
         end
 
-        def create(script_name:, extension_point_type:, language:)
+        def create(title:, extension_point_type:, language:)
           validate_metadata!(extension_point_type, language)
 
           ShopifyCLI::Project.write(
@@ -35,7 +35,8 @@ module Script
             project_type: :script,
             organization_id: nil,
             extension_point_type: extension_point_type,
-            script_name: script_name,
+            title: title,
+            description: nil,
             language: language
           )
 
@@ -48,7 +49,8 @@ module Script
           Domain::ScriptProject.new(
             id: project.directory,
             env: project.env,
-            script_name: script_name,
+            title: title,
+            description: description,
             extension_point_type: extension_point_type,
             language: language,
             script_config: script_config_repository.get!,
@@ -79,11 +81,6 @@ module Script
           build_script_project
         end
 
-        def update_script_config(title:)
-          script_config = script_config_repository.update!(title: title)
-          build_script_project(script_config: script_config)
-        end
-
         private
 
         def build_script_project(
@@ -92,7 +89,8 @@ module Script
           Domain::ScriptProject.new(
             id: ctx.root,
             env: project.env,
-            script_name: script_name,
+            title: title,
+            description: description,
             extension_point_type: extension_point_type,
             language: language,
             script_config: script_config,
@@ -111,8 +109,12 @@ module Script
           project_config_value!("extension_point_type")
         end
 
-        def script_name
-          project_config_value!("script_name")
+        def title
+          project_config_value!("title")
+        end
+
+        def description
+          project_config_value("description")
         end
 
         def language
@@ -181,26 +183,12 @@ module Script
             from_h(hash)
           end
 
-          def update!(title:)
-            hash = get!.content
-            update_hash(hash: hash, title: title)
-
-            ctx.write(filename, hash_to_file_content(hash))
-
-            from_h(hash)
-          end
-
           def filename
             raise NotImplementedError
           end
 
           private
 
-          def update_hash(hash:, title:)
-            hash["version"] ||= "2"
-            hash["title"] = title
-          end
-
           def from_h(hash)
             Domain::ScriptConfig.new(content: hash, filename: filename)
           end

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -15,6 +15,8 @@ module Script
         def set_app_script(
           uuid:,
           extension_point_type:,
+          title:,
+          description:,
           force: false,
           metadata:,
           script_config:,
@@ -26,8 +28,8 @@ module Script
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
-            title: script_config.title,
-            description: script_config.description,
+            title: title,
+            description: description,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value

data/lib/project_types/script/messages/messages.rb

@@ -24,11 +24,11 @@ module Script
           oauth_help: "Wait a few minutes and try again.",
 
           invalid_context_cause: "Your .shopify-cli.yml is formatted incorrectly. It's missing values for "\
-                                 "extension_point_type or script_name.",
+                                 "extension_point_type or title.",
           invalid_context_help: "Add these values.",
 
-          invalid_script_name_cause: "Script name contains unsupported characters.",
-          invalid_script_name_help: "Use only numbers, letters, hyphens, or underscores.",
+          invalid_script_title_cause: "Script title contains unsupported characters.",
+          invalid_script_title_help: "Use only numbers, letters, hyphens, or underscores.",
 
           no_existing_apps_cause: "Your script can't be pushed to an app because your Partner account "\
                                   "doesn't have any apps.",
@@ -37,8 +37,8 @@ module Script
           no_existing_orgs_cause: "Your account doesn't belong to a Partner Organization.",
           no_existing_orgs_help: "Visit https://partners.shopify.com/ to create an account.",
 
-          project_exists_cause: "A directory with this same name already exists.",
-          project_exists_help: "Choose a different name for your script.",
+          project_exists_cause: "A directory with this same title already exists.",
+          project_exists_help: "Choose a different title for your script.",
 
           invalid_extension_cause: "The name of the Script API is incorrect: %s.",
           invalid_extension_help: "Choose a supported API: %s.",
@@ -168,7 +168,7 @@ module Script
             {{command:%1$s script create}}: Creates a script project.
               Usage: {{command:%1$s script create}}
               Options:
-                {{command:--name=NAME}} Script project name.
+                {{command:--title=TITLE}} Script project title.
                 {{command:--api=TYPE}} Script API name. Supported values: %2$s.
                 {{command:--language=LANGUAGE}} Programming language. Defaults to wasm. Supported values: %3$s.
           HELP
@@ -235,7 +235,7 @@ module Script
         forms: {
           create: {
             select_extension_point: "Which Script API do you want to use?",
-            script_name: "What do you want to name your script?",
+            script_title: "What do you want to title your script?",
           },
         },
 

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

@@ -59,10 +59,10 @@ module Script
               Script::Layers::Application::ExtensionPoints.languages(type: e.extension_point_type).join(", ")
             ),
           }
-        when Errors::InvalidScriptNameError
+        when Errors::InvalidScriptTitleError
           {
-            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_name_cause"),
-            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_name_help"),
+            cause_of_error: ShopifyCLI::Context.message("script.error.invalid_script_title_cause"),
+            help_suggestion: ShopifyCLI::Context.message("script.error.invalid_script_title_help"),
           }
         when Errors::NoExistingAppsError
           {
@@ -96,7 +96,7 @@ module Script
           {
             cause_of_error: ShopifyCLI::Context.message(
               "script.error.script_not_found_cause",
-              e.script_name,
+              e.title,
               e.extension_point_type
             ),
           }

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

@@ -8,12 +8,10 @@ module Script
       def self.spin(title, auto_debrief: false)
         exception = nil
         CLI::UI::Spinner.spin(title, auto_debrief: auto_debrief) do |*args|
-          begin
-            yield(*args)
-          rescue StandardError => e
-            exception = e
-            CLI::UI::Spinner::TASK_FAILED
-          end
+          yield(*args)
+        rescue StandardError => e
+          exception = e
+          CLI::UI::Spinner::TASK_FAILED
         end
         raise exception if exception
       end

data/lib/project_types/theme/cli.rb

@@ -14,6 +14,8 @@ module Theme
     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 :LanguageServer, "language-server", Project.project_filepath("commands/language_server")
   end
   ShopifyCLI::Commands.register("Theme::Command", "theme")

data/lib/project_types/theme/commands/common/root_helper.rb

@@ -15,15 +15,16 @@ module Theme
 
           while next_index < argv.size
             element = argv[next_index]
-            option = option_by_key[element]
+            key, value = key_value_tuple(element)
+            option = option_by_key[key]
 
             return element if option.nil?
 
             # Skip the option argument
-            next_index += 1 unless option.arg.nil?
+            next_index += 1 if !option.arg.nil? && !value
 
             # PATTERN arguments take precedence over the `root`
-            if option.arg =~ /PATTERN/
+            if option.arg =~ /PATTERN/ && !value
               next_index += 1 while option_argument?(argv, next_index, option_by_key)
               next
             end
@@ -37,7 +38,7 @@ module Theme
         private
 
         def default_argv(options)
-          options.parser.default_argv
+          options.parser.default_argv.compact
         end
 
         def options_map(options)
@@ -57,7 +58,12 @@ module Theme
           return false unless next_index < argv.size
 
           element = argv[next_index]
-          option_by_key[element].nil?
+          key, _value = key_value_tuple(element)
+          option_by_key[key].nil?
+        end
+
+        def key_value_tuple(element)
+          element.split("=")
         end
       end
     end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "project_types/theme/presenters/themes_presenter"
+
+module Theme
+  class Command
+    class List < ShopifyCLI::Command::SubCommand
+      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
+
+      def shop
+        ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "shopify_cli/theme/development_theme"
+
+module Theme
+  class Command
+    class Open < ShopifyCLI::Command::SubCommand
+      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 }
+      end
+
+      def call(_args, _name)
+        theme = find_theme(**options.flags)
+
+        @ctx.puts(@ctx.message("theme.open.details", theme.name, theme.editor_url))
+        @ctx.open_url!(theme.preview_url)
+      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"),
+          root: nil
+        )
+        form&.theme
+      end
+    end
+  end
+end

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

@@ -45,8 +45,8 @@ module Theme
         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)
+          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

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

@@ -55,8 +55,8 @@ module Theme
         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)
+          include_filter: include_filter,
+          ignore_filter: ignore_filter)
         begin
           syncer.start_threads
           if options.flags[:json]

data/lib/project_types/theme/forms/select.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "project_types/theme/presenters/themes_presenter"
+
 module Theme
   module Forms
     class Select < ShopifyCLI::Form
@@ -6,53 +10,21 @@ module Theme
 
       def ask
         self.theme = CLI::UI::Prompt.ask(title, allow_empty: false) do |handler|
-          themes.each do |theme|
+          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("#{theme.name} #{theme_tags(theme)}") { theme }
+
+            handler.option(presenter.to_s(:short)) { theme }
           end
         end
       end
 
       private
 
-      def themes
-        @themes ||= ShopifyCLI::Theme::Theme.all(@ctx, root: root)
-          .sort_by { |theme| theme_sort_order(theme) }
-      end
-
-      def theme_sort_order(theme)
-        case theme.role
-        when "live"
-          0
-        when "unpublished"
-          1
-        when "development"
-          2
-        else
-          3
-        end
-      end
-
-      def theme_tags(theme)
-        color = case theme.role
-        when "live"
-          "green"
-        when "unpublished"
-          "yellow"
-        when "development"
-          "blue"
-        else
-          "italic"
-        end
-
-        tags = ["{{#{color}:[#{theme.role}]}}"]
-
-        if theme.current_development?
-          tags << "{{cyan:[yours]}}}}"
-        end
-
-        tags.join(" ")
+      def theme_presenters
+        Theme::Presenters::ThemesPresenter.new(ctx, root).all
       end
     end
   end

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

@@ -87,7 +87,7 @@ module Theme
               {{info:View your theme:}}
               {{underline:%s}}
 
-              {{info:Customize this theme in the Online Store Editor:}}
+              {{info:Customize this theme in the Theme Editor:}}
               {{underline:%s}}
           DONE
           name: "Theme name",
@@ -130,7 +130,7 @@ module Theme
           SERVING
           customize_or_preview: <<~CUSTOMIZE_OR_PREVIEW,
 
-            Customize this theme in the Online Store Editor:
+            Customize this theme in the Theme Editor:
             {{green:%s}}
 
             Share this theme preview:
@@ -215,6 +215,35 @@ module Theme
           WARN
           theme_not_found: "Theme \"%s\" doesn't exist",
         },
+        open: {
+          select: "Select a theme to open",
+          theme_not_found: "Theme \"%s\" doesn't exist",
+          details: <<~DETAILS,
+            {{*}} {{bold:%s}}
+
+            Customize your theme in the Theme Editor:
+            {{green:%s}}
+
+          DETAILS
+          help: <<~HELP,
+            {{command:%s theme open}}: Opens the preview of your remote theme.
+
+            Usage: {{command:%s theme open}}
+
+            Options:
+              {{command:-t, --theme=NAME_OR_ID}} Theme ID or name of your theme.
+              {{command:-l, --live}}             Open your live theme.
+              {{command:-d, --development}}      Open your development theme.
+          HELP
+        },
+        list: {
+          title: "{{*}} List of {{bold:%s}} themes:",
+          help: <<~HELP,
+            {{command:%s theme list}}: Lists your remote themes.
+
+            Usage: {{command:%s theme list}}
+          HELP
+        },
       },
     }.freeze
   end

data/lib/project_types/theme/presenters/theme_presenter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Theme
+  module Presenters
+    class ThemePresenter
+      extend Forwardable
+
+      COLOR_BY_ROLE = {
+        "live" => "green",
+        "unpublished" => "yellow",
+        "development" => "blue",
+      }
+
+      attr_reader :theme
+
+      def_delegators :theme, :id, :name, :role
+
+      def initialize(theme)
+        @theme = theme
+      end
+
+      def to_s(mode = :long)
+        case mode
+        when :short
+          "{{bold:#{name} #{theme_tags}}}"
+        when :long
+          "{{green:##{id}}} {{bold:#{name} #{theme_tags}}}"
+        else
+          inspect
+        end
+      end
+
+      private
+
+      def theme_tags
+        tags = ["{{#{tag_color}:[#{role}]}}"]
+        tags << "{{cyan:[yours]}}}}" if theme.current_development?
+        tags.join(" ")
+      end
+
+      def tag_color
+        COLOR_BY_ROLE[role] || "italic"
+      end
+    end
+  end
+end

data/lib/project_types/theme/presenters/themes_presenter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "theme_presenter"
+
+module Theme
+  module Presenters
+    class ThemesPresenter
+      ORDER_BY_ROLE = %w(live unpublished development)
+
+      def initialize(ctx, root)
+        @ctx = ctx
+        @root = root
+      end
+
+      def all
+        all_themes
+          .sort_by { |theme| order_by_role(theme) }
+          .map { |theme| ThemePresenter.new(theme) }
+      end
+
+      private
+
+      def order_by_role(theme)
+        ORDER_BY_ROLE.index(theme.role) || ORDER_BY_ROLE.size
+      end
+
+      def all_themes
+        ShopifyCLI::Theme::Theme.all(@ctx, root: @root)
+      end
+    end
+  end
+end

data/lib/shopify_cli/api.rb

@@ -85,7 +85,7 @@ module ShopifyCLI
         end
       rescue Errno::ETIMEDOUT, Timeout::Error
         ctx.debug("timeout in #{method} #{uri} with X-Request-Id: #{headers["X-Request-Id"]}")
-        raise APIRequestTimeoutError.new("Timeout")
+        raise APIRequestTimeoutError, "Timeout"
       end.retry_after(APIRequestRetriableError, retries: 3) do |e|
         sleep(1) if e.is_a?(APIRequestThrottledError)
       end

data/lib/shopify_cli/constants.rb

@@ -61,12 +61,12 @@ module ShopifyCLI
     module SupportedVersions
       module Ruby
         FROM = "2.6.6"
-        TO = "3.1.0"
+        TO = "3.2.0"
       end
 
       module Node
         FROM = "14.5.0"
-        TO = "17.0.0"
+        TO = "18.0.0"
       end
     end