shopify-cli 2.2.2 → 2.6.0

data/lib/{shopify-cli → shopify_cli}/commands/populate/product.rb

@@ -1,21 +1,21 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Commands
     class Populate
-      class Product < ShopifyCli::AdminAPI::PopulateResourceCommand
+      class Product < ShopifyCLI::AdminAPI::PopulateResourceCommand
         @input_type = :ProductInput
 
         def defaults
           {
-            title: ShopifyCli::Helpers::Haikunator.title,
+            title: ShopifyCLI::Helpers::Haikunator.title,
             variants: [{ price: price }],
           }
         end
 
         def message(data)
           ret = data["productCreate"]["product"]
-          id = ShopifyCli::API.gid_to_id(ret["id"])
+          id = ShopifyCLI::API.gid_to_id(ret["id"])
           @ctx.message("core.populate.product.added", ret["title"], @shop, admin_url, id)
         end
       end

data/lib/shopify_cli/commands/populate.rb

@@ -0,0 +1,23 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Populate < ShopifyCLI::Command
+      subcommand :Customer, "customers", "shopify_cli/commands/populate/customer"
+      subcommand :DraftOrder, "draftorders", "shopify_cli/commands/populate/draft_order"
+      subcommand :Product, "products", "shopify_cli/commands/populate/product"
+
+      def call(_args, _name)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.populate.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCLI::Context.message("core.populate.extended_help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/shopify_cli/commands/store.rb

@@ -0,0 +1,15 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Store < ShopifyCLI::Command
+      def call(_args, _name)
+        @ctx.puts(@ctx.message("core.store.shop", ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)))
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.store.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/commands/switch.rb

@@ -1,8 +1,8 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Commands
-    class Switch < ShopifyCli::Command
+    class Switch < ShopifyCLI::Command
       options do |parser, flags|
         parser.on("--store=STORE") { |url| flags[:shop] = url }
         # backwards compatibility allow 'shop' for now
@@ -18,11 +18,11 @@ module ShopifyCli
         shop = if options.flags[:shop]
           Login.validate_shop(options.flags[:shop])
         elsif (org_id = DB.get(:organization_id))
-          res = ShopifyCli::Tasks::SelectOrgAndShop.call(@ctx, organization_id: org_id)
+          res = ShopifyCLI::Tasks::SelectOrgAndShop.call(@ctx, organization_id: org_id)
           res[:shop_domain]
         else
           AdminAPI.get_shop_or_abort(@ctx)
-          res = ShopifyCli::Tasks::SelectOrgAndShop.call(@ctx)
+          res = ShopifyCLI::Tasks::SelectOrgAndShop.call(@ctx)
           res[:shop_domain]
         end
         DB.set(shop: shop)
@@ -32,7 +32,7 @@ module ShopifyCli
       end
 
       def self.help
