shopify-cli 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c62bd5226aa12bbd9bd97097bc876669c5b0e1ce9186ec204c77c195ae123e
-  data.tar.gz: 0a35817ec758bfae2cace1cd28c1a4e1aa96357583926b17f14e31b05ae1b02a
+  metadata.gz: c65ab33bf57676cb65c04773cba1ae81a3852fd516283dde697a74f145c411e6
+  data.tar.gz: f74e40e7dcad523257c9535de75a121044bdc2f98acd1ac13dffd5310c4f9337
 SHA512:
-  metadata.gz: 01be89d86afb3e057b85e02a2d68332ae16b04a3b44349995a594ba78fbd5f8f6a02d0a7f0ffc5ee418c930036c0845ef1076d647233a3482893005ada91d86c
-  data.tar.gz: d018a62cdca9d060ccb110ee13f51064b718c792a20ae0a9f9b1eece38522572060b3cd338950385a0e17baed94ad10329f6519f6520788e81534d149c21cbf0
+  metadata.gz: 850bff5ac8a7b39f4574bfd77e6a9a20030a5c6bbc4dd03167839950cb52b8a365c928d54b261992634445eb081addb51103e178840d1899c8e49bf412cbaee2
+  data.tar.gz: 912ddbef4eb07b6a2f7587a64e27425cdf5f821a94bad31f9b56fd021f89960f34a37d885eaa9e04472c95eae56ae43025f414c872805ee935b6556b3e1cca91

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 Unreleased
 ------
 
