shopify-cli 1.14.0 → 2.0.0

data/lib/project_types/extension/commands/create.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 module Extension
-  module Commands
+  class Command
     class Create < ShopifyCli::SubCommand
+      prerequisite_task :ensure_authenticated
+
       options do |parser, flags|
         parser.on("--name=NAME") { |name| flags[:name] = name }
         parser.on("--type=TYPE") { |type| flags[:type] = type.upcase }
         parser.on("--api-key=KEY") { |key| flags[:api_key] = key.downcase }
+        parser.on("--getting-started") { flags[:getting_started] = true }
       end
 
       def call(args, _)
-        with_create_form(args) do |form|
+        with_create_form(args) do |form, message_for_extension|
           if Dir.exist?(form.directory_name)
-            @ctx.abort(@ctx.message("create.errors.directory_exists", form.directory_name))
+            @ctx.abort(message_for_extension["create.errors.directory_exists", form.directory_name])
           end
 
-          if form.type.create(form.directory_name, @ctx)
+          if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
             ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
             ExtensionProject.write_env_file(
               context: @ctx,
@@ -24,23 +27,16 @@ module Extension
               api_secret: form.app.secret
             )
 
-            @ctx.puts(@ctx.message("create.ready_to_start", form.directory_name, form.name))
-            @ctx.puts(@ctx.message("create.learn_more", form.type.name))
+            @ctx.puts(message_for_extension["create.ready_to_start", form.directory_name, form.name])
+            @ctx.puts(message_for_extension["create.learn_more", form.type.name])
           else
-            @ctx.puts(@ctx.message("create.try_again"))
+            @ctx.puts(message_for_extension["create.try_again"])
           end
         end
       end
 
       def self.help
-        <<~HELP
-          Create a new app extension.
-            Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension}}
-            Options:
-              {{command:--type=TYPE}} The type of extension you would like to create.
-              {{command:--name=NAME}} The name of your extension (50 characters).
-              {{command:--api-key=KEY}} The API key of your app.
-        HELP
+        @ctx.message("create.help", ShopifyCli::TOOL_NAME)
       end
 
       private
@@ -49,7 +45,7 @@ module Extension
         form = Forms::Create.ask(@ctx, args, options.flags)
         return @ctx.puts(self.class.help) if form.nil?
 
-        yield form
+        yield form, form.type.method(:message_for_extension)
       end
     end
   end

data/lib/project_types/extension/commands/extension_command.rb

@@ -2,8 +2,8 @@
 require "shopify_cli"
 
 module Extension
-  module Commands
-    class ExtensionCommand < ShopifyCli::Command
+  class Command
+    class ExtensionCommand < ShopifyCli::SubCommand
       def project
         @project ||= ExtensionProject.current
       end

data/lib/project_types/extension/commands/info.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  class Command
+    class Info < ExtensionCommand
+      hidden_feature
+
+      def call(*)
+        @ctx.puts("Extension Title: #{project.title}")
+        @ctx.puts("Extension UUID: #{project.registration_uuid}")
+        @ctx.puts("Extension ID: #{project.registration_id}")
+        theme_app_extension_additional_info
+      end
+
+      def self.help
+        ShopifyCli::Context.new.message("info.help", ShopifyCli::TOOL_NAME)
+      end
+
+      private
+
+      OPENING_SCHEMA = "{%schema%}"
+      CLOSING_SCHEMA = "{%endschema%}"
+
+      def theme_app_extension_additional_info
+        if project.specification_identifier == "THEME_APP_EXTENSION" && (infos = block_infos)
+          title = to_handle(app.title)
+          uuid = project.registration_uuid
+          @ctx.puts("Block Infos \n")
+          index = 1
+          infos.each do |type, blocks_name|
+            @ctx.puts(" << #{type} >>\n")
+            blocks_name.each do |block_name|
+              @ctx.puts(" #{index}. shopify://apps/#{title}/blocks/#{block_name}/#{uuid} \n")
+              index += 1
+            end
+          end
+        end
+      end
+
+      def app
+        @app ||= Tasks::GetApp.call(context: @ctx, api_key: project.app.api_key)
+      end
+
+      def block_infos
+        block_infos = {}
+        Dir["blocks/*.liquid"].map do |filename|
+          block_name = File.basename(filename, ".liquid")
+          json_schema = block_info(filename)
+
+          next unless json_schema
+          block_type = json_schema["target"] == "section" ? "App Block" : "App Embed"
+          block_infos[block_type] ||= []
+          block_infos[block_type] << block_name
+        end
+        block_infos
+      end
+
+      def block_info(filename)
+        output = File.read(filename)
+        output = output.gsub(/\s+/, "")
+
+        if output
+          opening_index = output.index(OPENING_SCHEMA) + OPENING_SCHEMA.size
+          closing_index = output.index(CLOSING_SCHEMA) - 1
+
+          if (schema = output.slice(opening_index..closing_index))
+            json_schema = JSON.parse(schema)
+          end
+        end
+        json_schema
+      rescue JSON::ParserError
+        {}
+      end
+
+      def to_handle(s)
+        s = s.dup
+        s.downcase!
+        s.delete!("'\"()[]")
+        s.gsub!(/\W+/, "-")
+        s.gsub!(/\A-+|-+\z/, "")
+        -s
+      end
+    end
+  end
+end

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

