shopify-cli 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cd807b7755484c50b506a5b4af90072b08ac0f9fc2aaff6c684f0fe5e6b63cc
-  data.tar.gz: 76aaf43ba5f6af3a6c9ed5f2f73b0d79cb03261d544602996b9563cd45f4b572
+  metadata.gz: 9944385de970a522f54fcf4e8feffa5bcab8ad61498095a1794c5abcf5918063
+  data.tar.gz: 62b23eb1ab82cf0783ccab14d77b55c3e71595d87581795fff19227c4bcada57
 SHA512:
-  metadata.gz: 407ad8f61eebbfcfbf4c6099eef78a41544ed95002cf7f91fbd9cd56aa473cc1ab6ea323812032c3f21d09760bdcd824908ce9ba1f069ed492997b0cdf3d5853
-  data.tar.gz: 91ae64882ee0e7969bf93697dda900fb812009df58eeff176833e3e609e51f37fa67f418c1b80be670f852a6594308fc0e89e43a477105b316943827f80ad780
+  metadata.gz: 72ec8ee4a02bb2b7cd6f9d58c094625bba0e1971a1d2e81d86920e8b326ff8fb52bac73b2a7afec43f7e67991b239bd7ac11c43a2df70790ecd82cf6c4614db2
+  data.tar.gz: e456bb338bfa6102cf8643455b983a147a0fdef6fb820a5ee46dd210e6cbde788de6053727c48ab44057a7ad920a8b765651bfd09a26735b4db8525dc6f247b1

