shopify-cli 2.15.0 → 2.15.3

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

@@ -8,8 +8,9 @@ module Theme
             Usage: {{command:%1$s theme [ %2$s ]}}
         HELP
         ensure_user_error: "You are not authorized to edit themes on %s.",
-        ensure_user_try_this: "Make sure you are a user of that store, and allowed to edit themes.",
-
+        ensure_user_try_this: <<~ENSURE_USER,
+          Check if your user is activated, has permission to edit themes at the store, and try to re-login.
+        ENSURE_USER
         init: {
           help: <<~HELP,
             {{command:%s theme init}}: Clones a Git repository to use as a starting point for building a new theme.
@@ -101,13 +102,14 @@ module Theme
             Usage: {{command:%s theme serve [ ROOT ]}}
 
             Options:
-              {{command:--port=PORT}}        Local port to serve theme preview from.
-              {{command:--poll}}             Force polling to detect file changes.
-              {{command:--host=HOST}}        Set which network interface the web server listens on. The default value is 127.0.0.1.
-              {{command:--live-reload=MODE}} The live reload mode switches the server behavior when a file is modified:
-                                 - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
-                                 - {{command:full-page}}  Always refreshes the entire page
-                                 - {{command:off}}        Deactivate live reload
+              {{command:--port=PORT}}         Local port to serve theme preview from.
+              {{command:--poll}}              Force polling to detect file changes.
+              {{command:--host=HOST}}         Set which network interface the web server listens on. The default value is 127.0.0.1.
+              {{command:--theme-editor-sync}} Synchronize Theme Editor updates in the local theme files.
+              {{command:--live-reload=MODE}}  The live reload mode switches the server behavior when a file is modified:
+                                  - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
+                                  - {{command:full-page}}  Always refreshes the entire page
+                                  - {{command:off}}        Deactivate live reload
           HELP
           reload_mode_is_not_valid: "The live reload mode `%s` is not valid.",
           try_a_valid_reload_mode: "Try a valid live reload mode: %s.",
@@ -121,18 +123,56 @@ module Theme
               fixed: "Fixed",
             },
           },
+          syncer: {
+            forms: {
+              apply_to_all: {
+                title: "Would like apply this to all the other %s files?",
+                yes: "Yes",
+                no: "No",
+              },
+              update_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} is different from the remote version in the development theme."
+                TITLE
+                title_question: "What would you like to do?",
+                keep_remote: "Keep the remote version",
+                keep_local: "Keep the local version",
+                union_merge: "Merge files (it may break the local file)",
+                exit: "Exit",
+              },
+              delete_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} has been recently removed, but it's present on your remote development theme.",
+                TITLE
+                title_question: "What would you like to do?",
+                delete: "Delete permanently",
+                restore: "Restore with the remote version",
+                exit: "Exit",
+              },
+            },
+          },
           error: {
             address_binding_error: "Couldn't bind to localhost."\
               " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
+            invalid_subdirectory: <<~MESSAGE,
+              The presence of %s in the directory structure isn't supported.
+
+              Move any files to a parent folder, then delete unsupported subdirectories.
+
+              • Required directory structure: https://shopify.dev/themes/architecture#directory-structure-and-component-types
+            MESSAGE
           },
           serving: <<~SERVING,
 
             Serving %s
 
           SERVING
+          download_changes: ", and use 'theme pull' to get the changes",
           customize_or_preview: <<~CUSTOMIZE_OR_PREVIEW,
 
-            Customize this theme in the Theme Editor:
+            Customize this theme in the Theme Editor%s:
             {{green:%s}}
 
             Share this theme preview:
@@ -142,7 +182,7 @@ module Theme
           CUSTOMIZE_OR_PREVIEW
           ensure_user: <<~ENSURE_USER,
             You are not authorized to edit themes on %s.
-            Make sure you are a user of that store, and allowed to edit themes.
+            Check if your user is activated, has permission to edit themes at the store, and try to re-login.
           ENSURE_USER
           address_already_in_use: "The address \"%s\" is already in use.",
           try_port_option: "Use the --port=PORT option to serve the theme in a different port.",
@@ -152,6 +192,7 @@ module Theme
             Check your theme for errors, suggestions, and best practices.
             Usage: {{command:%s check}}
           HELP