@@ -2,13 +2,15 @@
 require "shopify_cli"
 
 module Extension
-  module Commands
+  class Command
     class Push < ExtensionCommand
+      prerequisite_task ensure_project_type: :extension
+
       TIME_DISPLAY_FORMAT = "%B %d, %Y %H:%M:%S %Z"
 
       def call(args, name)
-        Commands::Register.new(@ctx).call(args, name) unless project.registered?
-        Commands::Build.new(@ctx).call(args, name)
+        Command::Register.new(@ctx).call(args, name) unless project.registered?
+        Command::Build.new(@ctx).call(args, name) unless specification_handler.specification.options[:skip_build]
 
         CLI::UI::Frame.open(@ctx.message("push.frame_title")) do
           updated_draft_version = update_draft
@@ -17,10 +19,7 @@ module Extension
       end
 
       def self.help
-        <<~HELP
-          Push the current extension to Shopify.
-            Usage: {{command:#{ShopifyCli::TOOL_NAME} push}}
-        HELP
+        ShopifyCli::Context.new.message("push.help", ShopifyCli::TOOL_NAME)
       end
 
       private
@@ -63,6 +62,8 @@ module Extension
             extension_context: specification_handler.extension_context(@ctx)
           )
         end
+      rescue Extension::Errors::ExtensionError => e
+        @ctx.abort(e)
       end
     end
   end

data/lib/project_types/extension/commands/register.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Extension
-  module Commands
+  class Command
     class Register < ExtensionCommand
+      prerequisite_task ensure_project_type: :extension
+
       def call(_args, _command_name)
         CLI::UI::Frame.open(@ctx.message("register.frame_title")) do
           @ctx.abort(@ctx.message("register.already_registered")) if project.registered?
@@ -18,10 +20,7 @@ module Extension
       end
 
       def self.help
-        <<~HELP
-          Register your local extension to a Shopify app
-              Usage: {{command:#{ShopifyCli::TOOL_NAME} register}}
-        HELP
+        ShopifyCli::Context.new.message("register.help", ShopifyCli::TOOL_NAME)
       end
 
       private

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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Extension
-  module Commands
+  class Command
     class Serve < ExtensionCommand
+      prerequisite_task ensure_project_type: :extension
+
       DEFAULT_PORT = 39351
 
       options do |parser, flags|
@@ -12,7 +14,7 @@ module Extension
       class RuntimeConfiguration
         include SmartProperties
 
-        property! :tunnel_url, accepts: String, default: ""
+        property :tunnel_url, accepts: String, default: nil
         property! :tunnel_requested, accepts: [true, false], reader: :tunnel_requested?, default: true
         property! :port, accepts: (1...(2**16)), default: DEFAULT_PORT
       end
@@ -31,12 +33,7 @@ module Extension
       end
 
       def self.help
-        <<~HELP
-          Serve your extension in a local simulator for development.
-            Usage: {{command:#{ShopifyCli::TOOL_NAME} serve}}
-            Options:
-            {{command:--tunnel=TUNNEL}} Establish an ngrok tunnel (default: false)
-        HELP
+        ShopifyCli::Context.new.message("serve.help", ShopifyCli::TOOL_NAME)
       end
 
       private

data/lib/project_types/extension/commands/tunnel.rb

@@ -2,8 +2,10 @@
 require "shopify_cli"
 
 module Extension
-  module Commands
+  class Command
     class Tunnel < ExtensionCommand
+      prerequisite_task ensure_project_type: :extension
+
       options do |parser, flags|
         parser.on("--port=PORT") { |port| flags[:port] = port }
       end

data/lib/project_types/extension/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Extension
+  module Errors
+    class ExtensionError < StandardError; end
+    class InvalidFilenameError < ExtensionError; end
+    class BundleTooLargeError < ExtensionError; end
+  end
+end

data/lib/project_types/extension/extension_project.rb

@@ -82,6 +82,11 @@ module Extension
     private
 
     def get_extra_field(key)
+      unless env
+        Kernel.puts("Run the command inside the correct extension directory.")
+        exit
+      end
+
       extra = env[:extra] || {}
       extra[key]
     end

data/lib/project_types/extension/features/argo.rb

@@ -19,14 +19,14 @@ module Extension
       YARN_RUN_SCRIPT_NAME = %w(build).freeze
       private_constant :YARN_INSTALL_COMMAND, :YARN_INSTALL_PARAMETERS, :YARN_RUN_COMMAND, :YARN_RUN_SCRIPT_NAME
 
-      ARGO_CHECKOUT = "@shopify/argo-checkout"
-      ARGO_ADMIN = "@shopify/argo-admin"
-      ARGO_POST_PURCHASE = "@shopify/argo-post-purchase"
+      UI_EXTENSIONS_CHECKOUT = "@shopify/checkout-ui-extensions"
+      UI_EXTENSIONS_ADMIN = "@shopify/admin-ui-extensions"
+      UI_EXTENSIONS_POST_PURCHASE = "@shopify/post-purchase-ui-extensions"
 
       PACKAGE_NAMES = [
-        ARGO_CHECKOUT,
-        ARGO_ADMIN,
-        ARGO_POST_PURCHASE,
+        UI_EXTENSIONS_CHECKOUT,
+        UI_EXTENSIONS_ADMIN,
+        UI_EXTENSIONS_POST_PURCHASE,
       ].freeze
 
       def create(directory_name, identifier, context)

data/lib/project_types/extension/features/argo_runtime.rb

@@ -3,88 +3,44 @@ module Extension
     class ArgoRuntime
       include SmartProperties
 
-      ARGO_RUN_PACKAGE_NAME = "@shopify/argo-run"
-      ARGO_ADMIN_CLI_PACKAGE_NAME = "@shopify/argo-admin-cli"
-
-      ARGO_RUN_0_4_0 = Models::NpmPackage.new(name: "@shopify/argo-run", version: "0.4.0")
-      ARGO_ADMIN_CLI_0_9_0 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.9.0")
-      ARGO_ADMIN_CLI_0_9_3 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.9.3")
-      ARGO_ADMIN_CLI_0_11_0 = Models::NpmPackage.new(name: "@shopify/argo-admin-cli", version: "0.11.0")
+      UI_EXTENSIONS_CHECKOUT_RUN = "@shopify/checkout-ui-extensions-run"
+      UI_EXTENSIONS_ADMIN_RUN = "@shopify/admin-ui-extensions-run"
+
+      ADMIN_RUN_FLAGS = [
+        :api_key,
+        :name,
+        :port,
+        :public_url,
+        :renderer_version,
+        :shop,
+        :uuid,
+      ]
+
+      CHECKOUT_RUN_FLAGS = [
+        :port,
+        :public_url,
+      ]
 
       property! :renderer, accepts: Models::NpmPackage
       property! :cli, accepts: Models::NpmPackage
 
-      def accepts_port?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_11_0
-        when checkout?
-          cli >= ARGO_RUN_0_4_0
-        end
-      end
-
-      def accepts_tunnel_url?
+      def supports?(flag)
         case cli
         when admin?
-          cli >= ARGO_ADMIN_CLI_0_11_0
+          ADMIN_RUN_FLAGS.include?(flag.to_sym)
         when checkout?
-          cli >= ARGO_RUN_0_4_0
-        end
-      end
-
-      def accepts_uuid?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_11_0
-        else
-          false
-        end
-      end
-
-      def accepts_argo_version?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_9_3
-        else
-          false
-        end
-      end
-
-      def accepts_shop?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_11_0
-        else
-          false
-        end
-      end
-
-      def accepts_api_key?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_11_0
-        else
-          false
-        end
-      end
-
-      def accepts_name?
-        case cli
-        when admin?
-          cli >= ARGO_ADMIN_CLI_0_9_0
-        else
-          false
+          CHECKOUT_RUN_FLAGS.include?(flag.to_sym)
         end
       end
 
       private
 
       def admin?
-        ->(cli) { cli.name == ARGO_ADMIN_CLI_PACKAGE_NAME }
+        ->(cli) { cli.name == UI_EXTENSIONS_ADMIN_RUN }
       end
 
       def checkout?
-        ->(cli) { cli.name == ARGO_RUN_PACKAGE_NAME }
+        ->(cli) { cli.name == UI_EXTENSIONS_CHECKOUT_RUN }
       end
     end
   end

data/lib/project_types/extension/features/argo_serve.rb

@@ -3,25 +3,29 @@ module Extension
     class ArgoServe
       include SmartProperties
 
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
       property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
       property! :argo_runtime, accepts: Features::ArgoRuntime
       property! :context, accepts: ShopifyCli::Context
       property! :port, accepts: Integer, default: 39351
-      property  :tunnel_url, accepts: String, default: ""
+      property  :tunnel_url, accepts: String, default: nil
+      property! :js_system, accepts: ->(jss) { jss.respond_to?(:call) }, default: ShopifyCli::JsSystem
 
       def call
         validate_env!
 
         CLI::UI::Frame.open(context.message("serve.frame_title")) do
-          success = call_js_system(yarn_command: yarn_serve_command, npm_command: npm_serve_command)
-          context.abort(context.message("serve.serve_failure_message")) unless success
+          next if start_server
+          context.abort(context.message("serve.serve_failure_message"))
         end
       end
 
       private
 
-      def call_js_system(yarn_command:, npm_command:)
-        ShopifyCli::JsSystem.call(context, yarn: yarn_command, npm: npm_command)
+      def start_server
+        js_system.call(context, yarn: yarn_serve_command, npm: npm_serve_command)
       end
 
       def specification
@@ -36,23 +40,12 @@ module Extension
         specification.features.argo.required_fields
       end
 
-      def serve_options
-        @options ||= Features::ArgoServeOptions.new(
-          argo_runtime: argo_runtime,
-          port: port,
-          context: context,
-          required_fields: required_fields,
-          renderer_package: renderer_package,
-          public_url: tunnel_url
-        )
-      end
-
       def yarn_serve_command
-        serve_options.yarn_serve_command
+        YARN_SERVE_COMMAND + options
       end
 
       def npm_serve_command
-        serve_options.npm_serve_command
+        NPM_SERVE_COMMAND  + ["--"] + options
       end
 
       def validate_env!
@@ -72,6 +65,20 @@ module Extension
 
         context.abort(context.message("serve.serve_missing_information"))
       end
+
+      def options
+        project = ExtensionProject.current
+
+        @serve_options ||= [].tap do |options|
+          options << "--port=#{port}" if argo_runtime.supports?(:port)
+          options << "--store=#{project.env.shop}" if argo_runtime.supports?(:shop)
+          options << "--apiKey=#{project.env.api_key}" if argo_runtime.supports?(:api_key)
+          options << "--rendererVersion=#{renderer_package.version}" if argo_runtime.supports?(:renderer_version)
+          options << "--uuid=#{project.registration_uuid}" if argo_runtime.supports?(:uuid)
+          options << "--publicUrl=#{tunnel_url}" if !tunnel_url.nil? && argo_runtime.supports?(:public_url)
+          options << "--name=#{project.title}" if argo_runtime.supports?(:name)
+        end
+      end
     end
   end
 end