shopify-cli 1.13.1 → 2.1.0

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "theme_check"
+
+module Extension
+  class Command
+    class Check < ExtensionCommand
+      class CheckOptions < ShopifyCli::Options
+        def initialize(ctx, theme_check)
+          super()
+          @theme_check = theme_check
+          @ctx = ctx
+        end
+
+        def parse(_options_block, args)
+          # Check if .theme-check.yml exists, or if another -C has been passed on the command line
+          unless args.include?("-C") || @ctx.file_exist?(".theme-check.yml")
+            args += ["-C", ":theme_app_extension"]
+          end
+          @theme_check.parse(args)
+        end
+      end
+
+      def initialize(*)
+        super
+        if project.specification_identifier == "THEME_APP_EXTENSION"
+          @theme_check = ThemeCheck::Cli.new
+          self.options = CheckOptions.new(@ctx, @theme_check)
+        end
+      end
+
+      def call(*)
+        if project.specification_identifier == "THEME_APP_EXTENSION"
+          @theme_check.run
+        else
+          @ctx.abort(@ctx.message("check.unsupported", project.specification_identifier))
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.message("check.help", ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Extension
+  class Command
+    class Connect < ExtensionCommand
+      prerequisite_task :ensure_authenticated
+
+      def call(args, _)
+        with_connect_form(args) do |form|
+          ExtensionProject.write_env_file(
+            context: @ctx,
+            api_key: form.app.api_key,
+            api_secret: form.app.secret,
+            registration_id: form.registration.id,
+            registration_uuid: form.registration.uuid,
+            title: form.registration.title
+          )
+          @ctx.done(@ctx.message("connect.connected", form.app.title, form.registration.title))
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.new.message("connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
+
+      private
+
+      def with_connect_form(args)
+        form = Forms::Connect.ask(@ctx, args, { type: specification_handler.identifier.downcase })
+        return @ctx.puts(self.class.help) if form.nil?
+
+        yield form
+      end
+    end
+  end
+end

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

@@ -15,7 +15,13 @@ module Extension
       end
 
       def write_env_file(
-        context:, title:, api_key: "", api_secret: "", registration_id: nil, registration_uuid: nil
+        context:,
+        title:,
+        api_key: "",
+        api_secret: "",
+        registration_id: nil,
+        registration_uuid: nil,
+        resource_url: nil
       )
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
@@ -24,6 +30,7 @@ module Extension
             ExtensionProjectKeys::TITLE_KEY => title,
             ExtensionProjectKeys::REGISTRATION_ID_KEY => registration_id,
             ExtensionProjectKeys::REGISTRATION_UUID_KEY => registration_uuid || generate_temporary_uuid,
+            ExtensionProjectKeys::RESOURCE_URL_KEY => resource_url,
           }.compact
         ).write(context)
 
@@ -42,6 +49,7 @@ module Extension
     end
 
     def app
+      validate_env_present
       Models::App.new(api_key: env["api_key"], secret: env["secret"])
     end
 
@@ -71,6 +79,10 @@ module Extension
       get_extra_field(ExtensionProjectKeys::REGISTRATION_UUID_KEY)
     end
 
+    def resource_url
+      get_extra_field(ExtensionProjectKeys::RESOURCE_URL_KEY)
+    end
+
     def reload
       @env = nil
     end
@@ -82,6 +94,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
@@ -91,9 +108,15 @@ module Extension
     end
 
     def property_present?(key)
+      validate_env_present
       !env[key].nil? && !env[key].strip.empty?
     end
 
+    def validate_env_present
+      return if env
+      raise ShopifyCli::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
+    end
+
     def integer?(value)
       value.to_i.to_s == value.to_s
     end

data/lib/project_types/extension/extension_project_keys.rb

@@ -7,5 +7,6 @@ module Extension
     REGISTRATION_UUID_KEY = "EXTENSION_UUID"
     SPECIFICATION_IDENTIFIER_KEY = "EXTENSION_TYPE"
     TITLE_KEY = "EXTENSION_TITLE"
+    RESOURCE_URL_KEY = "EXTENSION_RESOURCE_URL"
   end
 end