+          error: "Theme check failed with error:\n%s",
         },
         delete: {
           help: <<~HELP,
@@ -223,6 +264,9 @@ module Theme
           details: <<~DETAILS,
             {{*}} {{bold:%s}}
 
+            Preview your theme:
+            {{green:%s}}
+
             Customize your theme in the Theme Editor:
             {{green:%s}}
 
@@ -246,6 +290,22 @@ module Theme
             Usage: {{command:%s theme list}}
           HELP
         },
+        share: {
+          help: <<~HELP,
+            {{command:%s theme share}}: Creates a shareable, unpublished, and new theme on your theme library with a randomized name.
+                                 Works like an alias to {{command:theme push -u -t=RANDOMIZED_NAME}}.
+
+            Usage: {{command:%s theme share [ ROOT ]}}
+          HELP
+          done: <<~DONE,
+            {{green:The {{bold:%s}} theme was pushed successfully}}
+
+              {{info:Share your theme preview:}}
+              {{underline:%s}}
+
+          DONE
+          upload: "Pushing theme files to %s (#%s) on %s",
+        },
       },
     }.freeze
   end

data/lib/shopify_cli/changelog.rb

@@ -0,0 +1,148 @@
+require "date"
+require "shopify_cli/sed"
+require "octokit"
+
+module ShopifyCLI
+  class Changelog
+    CHANGELOG_FILE = File.join(ShopifyCLI::ROOT, "CHANGELOG.md")
+    CHANGE_CATEGORIES = %w(Added Changed Deprecated Removed Fixed Security)
+
+    def initialize
+      load(File.read(CHANGELOG_FILE))
+    end
+
+    def update_version!(new_version)
+      changes[new_version] = changes["Unreleased"]
+      changes[new_version][:date] = Date.today.iso8601
+      changes["Unreleased"] = { changes: [], date: nil }
+      save!
+    end
+
+    def update!
+      pr = pr_for_current_branch
+      category = CLI::UI::Prompt.ask("What type of change?", options: CHANGE_CATEGORIES)
+      add_change(category, { pr_id: pr.number, desc: pr.title })
+      save!
+    end
+
+    def release_notes(version)
+      changes[version][:changes].map do |change_category, changes|
+        <<~CHANGES
+          ### #{change_category}
+          #{changes.map { |change| entry(**change) }.join("\n")}
+        CHANGES
+      end.join("\n")
+    end
+
+    def add_change(category, change)
+      changes["Unreleased"][:changes][category] << change
+    end
+
+    def entry(pr_id:, desc:)
+      "* [##{pr_id}](https://github.com/Shopify/shopify-cli/pull/#{pr_id}): #{desc}"
+    end
+
+    def full_contents
+      sorted_changes = changes.each_key.sort_by do |change|
+        if change == "Unreleased"
+          [Float::INFINITY] * 3 # end of the list
+        else
+          major, minor, patch = change.split(".").map(&:to_i)
+          [major, minor, patch]
+        end
+      end.reverse
+      [
+        heading,
+        *sorted_changes.each.map { |version| release_notes_with_header(version) }.join,
+        remainder,
+      ].map { |section| section.chomp << "\n" }.join
+    end
+
+    def save!
+      File.write(CHANGELOG_FILE, full_contents)
+    end
+
+    private
+
+    attr_reader :heading, :remainder
+
+    def release_notes_with_header(version)
+      header_line =
+        if version == "Unreleased"
+          "[Unreleased]"
+        else
+          date = changes[version][:date]
+          "Version #{version}#{" - #{date}" if date}"
+        end
+
+      [
+        "## #{header_line}",
+        release_notes(version),
+      ].reject(&:empty?).map { |section| section.chomp << "\n\n" }.join
+    end
+
+    def changes
+      @changes ||= Hash.new do |h, k|
+        h[k] = {
+          date: nil,
+          changes: Hash.new do |h2, k2|
+            h2[k2] = []
+          end,
+        }
+      end
+    end
+
+    def load(log)
+      state = :initial
+      change_category = nil
+      current_version = nil
+      @heading = ""
+      @remainder = ""
+      log.each_line do |line|
+        case state
+        when :initial
+          if line.chomp == "\#\# [Unreleased]"
+            state = :unreleased
+            current_version = "Unreleased"
+            # Ensure Unreleased changeset exists even if no changes have happened yet
+            changes["Unreleased"]
+          else
+            @heading << line
+          end
+        when :unreleased, :prior_versions
+          if /\A\#\#\# (?<category>\w+)/ =~ line
+            change_category = category
+          elsif %r{\A\* \[\#(?<id>\d+)\]\(https://github.com/Shopify/shopify-cli/pull/\k<id>\): (?<desc>.+)\n} =~ line
+            changes[current_version][:changes][change_category] << { pr_id: id, desc: desc }
+          elsif /\A\#\# Version (?<version>\d+\.\d+\.\d+)( - (?<date>\d{4}-\d{2}-\d{2}))?/ =~ line
+            current_version = version
+            state = :prior_versions
+            major, minor, _patch = current_version.split(".")
+            if major.to_i <= 2 && minor.to_i < 7
+              # Changelog starts to become irregular in 2.6.x
+              state = :finished
+            end
+            changes[current_version][:date] = date unless state == :finished
+          elsif !line.match?(/\s*\n/)
+            raise "Unrecognized line: #{line.inspect}"
+          end
+        end
+        @remainder << line if state == :finished
+      end
+    end
+
+    def pr_for_current_branch
+      current_branch = %x(git branch --show-current).chomp
+      search_term = "repo:Shopify/shopify-cli is:pr is:open head:#{current_branch}"
+      results = Octokit::Client.new.search_issues(search_term)
+      case results.total_count
+      when 0
+        raise "PR not opened yet!"
+      when (2..)
+        raise "Multiple open PRs, not sure which one to use for changelog!"
+      end
+
+      results.items.first
+    end
+  end
+end

data/lib/shopify_cli/command.rb

@@ -36,6 +36,13 @@ module ShopifyCLI
         end
       rescue OptionParser::InvalidOption => error
         arg = error.args.first
+        store_name = arg.match(/\A--(?<store_name>.*\.myshopify\.com)\z/)&.[](:store_name)
+        if store_name && !arg.match?(/\A--(store|shop)=/)
+          # Sometimes it may look like --invalidoption=https://storename.myshopify.com
+          store_name = store_name.sub(%r{\A(.*=)?(https?://)?}, "")
+          raise ShopifyCLI::Abort,
+            @ctx.message("core.errors.option_parser.invalid_option_store_equals", arg, store_name)
+        end
         raise ShopifyCLI::Abort, @ctx.message("core.errors.option_parser.invalid_option", arg)
       rescue OptionParser::MissingArgument => error
         arg = error.args.first

data/lib/shopify_cli/command_options/command_serve_options.rb

@@ -20,6 +20,10 @@ module ShopifyCLI
             end
             host
           end
+
+          def no_update
+            options.flags[:no_update] || false
+          end
         end
       end
 
@@ -37,6 +41,12 @@ module ShopifyCLI
             parser.on("--port=PORT") { |port| flags[:port] = port }
           end
         end
+
+        def parse_no_update_option
+          options do |parser, flags|
+            parser.on("--no-update") { flags[:no_update] = true }
+          end
+        end
       end
     end
   end

data/lib/shopify_cli/commands/app/serve.rb

@@ -8,12 +8,9 @@ module ShopifyCLI
 
         recommend_default_ruby_range
 
-        options do |parser, flags|
-          parser.on("--host=HOST") do |h|
-            flags[:host] = h.gsub('"', "")
-          end
-          parser.on("--port=PORT") { |port| flags[:port] = port }
-        end
+        parse_host_option
+        parse_port_option
+        parse_no_update_option
 
         def call(*)
           case detect_app
@@ -21,18 +18,21 @@ module ShopifyCLI
             Services::App::Serve::RailsService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           when :node
             Services::App::Serve::NodeService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           when :php
             Services::App::Serve::PHPService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           end
@@ -43,7 +43,7 @@ module ShopifyCLI
         end
 
         def self.extended_help
-          ShopifyCLI::Context.message("app.core.serve.extended_help")
+          ShopifyCLI::Context.message("core.app.serve.extended_help")
         end
       end
     end

data/lib/shopify_cli/commands/login.rb

@@ -30,7 +30,7 @@ module ShopifyCLI
         if @ctx.ci? && (password = options.flags[:password] || @ctx.getenv("SHOPIFY_PASSWORD"))
           ShopifyCLI::DB.set(shopify_exchange_token: password)
         else
-          IdentityAuth.new(ctx: @ctx).authenticate
+          IdentityAuth.new(ctx: @ctx).authenticate(spinner: true)
           org = select_organization
           ShopifyCLI::DB.set(organization_id: org["id"].to_i) unless org.nil?
           Whoami.call([], "whoami")
@@ -75,7 +75,10 @@ module ShopifyCLI
       private
 
       def select_organization
-        organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_all(@ctx)
+        organizations = []
+        CLI::UI::Spinner.spin(@ctx.message("core.login.spinner.loading_organizations")) do
+          organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_all(@ctx)
+        end
 
         if organizations.count == 0
           nil

data/lib/shopify_cli/context.rb

@@ -4,6 +4,7 @@ require "fileutils"
 require "rbconfig"
 require "net/http"
 require "json"
+require "bundler"
 
 module ShopifyCLI
   ##
@@ -642,6 +643,18 @@ module ShopifyCLI
       end
     end
 
+    # Uses bundle to grab the version of a gem
+    #
+    # #### Parameters
+    # - gem: the name of the gem to check
+    #
+    # #### Returns
+    # - version: a Semantic::Version object with the gem version
+    def ruby_gem_version(gem)
+      version = Bundler.load.specs.find { |s| s.name == gem }.version
+      ::Semantic::Version.new(version.to_s)
+    end
+
     private
 
     def ctx_path(fname)

data/lib/shopify_cli/git.rb

@@ -102,6 +102,42 @@ module ShopifyCLI
         branches
       end
 
+      ##
+      # Run git three-way file merge (it doesn't require an initialized git repository)
+      #
+      # #### Parameters
+      #
+      # * `current_file  - string path of the current file
+      # * `base_file`    - string path of the base file
+      # * `other_file`   - string path of the other file
+      # * `opts`         - list of "git merge-file" options. Valid values:
+      #                    - "-q"       - do not warn about conflicts
+      #                    - "--diff3"  - show conflicts
+      #                    - "--ours"   - resolve conflicts favoring lines from `current_file`
+      #                    - "--theirs" - resolve conflicts favoring lines from `other_file`
+      #                    - "--union"  - resolve conflicts favoring lines from both files
+      #                    - "-p"       - send results to standard output instead of
+      #                                 overwriting the `current_file`
+      # * `ctx`          - the current running context of your command, defaults to a new context
+      #
+      # #### Returns
+      #
+      # * standard output from git
+      #
+      # #### Example
+      #
+      #   output = ShopifyCLI::Git.merge_file(current_file, base_file, other_file, opts, ctx: ctx)
+      #
+      def merge_file(current_file, base_file, other_file, opts = [], ctx: Context.new)
+        output, status = ctx.capture2e("git", "merge-file", current_file, base_file, other_file, *opts)
+
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.merge_failed"))
+        end
+
+        output
+      end
+
       ##
       # will initialize a new repo in the current directory. This will output
       # if it was successful or not.

data/lib/shopify_cli/identity_auth.rb

@@ -56,8 +56,10 @@ module ShopifyCLI
 
     attr_accessor :response_query
 
-    def authenticate
-      return if refresh_exchange_tokens || refresh_access_tokens
+    def authenticate(spinner: false)
+      return if with_spinner(spinner, ctx.message("core.login.spinner.initiating")) do
+        attempt_reauthenticate
+      end
 
       initiate_authentication
 
@@ -66,7 +68,21 @@ module ShopifyCLI
       rescue IdentityAuth::Timeout => e
         ctx.abort(e.message)
       end
-      request_exchange_tokens
+      with_spinner(spinner, ctx.message("core.login.spinner.finalizing")) do
+        request_exchange_tokens
+      end
+    end
+
+    def with_spinner(spinner, message, &block)
+      result = nil
+      if spinner
+        CLI::UI::Spinner.spin(message) do
+          result = block.call
+        end
+      else
+        result = block.call
+      end
+      result
     end
 
     def fetch_or_auth_partners_token
@@ -100,10 +116,14 @@ module ShopifyCLI
     end
 
     def reauthenticate
-      return if refresh_exchange_tokens || refresh_access_tokens
+      return if attempt_reauthenticate
       ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))
     end
 
+    def attempt_reauthenticate
+      refresh_exchange_tokens || refresh_access_tokens
+    end
+
     def code_challenge
       @code_challenge ||= Base64.urlsafe_encode64(
         OpenSSL::Digest::SHA256.digest(code_verifier),

data/lib/shopify_cli/messages/messages.rb

@@ -18,8 +18,15 @@ module ShopifyCLI
           missing_node: "Node.js is required to continue. Install Node.js here: https://nodejs.org/en/download.",
           missing_npm: "npm is required to continue. Install npm here: https://www.npmjs.com/get-npm.",
           missing_ruby: "Ruby is required to continue. Install Ruby here: https://www.ruby-lang.org/en/downloads.",
+          bundle_info_failure: "Error getting version for %s gem",
           option_parser: {
             invalid_option: "The option {{command:%s}} is not supported.",
+            invalid_option_store_equals: <<~MESSAGE,
+            The option {{command:%s}} isn't recognized.
+
+            Try this:
+            {{command:--store=%s}}.
+            MESSAGE
             missing_argument: "The required argument {{command:%s}} is missing.",
           },
         },
@@ -257,6 +264,7 @@ module ShopifyCLI
               {{bold:Options:}}
                 {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
                 {{cyan:--port=PORT}}: Use custom port.
+                {{cyan:--no-update}}: Skips the dashboard URL update step
             HELP
             open_info: <<~MESSAGE,
               {{*}} To install and start using your app, open this URL in your browser:
@@ -277,6 +285,13 @@ module ShopifyCLI
         },
         extension: {
           push: {
+            beacon_extension: {
+              error: {
+                file_read_error: "There was a problem reading %s",
+                missing_config_key_error: "Configuration is missing key: %s",
+                invalid_config_value_error: "Configuration value is invalid: %s",
+              },
+            },
             checkout_ui_extension: {
               localization: {
                 error: {
@@ -288,6 +303,7 @@ module ShopifyCLI
                   invalid_file_extension: "Invalid locale filename: `%s`; only .json files are allowed.",
                   invalid_locale_code: "Invalid locale filename: `%s`; locale code should be 2 or 3 letters,"\
                     " optionally followed by a two-letter region code, e.g. `fr-CA`.",
+                  invalid_file_encoding: "Invalid file encoding for `%s`; file encoding should be UTF-8.",
                   single_default_locale: "There must be one and only one locale identified as the default locale,"\
                     " e.g. `en.default.json`",
                 },
@@ -382,6 +398,7 @@ module ShopifyCLI
             sparse_checkout_not_set: "Sparse checkout set command failed.",
             pull_failed: "Pull failed.",
             pull_failed_bad_branch: "Pull failed. Branch %s cannot be found. Check the branch name and try again.",
+            merge_failed: "The file %s merge failed.",
           },
 
           cloning: "Cloning %s into %s…",
@@ -432,7 +449,7 @@ module ShopifyCLI
         login: {
           help: <<~HELP,
             Log in to the Shopify CLI by authenticating with a store or partner organization
-              Usage: {{command:%s login [--store=STORE]}}
+              Usage: {{command:%s login [--store STORE]}}
           HELP
           invalid_shop: <<~MESSAGE,
             Invalid store provided (%s). Please provide the store in the following format: my-store.myshopify.com
@@ -440,6 +457,11 @@ module ShopifyCLI
           shop_prompt: <<~PROMPT,
             What store are you connecting to? (e.g. my-store.myshopify.com; do {{bold:NOT}} include protocol part, e.g., https://)
           PROMPT
+          spinner: {
+            initiating: "Initiating authentication",
+            finalizing: "Finalizing authentication",
+            loading_organizations: "Loading available partner organizations",
+          },
         },
 
         logout: {
@@ -454,7 +476,7 @@ module ShopifyCLI
         switch: {
           help: <<~HELP,
             Switch between development stores in your partner organization
-              Usage: {{command:%s switch [--store=STORE]}}
+              Usage: {{command:%s switch [--store STORE]}}
           HELP
           disabled_as_shopify_org: "Can't switch development stores logged in as {{green:Shopify partners org}}",
           success: "Switched development store to {{green:%s}}",
@@ -567,7 +589,7 @@ module ShopifyCLI
           HELP
 
           error: {
-            no_shop: "No store found. Please run {{command:%s login --store=STORE}} to login to a specific store",
+            no_shop: "No store found. Please run {{command:%s login --store STORE}} to login to a specific store",
           },
 
           customer: {
@@ -707,7 +729,6 @@ module ShopifyCLI
             updated: "{{v}} Whitelist URLS updated in Partners Dashboard}}",
             update_error:
               "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
-            update_prompt: "Do you want to update your application url?",
           },
           select_org_and_shop: {
             authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
@@ -803,7 +824,7 @@ module ShopifyCLI
           not_logged_in: <<~MESSAGE,
             It doesn't appear that you're logged in. You must log into a partner organization or a store staff account.
 
-            If trying to log into a store staff account, please use {{command:%s login --store=STORE}} to log in.
+            If trying to log into a store staff account, please use {{command:%s login --store STORE}} to log in.
           MESSAGE
           logged_in_shop_only: <<~MESSAGE,
             Logged into store {{green:%s}} as staff (no partner organizations available for this login)