shopify-cli 1.3.0 → 1.6.0

data/lib/project_types/theme/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Theme
+  class Project < ShopifyCli::ProjectType
+    hidden_feature
+
+    title('Theme')
+    creator('Theme::Commands::Create')
+    connector('Theme::Commands::Connect')
+
+    register_command('Theme::Commands::Deploy', 'deploy')
+    register_command('Theme::Commands::Generate', 'generate')
+    register_command('Theme::Commands::Push', 'push')
+    register_command('Theme::Commands::Serve', 'serve')
+
+    register_task('Theme::Tasks::EnsureThemekitInstalled', :ensure_themekit_installed)
+
+    require Project.project_filepath('messages/messages')
+    register_messages(Theme::Messages::MESSAGES)
+  end
+
+  module Commands
+    autoload :Connect, Project.project_filepath('commands/connect')
+    autoload :Create, Project.project_filepath('commands/create')
+    autoload :Deploy, Project.project_filepath('commands/deploy')
+    autoload :Generate, Project.project_filepath('commands/generate')
+    autoload :Push, Project.project_filepath('commands/push')
+    autoload :Serve, Project.project_filepath('commands/serve')
+  end
+
+  module Tasks
+    autoload :EnsureThemekitInstalled, Project.project_filepath('tasks/ensure_themekit_installed')
+  end
+
+  module Forms
+    autoload :Create, Project.project_filepath('forms/create')
+    autoload :Connect, Project.project_filepath('forms/connect')
+  end
+
+  autoload :Themekit, Project.project_filepath('themekit')
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+module Theme
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      prerequisite_task :ensure_themekit_installed
+
+      options do |parser, flags|
+        parser.on('--store=STORE') { |url| flags[:store] = url }
+        parser.on('--password=PASSWORD') { |p| flags[:password] = p }
+        parser.on('--themeid=THEME_ID') { |id| flags[:themeid] = id }
+        parser.on('--env=ENV') { |env| flags[:env] = env }
+      end
+
+      def call(args, _name)
+        if ShopifyCli::Project.has_current?
+          @ctx.abort(@ctx.message('theme.connect.inside_project'))
+        end
+
+        form = Forms::Connect.ask(@ctx, args, options.flags)
+        return @ctx.puts(self.class.help) if form.nil?
+
+        build(form.store, form.password, form.themeid, form.name, form.env)
+        ShopifyCli::Project.write(@ctx,
+          project_type: 'theme',
+          organization_id: nil)
+
+        @ctx.done(@ctx.message('theme.connect.connected', form.name, form.store, @ctx.root))
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.connect.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
+
+      private
+
+      def build(store, password, themeid, name, env)
+        if @ctx.dir_exist?(name)
+          @ctx.abort(@ctx.message('theme.connect.duplicate'))
+        end
+
+        @ctx.mkdir_p(name)
+        @ctx.chdir(name)
+
+        CLI::UI::Frame.open(@ctx.message('theme.connect.connect')) do
+          unless Themekit.connect(@ctx, store: store, password: password, themeid: themeid, env: env)
+            @ctx.chdir('..')
+            @ctx.rm_rf(name)
+            @ctx.abort(@ctx.message('theme.connect.failed'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Theme
+  module Commands
+    class Create < ShopifyCli::SubCommand
+      prerequisite_task :ensure_themekit_installed
+
+      options do |parser, flags|
+        parser.on('--name=NAME') { |t| flags[:title] = t }
+        parser.on('--password=PASSWORD') { |p| flags[:password] = p }
+        parser.on('--store=STORE') { |url| flags[:store] = url }
+        parser.on('--env=ENV') { |env| flags[:env] = env }
+      end
+
+      def call(args, _name)
+        form = Forms::Create.ask(@ctx, args, options.flags)
+        return @ctx.puts(self.class.help) if form.nil?
+
+        build(form.name, form.password, form.store, form.env)
+        ShopifyCli::Project.write(@ctx,
+          project_type: 'theme',
+          organization_id: nil) # private apps are different
+
+        @ctx.done(@ctx.message('theme.create.info.created', form.name, form.store, @ctx.root))
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.create.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
+
+      private
+
+      def build(name, password, store, env)
+        @ctx.abort(@ctx.message('theme.create.duplicate_theme')) if @ctx.dir_exist?(name)
+
+        @ctx.mkdir_p(name)
+        @ctx.chdir(name)
+
+        CLI::UI::Frame.open(@ctx.message('theme.create.creating_theme', name)) do
+          unless Themekit.create(@ctx, name: name, password: password, store: store, env: env)
+            @ctx.chdir('..')
+            @ctx.rm_rf(name)
+            @ctx.abort(@ctx.message('theme.create.failed'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Theme
+  module Commands
+    class Deploy < ShopifyCli::Command
+      prerequisite_task :ensure_themekit_installed
+
+      options do |parser, flags|
+        parser.on('--env=ENV') { |env| flags[:env] = env }
+        parser.on('--allow-live') { flags['allow_live'] = true }
+      end
+
+      def call(*)
+        CLI::UI::Frame.open(@ctx.message('theme.deploy.deploying')) do
+          unless CLI::UI::Prompt.confirm(@ctx.message('theme.deploy.confirmation'))
+            @ctx.abort(@ctx.message('theme.deploy.abort'))
+          end
+
+          if options.flags[:env]
+            env = options.flags[:env]
+            options.flags.delete(:env)
+          end
+
+          flags = Themekit.add_flags(options.flags)
+
+          unless Themekit.deploy(@ctx, flags: flags, env: env)
+            @ctx.abort(@ctx.message('theme.deploy.error'))
+          end
+        end
+
+        @ctx.done(@ctx.message('theme.deploy.info.deployed'))
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.deploy.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Theme
+  module Commands
+    class Generate < ShopifyCli::Command
+      prerequisite_task :ensure_themekit_installed
+
+      subcommand :Env, 'env', Project.project_filepath('commands/generate/env')
+
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.generate.help', ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/project_types/theme/commands/generate/env.rb

@@ -0,0 +1,79 @@
+module Theme
+  module Commands
+    class Generate
+      class Env < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--store=STORE') { |url| flags[:store] = url }
+          parser.on('--password=PASSWORD') { |p| flags[:password] = p }
+          parser.on('--themeid=THEME_ID') { |id| flags[:themeid] = id }
+          parser.on('--env=ENV') { |env| flags[:env] = env }
+        end
+
+        def call(*)
+          default_store, default_password = fetch_credentials
+          store = ask_store(default_store) || default_store
+          password = ask_password(default_password) || default_password
+          themeid = ask_theme(store: store, password: password)
+          env = options.flags[:env]
+
+          Themekit.generate_env(@ctx, store: store, password: password, themeid: themeid, env: env)
+        end
+
+        def self.help
+          ShopifyCli::Context.message('theme.generate.env.help', ShopifyCli::TOOL_NAME)
+        end
+
+        private
+
+        def fetch_credentials
+          unless File.exist?('config.yml')
+            return nil
+          end
+
+          config = YAML.load_file('config.yml')
+          store = config['development']['store']
+          password = config['development']['password']
+
+          [store, password]
+        end
+
+        def ask_store(default)
+          store = options.flags[:store] ||
+            if default
+              CLI::UI::Prompt.ask(@ctx.message('theme.generate.env.ask_store_default', default))
+            else
+              CLI::UI::Prompt.ask(@ctx.message('theme.generate.env.ask_store'), allow_empty: false)
+            end
+          return nil if store.empty?
+          store
+        end
+
+        def ask_password(default)
+          password = options.flags[:password] ||
+            if default
+              CLI::UI::Prompt.ask(@ctx.message('theme.generate.env.ask_password_default', default))
+            else
+              CLI::UI::Prompt.ask(@ctx.message('theme.generate.env.ask_password'), allow_empty: false)
+            end
+          return nil if password.empty?
+          password
+        end
+
+        def ask_theme(store:, password:)
+          theme = options.flags[:themeid]
+          return theme if theme
+
+          themes = Themekit.query_themes(@ctx, store: store, password: password)
+
+          @ctx.abort(@ctx.message('theme.generate.env.no_themes', ShopifyCli::TOOL_NAME)) if themes.empty?
+
+          CLI::UI::Prompt.ask(@ctx.message('theme.generate.env.ask_theme')) do |handler|
+            themes.each do |name, id|
+              handler.option(name) { id }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module Theme
+  module Commands
+    class Push < ShopifyCli::Command
+      prerequisite_task :ensure_themekit_installed
+
+      options do |parser, flags|
+        parser.on('--remove') { flags['remove'] = true }
+        parser.on('--nodelete') { flags['nodelete'] = true }
+        parser.on('--allow-live') { flags['allow-live'] = true }
+        parser.on('--env=ENV') { |env| flags[:env] = env }
+      end
+
+      def call(args, _name)
+        if options.flags['remove']
+          remove = true
+          options.flags.delete('remove')
+        end
+
+        if options.flags[:env]
+          env = options.flags[:env]
+          options.flags.delete(:env)
+        end
+
+        flags = Themekit.add_flags(options.flags)
+
+        if remove
+          CLI::UI::Frame.open(@ctx.message('theme.push.remove')) do
+            unless CLI::UI::Prompt.confirm(@ctx.message('theme.push.remove_confirm'))
+              @ctx.abort(@ctx.message('theme.push.remove_abort'))
+            end
+
+            unless Themekit.push(@ctx, files: args, flags: flags, remove: remove, env: env)
+              @ctx.abort(@ctx.message('theme.push.error.remove_error'))
+            end
+          end
+
+          @ctx.done(@ctx.message('theme.push.info.remove', @ctx.root))
+        else
+          CLI::UI::Frame.open(@ctx.message('theme.push.push')) do
+            unless Themekit.push(@ctx, files: args, flags: flags, remove: remove, env: env)
+              @ctx.abort(@ctx.message('theme.push.error.push_error'))
+            end
+          end
+
+          @ctx.done(@ctx.message('theme.push.info.push', @ctx.root))
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.push.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Theme
+  module Commands
+    class Serve < ShopifyCli::Command
+      prerequisite_task :ensure_themekit_installed
+
+      options do |parser, flags|
+        parser.on('--env=ENV') { |env| flags[:env] = env }
+        parser.on('--allow-live') { flags['allow-live'] = true }
+        parser.on('--notify=FILES') { |files| flags['notify'] = files }
+      end
+
+      def call(*)
+        if options.flags[:env]
+          env = options.flags[:env]
+          options.flags.delete(:env)
+        end
+
+        flags = Themekit.add_flags(options.flags)
+
+        CLI::UI::Frame.open(@ctx.message('theme.serve.serve')) do
+          Themekit.serve(@ctx, flags: flags, env: env)
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.message('theme.serve.help', ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Theme
+  module Forms
+    class Connect < ShopifyCli::Form
+      attr_accessor :name
+      flag_arguments :themeid, :password, :store, :env
+
+      def ask
+        self.store ||= CLI::UI::Prompt.ask(ctx.message('theme.forms.ask_store'), allow_empty: false)
+        ctx.puts(ctx.message('theme.forms.connect.private_app', store))
+        self.password ||= CLI::UI::Prompt.ask(ctx.message('theme.forms.ask_password'), allow_empty: false)
+
+        errors = []
+        errors << "store" if store.strip.empty?
+        errors << "password" if password.strip.empty?
+        ctx.abort(ctx.message('theme.forms.errors', errors.join(", ").capitalize)) unless errors.empty?
+
+        self.themeid, self.name = ask_theme(store: store, password: password, themeid: themeid)
+      end
+
+      private
+
+      def ask_theme(store:, password:, themeid:)
+        themes = Themekit.query_themes(@ctx, store: store, password: password)
+
+        themeid ||= CLI::UI::Prompt.ask("Select theme") do |handler|
+          themes.each do |name, id|
+            handler.option(name) { id }
+          end
+        end
+        [themeid, themes.key(themeid.to_i)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Theme
+  module Forms
+    class Create < ShopifyCli::Form
+      attr_accessor :name
+      flag_arguments :title, :password, :store, :env
+
+      def ask
+        self.store ||= CLI::UI::Prompt.ask(ctx.message('theme.forms.ask_store'), allow_empty: false)
+        ctx.puts(ctx.message('theme.forms.create.private_app', store))
+        self.password ||= CLI::UI::Prompt.ask(ctx.message('theme.forms.ask_password'), allow_empty: false)
+        self.title ||= CLI::UI::Prompt.ask(ctx.message('theme.forms.create.ask_title'), allow_empty: false)
+        self.name = self.title.downcase.split(" ").join("_")
+
+        errors = []
+        errors << "store" if store.strip.empty?
+        errors << "password" if password.strip.empty?
+        errors << "title" if title.strip.empty?
+        ctx.abort(ctx.message('theme.forms.errors', errors.join(", ").capitalize)) unless errors.empty?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+module Theme
+  module Messages
+    MESSAGES = {
+      theme: {
+        connect: {
+          duplicate: "Duplicate directory, theme files weren't connected",
+          help: <<~HELP,
+            {{command:%s connect theme}}: Connects an existing theme in your store to Shopify App CLI. Downloads a copy of the theme files to your local development environment.
+              Usage: {{command:%s connect theme}}
+              Options:
+                {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                {{command:--themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
+          HELP
+          inside_project: "You are inside an existing theme, theme files weren't connected",
+          connect: "Downloading theme files...",
+          failed: "Couldn't download theme files from store",
+          connected: "{{green:%s}} files were downloaded from {{underline:%s}} to {{green:%s}}",
+        },
+        create: {
+          creating_theme: "Creating theme %s",
+          duplicate_theme: "Duplicate theme",
+          failed: "Couldn't create the theme",
+          help: <<~HELP,
+            {{command:%s create theme}}: Creates a theme.
+              Usage: {{command:%s create theme}}
+              Options:
+                {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                {{command:--name=NAME}} Theme name. Any string.
+          HELP
+          info: {
+            created: "{{green:%s}} was created for {{underline:%s}} in {{green:%s}}",
+          },
+        },
+        deploy: {
+          abort: "Theme wasn't deployed",
+          confirmation: "This will change your live theme. Do you wish to proceed?",
+          deploying: "Deploying theme",
+          error: "Theme couldn't be deployed",
+          help: <<~HELP,
+            {{command:%s deploy}}: Uploads your local theme files to Shopify, then sets your theme as the live theme.
+              Usage: {{command:%s deploy}}
+          HELP
+          info: {
+            deployed: "Theme was updated and set as the live theme",
+            pushed: "All theme files were updated",
+          },
+          push_fail: "Theme files couldn't be updated",
+        },
+        forms: {
+          ask_password: "Password:",
+          ask_store: "Store domain:",
+          create: {
+            ask_title: "Title:",
+            private_app: <<~APP,
+              To create a new theme, Shopify App CLI needs to connect with a private app installed on your store. Visit {{underline:%s/admin/apps/private}} to create a new API key and password, or retrieve an existing password.
+              If you create a new private app, ensure that it has Read and Write Theme access.
+            APP
+          },
+          connect: {
+            private_app: <<~APP,
+              To fetch your existing themes, Shopify App CLI needs to connect with your store. Visit {{underline:%s/admin/apps/private}} to create a new API key and password, or retrieve an existing password.
+              If you create a new private app, ensure that it has Read and Write Theme access.
+            APP
+          },
+          errors: "%s can't be blank",
+        },
+        generate: {
+          env: {
+            ask_password: "Password",
+            ask_password_default: "Password (defaults to {{green:%s}})",
+            ask_store: "Store",
+            ask_store_default: "Store (defaults to {{green:%s}})",
+            ask_theme: "Select theme",
+            help: <<~HELP,
+              Create or update configuration file in the current directory.
+                Usage: {{command:%s generate env}}
+                Options:
+                  {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                  {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                  {{command:--themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
+            HELP
+            no_themes: "Please create a new theme using %s create theme",
+          },
+          help: <<~HELP,
+            Generate code in your Theme. Currently supports generating new envs.
+              Usage: {{command:%s generate [ env ]}}
+          HELP
+        },
+        push: {
+          remove_abort: "Theme files weren't deleted",
+          remove_confirm: "This will delete the local and remote copies of the theme files. Do you wish to proceed?",
+          error: {
+            push_error: "Theme files couldn't be pushed to Shopify",
+            remove_error: "Theme files couldn't be removed from Shopify",
+          },
+          help: <<~HELP,
+            {{command:%s push}}: Uploads your local theme files to Shopify, overwriting the remote versions. If you specify filenames, separated by a space, only those files will be replaced. Otherwise, the whole theme will be replaced.
+              Usage: {{command:%s push}}
+              Options:
+                {{command:--remove}} Deletes both the local and the remote copies of the specified files. At least one filename must be specified.
+                {{command:--allow-live}} Allows Shopify App CLI to replace files on the store's live production theme.
+                {{command:--nodelete}} Runs the push command without deleting remote files from Shopify.
+          HELP
+          info: {
+            push: "Theme files were pushed from {{green:%s}} to Shopify",
+            remove: "Theme files were deleted from {{green:%s}} and Shopify",
+          },
+          push: "Pushing theme files to Shopify",
+          remove: "Deleting theme files",
+        },
+        serve: {
+          help: <<~HELP,
+            Sync your current changes, then view the active store in your default browser. Any theme edits will continue to update in real time. Also prints the active store's URL in your terminal.
+            Usage: {{command:%s serve}}
+          HELP
+          serve: "Viewing theme...",
+          open_fail: "Couldn't open the theme",
+        },
+        tasks: {
+          ensure_themekit_installed: {
+            auto_update: "Would you like to enable auto-updating?",
+            downloading: "Downloading Theme Kit %s",
+            errors: {
+              digest_fail: "Unable to verify download",
+              releases_fail: "Unable to fetch Theme Kit's list of releases",
+              update_fail: "Unable to update Theme Kit",
+              write_fail: "Unable to download Theme Kit",
+            },
+            installing_themekit: "Installing Theme Kit",
+            successful: "Theme Kit installed successfully",
+            updating_themekit: "Updating Theme Kit",
+            verifying: "Verifying download...",
+          },
+        },
+        themekit: {
+          query_themes: {
+            bad_password: "Bad password",
+            not_connect: "Couldn't connect to given shop",
+          },
+        },
+      },
+    }.freeze
+  end
+end