data/.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,117 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: <YOUR ISSUE TITLE>"
+labels: ["type:bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |-
+        Hi! 👋 Thanks for taking the time to open an issue.
+
+        ## Before you begin
+  - type: checkboxes
+    id: preflight_checks
+    attributes:
+      label: |-
+        Please confirm that you have:
+      options:
+        - label: Searched [existing issues](https://github.com/Shopify/shopify-cli/issues) to see if your issue is a duplicate. (If you’ve found a duplicate issue, feel free to add additional information in a comment on it.)
+          required: true
+        - label: Reproduced the issue in [the latest CLI version](https://github.com/Shopify/shopify-cli/releases).
+          required: true
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: '## General Questions'
+  - type: dropdown
+    id: app_type
+    attributes:
+      label: What type of project are you working on?
+      options:
+        - app
+        - extension
+        - script
+        - theme
+        - other
+    validations:
+      required: true
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected behavior
+      description: What do you think should have happened?
+      placeholder: It should have worked
+    validations:
+      required: true
+  - type: textarea
+    id: actual_behavior
+    attributes:
+      label: Actual behavior
+      description: What actually happened?
+      placeholder: It didn't work
+    validations:
+      required: true
+  - type: textarea
+    id: stack_trace
+    attributes:
+      label: Stack trace
+      description: Paste in a stack trace if you've got one!
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    id: repro_steps
+    attributes:
+      label: Reproduction steps
+      description: Let us know the exact steps required to reproduce the error. The more detail, the better!
+      value: |-
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment Details
+
+        Just a few more technical questions, to help us understand if your bug is linked to a particular runtime enviroment.
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      placeholder: Windows 11, Mac OS Monterey, Ubuntu 20.04...
+    validations:
+      required: true
+  - type: input
+    id: cli_version
+    attributes:
+      label: CLI version (run `shopify version` if you're not sure)
+      placeholder: 2.10.0
+    validations:
+      required: true
+  - type: input
+    id: shell
+    attributes:
+      label: Shell
+      placeholder: Cygwin, Git Bash, iTerm2, bash, zsh...
+  - type: input
+    id: ruby_version
+    attributes:
+      label: Ruby version (run `ruby -v` if you're not sure)
+      placeholder: 3.0.2p107
+  - type: input
+    id: other_versions
+    attributes:
+      label: What language and version are you using in your application?
+      placeholder: Ruby 3.0.3, Node 17.1, PHP 7.4...
+  - type: markdown
+    attributes:
+      value: |-
+
+        ## What to Expect
+
+        When you submit this issue, it will go to a Shopify developer experience team. We may not be able to reply right away, but we usually respond within a week.
+
+        We always value your feedback. Thanks again for taking the time to help improve the CLI for everyone!

data/.github/ISSUE_TEMPLATE/enhancement.yaml

@@ -0,0 +1,38 @@
+name: Enhancement
+description: Enhancement to our codebase that isn't a adding or changing a feature
+title: "[Enhancement]: <YOUR ENHANCEMENT>"
+labels: ["type:enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |-
+        Hi! 👋 Thanks for taking the time to open an issue.
+
+        While we can't promise we'll implement your request, we'll certainly look it over and take your needs into consideration.
+  - type: dropdown
+    id: app_type
+    attributes:
+      label: What type of project(s) will this request affect?
+      options:
+        - app
+        - extension
+        - script
+        - theme
+        - other
+      multiple: true
+    validations:
+      required: true
+  - type: textarea
+    id: overview
+    attributes:
+      label: Overview
+      description: Describe in your own words the change you'd like to be made to the CLI.
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: What inspired this request? What problems were you facing?
+    validations:
+      required: true

data/.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,47 @@
+name: Feature Request
+description: Suggest a new feature, or changes to an existing one
+title: "[Feature]: <YOUR FEATURE>"
+labels: ["type:feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |-
+        Hi! 👋 Thanks for taking the time to open an issue.
+
+        While we can't promise we'll implement your request, we'll certainly look it over and take your needs into consideration.
+  - type: dropdown
+    id: app_type
+    attributes:
+      label: What type of project(s) will this request affect?
+      options:
+        - app
+        - extension
+        - script
+        - theme
+        - other
+      multiple: true
+    validations:
+      required: true
+  - type: dropdown
+    id: type
+    attributes:
+      label: What type of change do you want to see?
+      options:
+        - New feature
+        - Substantial change to existing feature
+    validations:
+      required: true
+  - type: textarea
+    id: overview
+    attributes:
+      label: Overview
+      description: Describe in your own words the feature you'd like to be added to the CLI.
+    validations:
+      required: true
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: What inspired this feature request? What problems were you facing?
+    validations:
+      required: true

data/CHANGELOG.md

@@ -2,10 +2,27 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## Version 2.11.0
+
+### Fixed
+* [#2005](https://github.com/Shopify/shopify-cli/pull/2005): Fix PHP app serve on Windows environments
+
+### Added
+* [#1998](https://github.com/Shopify/shopify-cli/pull/1998): Add support for Rails 7
+* [#1945](https://github.com/Shopify/shopify-cli/pull/1945): Check Node and Ruby versions and warn the user if their environment's version might be incompatible with the version the command expects.
+* [#2011](https://github.com/Shopify/shopify-cli/pull/2011): Adds support for the Spin rewrite
+
+### Changed
+* [#2001](https://github.com/Shopify/shopify-cli/pull/2001): Improve Bug Issue Template. Includes autofill of CLI/Ruby/environment information.
+* [#2004](https://github.com/Shopify/shopify-cli/pull/2004): Template improvements II. Includes autofill of Shell if $SHELL is set.
+* [#2002](https://github.com/Shopify/shopify-cli/pull/2002): Update `-o`/`--only` parameter to allow multiple patterns on `theme push`/`theme pull` commands
+* [#2022](https://github.com/Shopify/shopify-cli/pull/2022): Don't warn the user if the Ruby version is in the range 3.0.x.
+
 ## Version 2.10.2
 ### Fixed
 * [#1983](https://github.com/Shopify/shopify-cli/pull/1983): Improve Windows compatibility
 * [#1928](https://github.com/Shopify/shopify-cli/pull/1928): Ensure script Wasm file sizes don't exceed the limit
+* [#2006](https://github.com/Shopify/shopify-cli/pull/2006): Fix: More defensive URL generation
 
 ## Version 2.10.1
 ### Fixed
@@ -73,7 +90,7 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 * [#1769](https://github.com/Shopify/shopify-cli/pull/1769): Fix `theme push --development --json` to output the proper exit code
 * [#1766](https://github.com/Shopify/shopify-cli/pull/1766): Fix `theme serve` failing with the `--host` property
 * [#1771](https://github.com/Shopify/shopify-cli/pull/1771): Fix `theme push --development --json` to output errors in the STDERR
-* [#1778](https://github.com/Shopify/shopify-cli/pull/1778): Fix ngrok installation check on Windows 
+* [#1778](https://github.com/Shopify/shopify-cli/pull/1778): Fix ngrok installation check on Windows
 * [#1798](https://github.com/Shopify/shopify-cli/pull/1798): Add `--live` option to the `theme pull` and the `theme push` commands
 * [#1788](https://github.com/Shopify/shopify-cli/pull/1788): Improve `theme serve` errors and add logs for successful operations
 * [#1794](https://github.com/Shopify/shopify-cli/pull/1794): Fix bug where hidden subcommands appear in the help menu.
@@ -82,7 +99,7 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 ### Fixed
 * [#1722](https://github.com/Shopify/shopify-cli/pull/1722): Fix `theme serve` failing when the port is already being used
 * [#1751](https://github.com/Shopify/shopify-cli/pull/1751): A bug in the app creation flow that caused the CLI to abort when the form validation failed.
-* [#1750](https://github.com/Shopify/shopify-cli/pull/1750): Runtime errors in Windows' environments when the `PATHEXT` environment variable is not defined. 
+* [#1750](https://github.com/Shopify/shopify-cli/pull/1750): Runtime errors in Windows' environments when the `PATHEXT` environment variable is not defined.
 * [#1758](https://github.com/Shopify/shopify-cli/pull/1758): Fix tunnel creation for expired anonymous tunnels
 
 ## Version 2.7.0
@@ -100,7 +117,7 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 ### Fixed
 * [#1678](https://github.com/Shopify/shopify-cli/pull/1678): Fix migrator's incompatibility with Ruby 2.5.
 * [#1690](https://github.com/Shopify/shopify-cli/pull/1690): Fix `extension push` command for `PRODUCT_SUBSCRIPTION` extensions
-  
+
 ### Changed
 * [#1678](https://github.com/Shopify/shopify-cli/pull/1678): Change the `@shopify/scripts-checkout-apis-temp` package name to `@shopify/scripts-discount-apis`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.10.2)
+    shopify-cli (2.11.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.9.0)

data/dev.yml

@@ -28,3 +28,6 @@ test:
 commands:
   style:
     run: bundle exec rubocop .
+  test:script:
+    desc: "Run all script-related tests"
+    run: TEST='test/project_types/script/**/*.rb' bundle exec rake test $@

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

@@ -8,6 +8,9 @@ module Extension
 
       prerequisite_task ensure_project_type: :extension
 
+      recommend_default_node_range
+      recommend_default_ruby_range
+
       YARN_BUILD_COMMAND = %w(build)
       NPM_BUILD_COMMAND = %w(run-script build)
 

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

@@ -4,6 +4,9 @@ require "theme_check"
 module Extension
   class Command
     class Check < ExtensionCommand
+      recommend_default_node_range
+      recommend_default_ruby_range
+
       class CheckOptions < ShopifyCLI::Options
         def initialize(ctx, theme_check)
           super()

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

@@ -5,6 +5,9 @@ module Extension
     class Create < ShopifyCLI::Command::SubCommand
       prerequisite_task :ensure_authenticated
 
+      recommend_default_node_range
+      recommend_default_ruby_range
+
       options do |parser, flags|
         parser.on("--name=NAME") { |name| flags[:name] = name }
         parser.on("--template=TEMPLATE") { |template| flags[:template] = template }

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

@@ -6,6 +6,9 @@ module Extension
     class Push < ShopifyCLI::Command::SubCommand
       prerequisite_task ensure_project_type: :extension
 
+      recommend_default_node_range
+      recommend_default_ruby_range
+
       options do |parser, flags|
         parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }
         parser.on("--api-secret=API_SECRET") { |api_secret| flags[:api_secret] = api_secret.gsub('"', "") }

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

@@ -5,6 +5,9 @@ module Extension
     class Serve < ExtensionCommand
       prerequisite_task ensure_project_type: :extension
 
+      recommend_default_node_range
+      recommend_default_ruby_range
+
       DEFAULT_PORT = 39351
 
       options do |parser, flags|

data/lib/project_types/extension/models/specification_handlers/default.rb

@@ -108,7 +108,7 @@ module Extension
         end
 
         def server_config_file
-          "shopifile.yml"
+          "extension.config.yml"
         end
 
         protected

data/lib/project_types/extension/tasks/convert_server_config.rb

@@ -17,6 +17,8 @@ module Extension
       property  :tunnel_url, accepts: String
       property! :type, accepts: String
 
+      DEFAULT_BUILD_DIR = "build"
+
       def self.call(*args)
         new(*args).call
       end
@@ -31,7 +33,7 @@ module Extension
           type: type.upcase,
           user: Models::ServerConfig::User.new,
           development: Models::ServerConfig::Development.new(
-            build_dir: hash.dig("development", "build_dir"),
+            build_dir: hash.dig("development", "build_dir") || DEFAULT_BUILD_DIR,
             renderer: renderer,
             entries: Models::ServerConfig::DevelopmentEntries.new(
               main: hash.dig("development", "entries", "main")

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

@@ -5,6 +5,8 @@ module Script
       prerequisite_task :ensure_authenticated
       prerequisite_task ensure_project_type: :script
 
+      recommend_default_ruby_range
+
       def call(_args, _)
         Layers::Application::ConnectApp.call(ctx: @ctx, force: true)
       rescue StandardError => e
@@ -12,7 +14,7 @@ module Script
       end
 
       def self.help
-        ShopifyCLI::Context.new.message("connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        ShopifyCLI::Context.new.message("script.connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
     end
   end

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

@@ -5,6 +5,8 @@ module Script
     class Create < ShopifyCLI::Command::SubCommand
       prerequisite_task :ensure_authenticated
 
+      recommend_default_ruby_range
+
       options do |parser, flags|
         parser.on("--name=NAME") { |name| flags[:name] = name }
         parser.on("--api=API_NAME") { |ep_name| flags[:extension_point] = ep_name }

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

@@ -5,6 +5,12 @@ module Script
     class Push < ShopifyCLI::Command::SubCommand
       prerequisite_task ensure_project_type: :script
 
+      recommend_node(
+        from: ::Script::Layers::Infrastructure::Languages::TypeScriptProjectCreator::MIN_NODE_VERSION,
+        to: ShopifyCLI::Constants::SupportedVersions::Node::TO
+      )
+      recommend_default_ruby_range
+
       options do |parser, flags|
         parser.on("--force") { |t| flags[:force] = t }
         parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }

data/lib/project_types/script/layers/infrastructure/errors.rb

@@ -7,10 +7,11 @@ module Script
         class BuildError < ScriptProjectError; end
 
         class ScriptConfigurationDefinitionError < ScriptProjectError
-          attr_reader :filename
-          def initialize(message:, filename:)
+          attr_reader :filename, :messages
+          def initialize(messages:, filename:)
+            super()
+            @messages = messages
             @filename = filename
-            super(message)
           end
         end
 

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -50,9 +50,9 @@ module Script
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
-          elsif (e = user_errors.find { |err| err["tag"] == "configuration_definition_error" })
+          elsif (errors = user_errors.select { |err| err["tag"] == "configuration_definition_error" }).any?
             raise Errors::ScriptConfigurationDefinitionError.new(
-              message: e["message"],
+              messages: errors.map { |e| e["message"] },
               filename: script_config.filename,
             )
           elsif (e = user_errors.any? { |err| err["tag"] == "configuration_definition_syntax_error" })

data/lib/project_types/script/loaders/project.rb

@@ -32,7 +32,8 @@ module Script
         else
           properties_hash = { api_key: "--api-key", secret: "--api-secret" }
           missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          raise ShopifyCLI::Abort, context.message("script.error.missing_push_options", missing_options)
+          raise ShopifyCLI::Abort, context.message("script.error.missing_push_options", missing_options,
+            ShopifyCli::TOOL_NAME)
         end
       end