+Version 2.2.0
+------
+* [#1424](https://github.com/Shopify/shopify-cli/pull/1424/): Add `--resourceUrl` flag to extension serve command
+* [#1419](https://github.com/Shopify/shopify-cli/pull/1419): Remove analytics prompt when used in CI
+* [#1418](https://github.com/Shopify/shopify-cli/pull/1418): Auto configure resource URL for Checkout Extensions
+* [#1399](https://github.com/Shopify/shopify-cli/pull/1399): Fix error when running `shopify extension serve` in a theme app extension project
+
+Version 2.1.0
+-------------
+* [#1357](https://github.com/Shopify/shopify-cli/pull/1357): Update Theme-Check to 1.1
+* [#1352](https://github.com/Shopify/shopify-cli/pull/1352): Add `shopify extension check` for checking theme app extensions
+* [#1304](https://github.com/Shopify/shopify-cli/pull/1304): Prompt user to run `shopify extension connect` if .env file is missing
+
+Version 2.0.2
+-------------
+* [#1305](https://github.com/Shopify/shopify-cli/pull/1305): Fix `Uninitialized constant Net::WriteTimeout` error
+* [#1319](https://github.com/Shopify/shopify-cli/pull/1319): Fix `theme pull` not pulling some files
+* [#1321](https://github.com/Shopify/shopify-cli/pull/1321): Fix error when pulling images with `theme pull`
+* [#1322](https://github.com/Shopify/shopify-cli/pull/1322): Fix error when running `shopify theme language-server --help`
+* [#1324](https://github.com/Shopify/shopify-cli/pull/1324): Fix issue [#1308](https://github.com/Shopify/shopify-cli/issues/1308) where a non-English language on Partner Account breaks how CLI determines latest API version.
+* [#1343](https://github.com/Shopify/shopify-cli/pull/1343): Fix inconsistent use of periods vs ellipsis in messages. This replaces periods with ellipsis.
+
+Version 2.0.1
+-------------
+* [#1295](https://github.com/Shopify/shopify-cli/pull/1295): Ignore files at the root of a theme app extension project
+* [#1296](https://github.com/Shopify/shopify-cli/pull/1296): Fix issue [#1294](https://github.com/Shopify/shopify-cli/issues/1294) regarding call to Windows `start` command with URL.
+* [#1298](https://github.com/Shopify/shopify-cli/pull/1298): Fix error in `theme serve` command
+* [#1301](https://github.com/Shopify/shopify-cli/pull/1301): Add `theme init` command
+
 Version 2.0.0
 -------------
 * Adds support for theme development

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.0.0)
+    shopify-cli (2.2.0)
       listen (~> 3.5)
-      theme-check (~> 1.0)
+      theme-check (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -76,7 +76,7 @@ GEM
     rubocop-shopify (2.0.1)
       rubocop (~> 1.11)
     ruby-progressbar (1.11.0)
-    theme-check (1.0.0)
+    theme-check (1.1.0)
       liquid (>= 5.0.1)
       nokogumbo
     timecop (0.9.2)
@@ -108,4 +108,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -101,9 +101,11 @@ Run:
 
 To start the server. The server includes hot reload for CSS & Sections.
 
+**Note:** Shopify CLI is the recommended and officially supported tool for developing themes and creating CI/CD workflows. Please refer to the [Theme Kit Migration Guide](https://github.com/Shopify/shopify-cli/blob/main/THEMEKIT_MIGRATION.md) for details.
+
 ### Contributing
 
-Shopify CLI is an [open source tool](https://github.com/Shopify/shopify-cli/blob/main/.github/LICENSE.md) and everyone is welcome to help the community by [contributing](https://github.com/Shopify/shopify-cli/blob/main/.github/CONTRIBUTING.md) to the project.
+Shopify CLI is an [open source tool](https://github.com/Shopify/shopify-cli/blob/main/LICENSE) and everyone is welcome to help the community by [contributing](https://github.com/Shopify/shopify-cli/blob/main/.github/CONTRIBUTING.md) to the project.
 
 ### Where to get help
 

data/RELEASING.md

@@ -15,6 +15,8 @@
 
 1. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
 
+1. Update the version of Shopify CLI at the top of `Gemfile.lock` (failing to do so causes the CI build to fail)
+
 1. Add an entry for the new release to `CHANGELOG.md`
 
 1. Commit the changes with a commit message like "Packaging for release X.Y.Z"

data/THEMEKIT_MIGRATION.md

@@ -0,0 +1,18 @@
+# Theme Kit Migration
+
+Shopify CLI is the recommended and officially supported tool for developing Themes and creating CI/CD workflows.
+
+This guide shows how to achieve equivalent flows with the new version of the CLI.
+
+## Equivalent commands
+
+| Theme Kit Command | Shopify CLI Equivalent | Objective |
+|---|---|---|
+|`theme deploy`|`shopify theme push`| Deploy a local (to the CLI) version of the Theme in the current working directory to a remote store.|
+|`theme new`|`shopify theme init`| Scaffold a new theme. In the case of the CLI it clones Dawn to be used as a reference Theme. Alternatively, it's possible to simply clone Dawn `git clone git@github.com:Shopify/dawn.git` and use it with the CLI.
+|`theme download`|`shopify theme pull`| Download your remote theme files.|
+|`theme watch` & `theme open` | `shopify theme serve` | Start a theme server to locally preview changes with CSS & Section hot reload enabled|
+|-| `shopify theme check`| Run the Theme Check linter on your theme codebase.|
+|-|`shopify theme publish`| Set a remote theme as the live theme.|
+|-|`shopify theme package`|Pack your Theme as a zip file ready for distribution and submission to the Theme Store.|
+|`theme remove`| `shopify theme delete`| Theme kit removes files from the Theme whereas Shopify CLI will remotely destroy the specified theme.|

data/lib/graphql/api_versions.graphql

@@ -1,6 +1,6 @@
 query {
   publicApiVersions {
     handle
-    displayName
+    supported
   }
 }

data/lib/graphql/get_variant_id.graphql

@@ -0,0 +1,16 @@
+query {
+  products(first: 1) {
+    edges {
+      node {
+        id
+        variants(first: 1) {
+          edges {
+            node {
+              id
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/project_types/extension/cli.rb

@@ -24,6 +24,7 @@ module Extension
     subcommand :Serve, "serve", Project.project_filepath("commands/serve")
     subcommand :Push, "push", Project.project_filepath("commands/push")
     subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
+    subcommand :Check, "check", Project.project_filepath("commands/check")
   end
   ShopifyCli::Commands.register("Extension::Command", "extension")
 
@@ -39,12 +40,14 @@ module Extension
     autoload :ChooseNextAvailablePort, Project.project_filepath("tasks/choose_next_available_port")
     autoload :FindNpmPackages, Project.project_filepath("tasks/find_npm_packages")
     autoload :GetExtensions, Project.project_filepath("tasks/get_extensions")
+    autoload :GetProduct, Project.project_filepath("tasks/get_product")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
       autoload :VersionConverter, Project.project_filepath("tasks/converters/version_converter")
       autoload :ValidationErrorConverter, Project.project_filepath("tasks/converters/validation_error_converter")
       autoload :AppConverter, Project.project_filepath("tasks/converters/app_converter")
+      autoload :ProductConverter, Project.project_filepath("tasks/converters/product_converter")
     end
   end
 
@@ -62,6 +65,12 @@ module Extension
   end
 
   module Features
+    module Runtimes
+      autoload :Admin, Project.project_filepath("features/runtimes/admin")
+      autoload :Base, Project.project_filepath("features/runtimes/base")
+      autoload :CheckoutPostPurchase, Project.project_filepath("features/runtimes/checkout_post_purchase")
+      autoload :CheckoutUiExtension, Project.project_filepath("features/runtimes/checkout_ui_extension")
+    end
     autoload :ArgoServe, Project.project_filepath("features/argo_serve")
     autoload :ArgoServeOptions, Project.project_filepath("features/argo_serve_options")
     autoload :ArgoSetup, Project.project_filepath("features/argo_setup")
@@ -76,7 +85,6 @@ module Extension
   module Models
     module SpecificationHandlers
       autoload :Default, Project.project_filepath("models/specification_handlers/default")
-      autoload :CheckoutArgoExtension, Project.project_filepath("models/specification_handlers/checkout_ui_extension")
     end
 
     autoload :App, Project.project_filepath("models/app")
@@ -87,6 +95,7 @@ module Extension
     autoload :Specifications, Project.project_filepath("models/specifications")
     autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
     autoload :NpmPackage, Project.project_filepath("models/npm_package")
+    autoload :Product, Project.project_filepath("models/product")
   end
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")

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/serve.rb

@@ -9,19 +9,24 @@ module Extension
 
       options do |parser, flags|
         parser.on("-t", "--[no-]tunnel", "Establish an ngrok tunnel") { |tunnel| flags[:tunnel] = tunnel }
+        parser.on("--resourceUrl=RESOURCE_URL", "Provide a resource URL") do |resource_url|
+          flags[:resource_url] = resource_url
+        end
       end
 
       class RuntimeConfiguration
         include SmartProperties
 
         property :tunnel_url, accepts: String, default: nil
+        property :resource_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
 
       def call(_args, _command_name)
         config = RuntimeConfiguration.new(
-          tunnel_requested: tunnel_requested?
+          tunnel_requested: tunnel_requested?,
+          resource_url: options.flags[:resource_url]
         )
 
         ShopifyCli::Result
@@ -74,7 +79,8 @@ module Extension
         specification_handler.serve(
           context: @ctx,
           tunnel_url: runtime_configuration.tunnel_url,
-          port: runtime_configuration.port
+          port: runtime_configuration.port,
+          resource_url: runtime_configuration.resource_url
         )
         runtime_configuration
       end

data/lib/project_types/extension/extension_project.rb

@@ -14,16 +14,43 @@ module Extension
         )
       end
 
+      def update_env_file(context:, **updates)
+        current_config = {
+          title: current.title,
+          shop: current.env.shop,
+          api_key: current.app.api_key,
+          api_secret: current.app.secret,
+          registration_id: current.registration_id,
+          registration_uuid: current.registration_uuid,
+          resource_url: current.resource_url,
+        }
+
+        write_env_file(
+          context: context,
+          **current_config,
+          **updates
+        )
+      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,
+        shop: nil
       )
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
+          shop: shop,
           extra: {
             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 +69,7 @@ module Extension
     end
 
     def app
+      validate_env_present
       Models::App.new(api_key: env["api_key"], secret: env["secret"])
     end
 
@@ -71,6 +99,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
@@ -96,9 +128,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

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

@@ -1,46 +1,14 @@
 module Extension
   module Features
     class ArgoRuntime
-      include SmartProperties
-
-      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,
+      RUNTIMES = [
+        Runtimes::Admin.new,
+        Runtimes::CheckoutPostPurchase.new,
+        Runtimes::CheckoutUiExtension.new,
       ]
 
-      CHECKOUT_RUN_FLAGS = [
-        :port,
-        :public_url,
-      ]
-
-      property! :renderer, accepts: Models::NpmPackage
-      property! :cli, accepts: Models::NpmPackage
-
-      def supports?(flag)
-        case cli
-        when admin?
-          ADMIN_RUN_FLAGS.include?(flag.to_sym)
-        when checkout?
-          CHECKOUT_RUN_FLAGS.include?(flag.to_sym)
-        end
-      end
-
-      private
-
-      def admin?
-        ->(cli) { cli.name == UI_EXTENSIONS_ADMIN_RUN }
-      end
-
-      def checkout?
-        ->(cli) { cli.name == UI_EXTENSIONS_CHECKOUT_RUN }
+      def self.find(cli_package:, identifier:)
+        RUNTIMES.find { |runtime| runtime.active_runtime?(cli_package, identifier) }
       end
     end
   end

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

@@ -7,11 +7,12 @@ module Extension
       NPM_SERVE_COMMAND = %w(run-script server)
 
       property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
-      property! :argo_runtime, accepts: Features::ArgoRuntime
+      property! :argo_runtime, accepts: -> (runtime) { runtime.class < Features::Runtimes::Base }
       property! :context, accepts: ShopifyCli::Context
       property! :port, accepts: Integer, default: 39351
       property  :tunnel_url, accepts: String, default: nil
       property! :js_system, accepts: ->(jss) { jss.respond_to?(:call) }, default: ShopifyCli::JsSystem
+      property :resource_url, accepts: String, default: nil
 
       def call
         validate_env!
@@ -22,6 +23,10 @@ module Extension
         end
       end
 
+      def resource_url
+        super || ExtensionProject.current(force_reload: true).resource_url
+      end
+
       private
 
       def start_server
@@ -57,6 +62,7 @@ module Extension
         ShopifyCli::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
 
         project = ExtensionProject.current
+        ensure_resource_resource_url! if specification_handler.supplies_resource_url?
 
         return if required_fields.all? do |field|
           value = project.env.public_send(field)
@@ -77,8 +83,31 @@ module Extension
           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)
+          options << "--resourceUrl=#{resource_url}" if !resource_url.nil? && argo_runtime.supports?(:resource_url)
         end
       end
+
+      def ensure_resource_resource_url!
+        project = ExtensionProject.current(force_reload: true)
+
+        ShopifyCli::Result
+          .wrap(project.resource_url)
+          .rescue { specification_handler.build_resource_url(shop: project.env.shop, context: context) }
+          .then(&method(:persist_resource_url))
+          .unwrap do |nil_or_exception|
+            case nil_or_exception
+            when nil
+              context.warn(context.message("warnings.resource_url_auto_generation_failed", project.env.shop))
+            else
+              context.abort(nil_or_exception)
+            end
+          end
+      end
+
+      def persist_resource_url(resource_url)
+        ExtensionProject.update_env_file(context: context, resource_url: resource_url)
+        resource_url
+      end
     end
   end
 end