-        ShopifyCli::Context.message("core.switch.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("core.switch.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/{shopify-cli → shopify_cli}/commands/system.rb

@@ -1,9 +1,9 @@
 require "shopify_cli"
 require "rbconfig"
 
-module ShopifyCli
+module ShopifyCLI
   module Commands
-    class System < ShopifyCli::Command
+    class System < ShopifyCLI::Command
       hidden_feature(feature_set: :debug)
 
       def call(args, _name)
@@ -28,7 +28,7 @@ module ShopifyCli
       end
 
       def self.help
-        ShopifyCli::Context.message("core.system.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("core.system.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -50,21 +50,21 @@ module ShopifyCli
 
         @ctx.puts(@ctx.message("core.system.header"))
         cli_constants.each do |s|
-          @ctx.puts("  " + @ctx.message("core.system.const", s, ShopifyCli.const_get(s.to_sym)) + "\n")
+          @ctx.puts("  " + @ctx.message("core.system.const", s, ShopifyCLI.const_get(s.to_sym)) + "\n")
         end
 
         if show_all_details
           cli_path_methods.each do |m|
-            @ctx.puts("  " + @ctx.message("core.system.const", m.upcase, ShopifyCli.send(m)) + "\n")
+            @ctx.puts("  " + @ctx.message("core.system.const", m.upcase, ShopifyCLI.send(m)) + "\n")
           end
         end
       end
 
       def display_shopify_store(_show_all_details)
-        shop = if ShopifyCli::DB.exists?(:shop)
-          ShopifyCli::AdminAPI.get_shop_or_abort(@ctx)
+        shop = if ShopifyCLI::DB.exists?(:shop)
+          ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
         else
-          @ctx.message("core.populate.error.no_shop", ShopifyCli::TOOL_NAME)
+          @ctx.message("core.populate.error.no_shop", ShopifyCLI::TOOL_NAME)
         end
 
         @ctx.puts("\n" + @ctx.message("core.system.shop_header"))
@@ -96,7 +96,7 @@ module ShopifyCli
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli.cache_dir, "ngrok#{@ctx.executable_file_extension}")
+        ngrok_location = File.join(ShopifyCLI.cache_dir, "ngrok#{@ctx.executable_file_extension}")
         if File.exist?(ngrok_location)
           @ctx.puts("  " + @ctx.message("core.system.ngrok_available", ngrok_location))
         else
@@ -154,7 +154,7 @@ module ShopifyCli
       end
 
       def display_shopify_staff_identity
-        is_shopifolk = ShopifyCli::Shopifolk.check
+        is_shopifolk = ShopifyCLI::Shopifolk.check
         if is_shopifolk
           @ctx.puts("\n" + @ctx.message("core.system.identity_header"))
           @ctx.puts("  " + @ctx.message("core.system.identity_is_shopifolk"))

data/lib/shopify_cli/commands/version.rb

@@ -0,0 +1,15 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Version < ShopifyCLI::Command
+      def self.help
+        ShopifyCLI::Context.message("core.version.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def call(_args, _name)
+        @ctx.puts(ShopifyCLI::VERSION.to_s)
+      end
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/commands/whoami.rb

@@ -1,15 +1,15 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Commands
-    class Whoami < ShopifyCli::Command
+    class Whoami < ShopifyCLI::Command
       def call(_args, _name)
-        shop = ShopifyCli::DB.get(:shop)
-        org_id = ShopifyCli::DB.get(:organization_id)
-        org = ShopifyCli::PartnersAPI::Organizations.fetch(@ctx, id: org_id) unless org_id.nil?
+        shop = ShopifyCLI::DB.get(:shop)
+        org_id = ShopifyCLI::DB.get(:organization_id)
+        org = ShopifyCLI::PartnersAPI::Organizations.fetch(@ctx, id: org_id) unless org_id.nil?
 
         output = if shop.nil? && org.nil?
-          @ctx.message("core.whoami.not_logged_in", ShopifyCli::TOOL_NAME)
+          @ctx.message("core.whoami.not_logged_in", ShopifyCLI::TOOL_NAME)
         elsif !shop.nil? && org.nil?
           @ctx.message("core.whoami.logged_in_shop_only", shop)
         elsif shop.nil? && !org.nil?
@@ -21,7 +21,7 @@ module ShopifyCli
       end
 
       def self.help
-        ShopifyCli::Context.message("core.whoami.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("core.whoami.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/shopify_cli/commands.rb

@@ -0,0 +1,34 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: "help",
+      contextual_resolver: nil,
+    )
+    @core_commands = []
+
+    def self.register(const, cmd, path = nil, is_core = false)
+      autoload(const, path) if path
+      Registry.add(->() { const_get(const) }, cmd)
+      @core_commands.push(cmd) if is_core
+    end
+
+    def self.core_command?(cmd)
+      @core_commands.include?(cmd)
+    end
+
+    register :Config, "config", "shopify_cli/commands/config", true
+    register :Help, "help", "shopify_cli/commands/help", true
+    register :Login, "login", "shopify_cli/commands/login", true
+    register :Logout, "logout", "shopify_cli/commands/logout", true
+    register :Populate, "populate", "shopify_cli/commands/populate", true
+    register :Store, "store", "shopify_cli/commands/store", true
+    register :Switch, "switch", "shopify_cli/commands/switch", true
+    register :System, "system", "shopify_cli/commands/system", true
+    register :Version, "version", "shopify_cli/commands/version", true
+    register :Whoami, "whoami", "shopify_cli/commands/whoami", true
+
+    autoload :Connect, "shopify_cli/commands/connect"
+  end
+end

data/lib/{shopify-cli → shopify_cli}/connect.rb

@@ -1,6 +1,6 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   class Connect
     def initialize(ctx)
       @ctx = ctx
@@ -10,14 +10,14 @@ module ShopifyCli
       if Project.current&.env
         @ctx.puts(@ctx.message("core.connect.already_connected_warning"))
       end
-      org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+      org = ShopifyCLI::Tasks::EnsureEnv.call(@ctx, regenerate: true)
       write_cli_yml(project_type, org["id"]) unless Project.has_current?
       api_key = Project.current(force_reload: true).env["api_key"]
       get_app(org["apps"], api_key).first["title"]
     end
 
     def write_cli_yml(project_type, org_id)
-      ShopifyCli::Project.write(
+      ShopifyCLI::Project.write(
         @ctx,
         project_type: project_type,
         organization_id: org_id,

data/lib/shopify_cli/constants.rb

@@ -0,0 +1,54 @@
+module ShopifyCLI
+  module Constants
+    module Paths
+      ROOT = File.expand_path("../..", __dir__)
+    end
+
+    module StoreKeys
+      LAST_MIGRATION_DATE = :last_migration_date
+      ANALYTICS_ENABLED = :analytics_enabled
+    end
+
+    module Bugsnag
+      API_KEY = "773b0c801eb40c20d8928be5b7c739bd"
+    end
+
+    module Config
+      module Sections
+        module ErrorTracking
+          NAME = "error-tracking"
+          module Fields
+            AUTOMATIC_REPORTING = "automatic-reporting"
+          end
+        end
+      end
+    end
+
+    module EnvironmentVariables
+      STACKTRACE = "SHOPIFY_CLI_STACKTRACE"
+
+      # When true the CLI points to a local instance of
+      # the partners dashboard and identity.
+      LOCAL_PARTNERS = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
+
+      # When true the CLI points to a spin instance of spin
+      SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
+      SPIN_WORKSPACE = "SPIN_WORKSPACE"
+      SPIN_NAMESPACE = "SPIN_NAMESPACE"
+      SPIN_HOST = "SPIN_HOST"
+
+      # Environments
+      TEST = "SHOPIFY_CLI_TEST"
+      DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
+    end
+
+    module Identity
+      CLIENT_ID_DEV = "e5380e02-312a-7408-5718-e07017e9cf52"
+      CLIENT_ID = "fbdb2649-e327-4907-8f67-908d24cfd7e3"
+    end
+
+    module Links
+      NEW_ISSUE = "https://github.com/Shopify/shopify-cli/issues/new"
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/context.rb

@@ -5,7 +5,7 @@ require "rbconfig"
 require "net/http"
 require "json"
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # Context captures a lot about the current running command. It captures the
   # environment, output, system and file operations. It is useful to have the
@@ -97,7 +97,7 @@ module ShopifyCli
     # See `#development?` for checking for development environment.
     #
     def system?
-      !Dir.exist?(File.join(ShopifyCli::ROOT, "test"))
+      !Dir.exist?(File.join(ShopifyCLI::ROOT, "test"))
     end
 
     # will return true if the cli is running on your development instance.
@@ -382,7 +382,7 @@ module ShopifyCli
     # * `text` - a string message to output
     #
     def abort(text)
-      raise ShopifyCli::Abort, "{{x}} #{text}"
+      raise ShopifyCLI::Abort, "{{x}} #{text}"
     end
 
     # outputs a message, prefixed by a red `DEBUG` tag. This will only output to
@@ -559,7 +559,7 @@ module ShopifyCli
       if (time_of_last_check + VERSION_CHECK_INTERVAL) < (now = Time.now.to_i)
         update_time_of_last_check(now)
         latest_version = retrieve_latest_gem_version
-        latest_version unless latest_version == ShopifyCli::VERSION
+        latest_version unless latest_version == ShopifyCLI::VERSION
       end
     end
 
@@ -600,11 +600,11 @@ module ShopifyCli
     end
 
     def time_of_last_check
-      (val = ShopifyCli::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
+      (val = ShopifyCLI::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
     end
 
     def update_time_of_last_check(time)
-      ShopifyCli::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
+      ShopifyCLI::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
     end
   end
 end

data/lib/{shopify-cli → shopify_cli}/core/entry_point.rb

@@ -1,26 +1,26 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Core
     module EntryPoint
       class << self
         def call(args, ctx = Context.new)
           if ctx.development?
             ctx.warn(
-              ctx.message("core.warning.development_version", File.join(ShopifyCli::ROOT, "bin", ShopifyCli::TOOL_NAME))
+              ctx.message("core.warning.development_version", File.join(ShopifyCLI::ROOT, "bin", ShopifyCLI::TOOL_NAME))
             )
           elsif !ctx.testing?
             new_version = ctx.new_version
-            ctx.warn(ctx.message("core.warning.new_version", ShopifyCli::VERSION, new_version)) unless new_version.nil?
+            ctx.warn(ctx.message("core.warning.new_version", ShopifyCLI::VERSION, new_version)) unless new_version.nil?
           end
 
           ProjectType.load_all
 
-          task_registry = ShopifyCli::Tasks::Registry
+          task_registry = ShopifyCLI::Tasks::Registry
 
-          command, command_name, args = ShopifyCli::Resolver.call(args)
-          executor = ShopifyCli::Core::Executor.new(ctx, task_registry, log_file: ShopifyCli.log_file)
-          ShopifyCli::Core::Monorail.log(command_name, args) do
+          command, command_name, args = ShopifyCLI::Resolver.call(args)
+          executor = ShopifyCLI::Core::Executor.new(ctx, task_registry, log_file: ShopifyCLI.log_file)
+          ShopifyCLI::Core::Monorail.log(command_name, args) do
             executor.call(command, command_name, args)
           end
         end

data/lib/{shopify-cli → shopify_cli}/core/executor.rb

@@ -1,18 +1,22 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   module Core
     class Executor < CLI::Kit::Executor
       def initialize(ctx, task_registry, *args, **kwargs)
-        @ctx = ctx || ShopifyCli::Context.new
-        @task_registry = task_registry || ShopifyCli::Tasks::TaskRegistry.new
+        @ctx = ctx || ShopifyCLI::Context.new
+        @task_registry = task_registry || ShopifyCLI::Tasks::TaskRegistry.new
         super(*args, **kwargs)
       end
 
       def call(command, command_name, args)
         command.task_registry = @task_registry
         command.ctx = @ctx
-        super
+        with_traps do
+          with_logging do |_id|
+            command.call(args, command_name)
+          end
+        end
       end
     end
   end

data/lib/{shopify-cli → shopify_cli}/core/finalize.rb

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   module Core
     # This class is just a dummy to make sure that we don't trigger warnings on the first time the updated code runs.
     # The old code would try to call the Finalizer after it is done updating, which would then trigger an autoload of

data/lib/{shopify-cli → shopify_cli}/core/help_resolver.rb

@@ -1,6 +1,6 @@
 require "cli/kit"
 
-module ShopifyCli
+module ShopifyCLI
   module Core
     class HelpResolver < CLI::Kit::Resolver
       def call(args)
@@ -10,7 +10,7 @@ module ShopifyCli
           help = Commands::Help
           help.ctx = Context.new
           help.call([], nil)
-          raise ShopifyCli::AbortSilent
+          raise ShopifyCLI::AbortSilent
         else
           super(args)
         end

data/lib/{shopify-cli → shopify_cli}/core/monorail.rb

@@ -3,7 +3,7 @@ require "net/http"
 require "time"
 require "rbconfig"
 
-module ShopifyCli
+module ShopifyCLI
   module Core
     module Monorail
       ENDPOINT_URI = URI.parse("https://monorail-edge.shopifycloud.com/v1/produce")
@@ -50,16 +50,16 @@ module ShopifyCli
         end
 
         def consented?
-          ShopifyCli::Config.get_bool("analytics", "enabled")
+          ShopifyCLI::Config.get_bool("analytics", "enabled")
         end
 
         def prompt_for_consent
           return if Context.new.ci?
           return unless enabled?
-          return if ShopifyCli::Config.get_section("analytics").key?("enabled")
+          return if ShopifyCLI::Config.get_section("analytics").key?("enabled")
           msg = Context.message("core.monorail.consent_prompt")
           opt = CLI::UI::Prompt.confirm(msg)
-          ShopifyCli::Config.set("analytics", "enabled", opt)
+          ShopifyCLI::Config.set("analytics", "enabled", opt)
         end
 
         def send_event(start_time, commands, args, err = nil)
@@ -100,12 +100,12 @@ module ShopifyCli
               success: err.nil?,
               error_message: err,
               uname: RbConfig::CONFIG["host"],
-              cli_version: ShopifyCli::VERSION,
+              cli_version: ShopifyCLI::VERSION,
               ruby_version: RUBY_VERSION,
-              is_employee: ShopifyCli::Shopifolk.acting_as_shopify_organization?,
+              is_employee: ShopifyCLI::Shopifolk.acting_as_shopify_organization?,
             }.tap do |payload|
               payload[:api_key] = metadata.delete(:api_key)
-              payload[:partner_id] = metadata.delete(:organization_id) || ShopifyCli::DB.get(:organization_id)
+              payload[:partner_id] = metadata.delete(:organization_id) || ShopifyCLI::DB.get(:organization_id)
               if Project.has_current?
                 project = Project.current(force_reload: true)
                 payload[:api_key] = project.env&.api_key
@@ -117,7 +117,7 @@ module ShopifyCli
         end
 
         def project_type_from_dir_or_cmd(command)
-          Project.current_project_type || (command unless ShopifyCli::Commands.core_command?(command)) || nil
+          Project.current_project_type || (command unless ShopifyCLI::Commands.core_command?(command)) || nil
         end
       end
     end

data/lib/shopify_cli/core.rb

@@ -0,0 +1,8 @@
+module ShopifyCLI
+  module Core
+    autoload :EntryPoint, "shopify_cli/core/entry_point"
+    autoload :Executor, "shopify_cli/core/executor"
+    autoload :HelpResolver, "shopify_cli/core/help_resolver"
+    autoload :Monorail, "shopify_cli/core/monorail"
+  end
+end

data/lib/{shopify-cli → shopify_cli}/db.rb

@@ -1,7 +1,7 @@
 require "pstore"
 require "forwardable"
 
-module ShopifyCli
+module ShopifyCLI
   # Persists transient data like access tokens that may be cleared
   # when user clears their session
   #
@@ -14,7 +14,7 @@ module ShopifyCli
 
     attr_reader :db # :nodoc:
 
-    def initialize(path: File.join(ShopifyCli.cache_dir, ".db.pstore")) # :nodoc:
+    def initialize(path: File.join(ShopifyCLI.cache_dir, ".db.pstore")) # :nodoc:
       @db = PStore.new(path)
     end
 
@@ -25,7 +25,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   ShopifyCli::DB.keys
+    #   ShopifyCLI::DB.keys
     #
     def keys
       db.transaction(true) { db.roots }
@@ -42,7 +42,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   exists = ShopifyCli::DB.exists?('shopify_exchange_token')
+    #   exists = ShopifyCLI::DB.exists?('shopify_exchange_token')
     #
     def exists?(key)
       db.transaction(true) { db.root?(key) }
@@ -55,7 +55,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   ShopifyCli::DB.set(shopify_exchange_token: 'token', metric_consent: true)
+    #   ShopifyCLI::DB.set(shopify_exchange_token: 'token', metric_consent: true)
     #
     def set(**args)
       db.transaction do
@@ -80,7 +80,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   ShopifyCli::DB.get(:shopify_exchange_token)
+    #   ShopifyCLI::DB.get(:shopify_exchange_token)
     #
     def get(key)
       val = db.transaction(true) { db[key] }
@@ -95,7 +95,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   ShopifyCli::DB.del(:shopify_exchange_token)
+    #   ShopifyCLI::DB.del(:shopify_exchange_token)
     #
     def del(*args)
       db.transaction { args.each { |key| db.delete(key) } }
@@ -105,7 +105,7 @@ module ShopifyCli
     #
     # #### Usage
     #
-    #   ShopifyCli::DB.clear
+    #   ShopifyCLI::DB.clear
     #
     def clear
       del(*keys)