shopify-cli 2.11.0 → 2.12.0

data/lib/project_types/script/layers/infrastructure/languages/assemblyscript_task_runner.rb

@@ -4,17 +4,16 @@ module Script
   module Layers
     module Infrastructure
       module Languages
-        class AssemblyScriptTaskRunner
+        class AssemblyScriptTaskRunner < TaskRunner
+          NODE_MIN_VERSION = "14.15.0"
+          NPM_MIN_VERSION = "5.2.0"
+
           BYTECODE_FILE = "build/script.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
-
-          attr_reader :ctx, :script_name
-
-          def initialize(ctx, script_name)
-            @ctx = ctx
-            @script_name = script_name
-          end
+          NPM_SET_REGISTRY_COMMAND = "npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com"
+          NPM_SET_ENGINE_STRICT_COMMAND = "npm --userconfig ./.npmrc config set engine-strict true"
+          NPM_INSTALL_COMMAND = "npm install --no-audit --no-optional --legacy-peer-deps --loglevel error"
 
           def build
             compile
@@ -22,10 +21,10 @@ module Script
           end
 
           def install_dependencies
-            check_node_version!
+            run_cmd_with_env_check(NPM_INSTALL_COMMAND)
 
-            output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
-            raise Errors::DependencyInstallError, output unless status.success?
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::DependencyInstallError, e.out
           end
 
           def dependencies_installed?
@@ -38,14 +37,32 @@ module Script
           end
 
           def library_version(library_name)
-            output = JSON.parse(CommandRunner.new(ctx: ctx).call("npm -s list --json"))
+            output = JSON.parse(run_cmd_with_env_check("npm -s list --json"))
             library_version_from_npm_list(output, library_name)
           rescue Errors::SystemCallFailureError => error
             library_version_from_npm_list_error_output(error, library_name)
           end
 
+          def set_npm_config
+            run_cmd_with_env_check(NPM_SET_REGISTRY_COMMAND)
+            run_cmd_with_env_check(NPM_SET_ENGINE_STRICT_COMMAND)
+          end
+
           private
 
+          def ensure_environment
+            return if defined?(@environment_checked)
+            @environment_checked = true
+
+            ToolVersionChecker.check_node(minimum_version: NODE_MIN_VERSION)
+            ToolVersionChecker.check_npm(minimum_version: NPM_MIN_VERSION)
+          end
+
+          def run_cmd_with_env_check(cmd)
+            ensure_environment
+            CommandRunner.new(ctx: ctx).call(cmd)
+          end
+
           def library_version_from_npm_list_error_output(error, library_name)
             # npm list can return a failure status code, even when returning the correct data.
             # This causes the CommandRunner to throw a SystemCallFailure error that contains the data.
@@ -64,22 +81,9 @@ module Script
             end
           end
 
-          def check_node_version!
-            output, status = @ctx.capture2e("node", "--version")
-            raise Errors::DependencyInstallError, output unless status.success?
-
-            require "semantic/semantic"
-            version = ::Semantic::Version.new(output[1..-1])
-            unless version >= ::Semantic::Version.new(AssemblyScriptProjectCreator::MIN_NODE_VERSION)
-              raise Errors::DependencyInstallError,
-                "Node version must be >= v#{AssemblyScriptProjectCreator::MIN_NODE_VERSION}. "\
-                "Current version: #{output.strip}."
-            end
-          end
-
           def compile
             check_compilation_dependencies!
-            CommandRunner.new(ctx: ctx).call(SCRIPT_SDK_BUILD)
+            run_cmd_with_env_check(SCRIPT_SDK_BUILD)
           end
 
           def check_compilation_dependencies!

data/lib/project_types/script/layers/infrastructure/languages/task_runner.rb

@@ -5,15 +5,41 @@ module Script
     module Infrastructure
       module Languages
         class TaskRunner
-          TASK_RUNNERS = {
-            "assemblyscript" => AssemblyScriptTaskRunner,
-            "typescript" => TypeScriptTaskRunner,
-            "wasm" => WasmTaskRunner,
-          }
-
-          def self.for(ctx, language, script_name)
-            raise Errors::TaskRunnerNotFoundError unless TASK_RUNNERS[language]
-            TASK_RUNNERS[language].new(ctx, script_name)
+          attr_reader :ctx
+
+          def self.for(ctx, language)
+            task_runners = {
+              "assemblyscript" => AssemblyScriptTaskRunner,
+              "typescript" => TypeScriptTaskRunner,
+              "wasm" => WasmTaskRunner,
+            }
+
+            raise Errors::TaskRunnerNotFoundError unless task_runners[language]
+            task_runners[language].new(ctx)
+          end
+
+          def initialize(ctx)
+            @ctx = ctx
+          end
+
+          def build
+            raise NotImplementedError
+          end
+
+          def dependencies_installed?
+            raise NotImplementedError
+          end
+
+          def install_dependencies
+            raise NotImplementedError
+          end
+
+          def metadata_file_location
+            raise NotImplementedError
+          end
+
+          def library_version(_library_name)
+            raise NotImplementedError
           end
         end
       end

data/lib/project_types/script/layers/infrastructure/languages/tool_version_checker.rb

@@ -0,0 +1,26 @@
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class ToolVersionChecker
+          class << self
+            def check_node(minimum_version:)
+              check_version("node", ShopifyCLI::Environment.node_version, minimum_version)
+            end
+
+            def check_npm(minimum_version:)
+              check_version("npm", ShopifyCLI::Environment.npm_version, minimum_version)
+            end
+
+            private
+
+            def check_version(tool, env_version, minimum_version)
+              return if env_version >= ::Semantic::Version.new(minimum_version)
+              raise Errors::InvalidEnvironmentError.new(tool, env_version, minimum_version)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/script/layers/infrastructure/languages/typescript_project_creator.rb

@@ -5,18 +5,15 @@ module Script
     module Infrastructure
       module Languages
         class TypeScriptProjectCreator < ProjectCreator
-          MIN_NODE_VERSION = "14.15.0"
-          NPM_SET_REGISTRY_COMMAND = "npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com"
-          NPM_SET_ENGINE_STRICT_COMMAND = "npm --userconfig ./.npmrc config set engine-strict true"
-
           def self.config_file
             "package.json"
           end
 
           def setup_dependencies
+            task_runner = Infrastructure::Languages::TypeScriptTaskRunner.new(ctx)
+            task_runner.set_npm_config
+
             super
-            command_runner.call(NPM_SET_REGISTRY_COMMAND)
-            command_runner.call(NPM_SET_ENGINE_STRICT_COMMAND)
 
             if ctx.file_exist?("yarn.lock")
               ctx.rm("yarn.lock")

data/lib/project_types/script/layers/infrastructure/languages/typescript_task_runner.rb

@@ -4,18 +4,17 @@ module Script
   module Layers
     module Infrastructure
       module Languages
-        class TypeScriptTaskRunner
+        class TypeScriptTaskRunner < TaskRunner
+          NODE_MIN_VERSION = "14.15.0"
+          NPM_MIN_VERSION = "5.2.0"
+
           BYTECODE_FILE = "build/index.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
           GEN_METADATA = "npm run gen-metadata"
-
-          attr_reader :ctx, :script_name
-
-          def initialize(ctx, script_name)
-            @ctx = ctx
-            @script_name = script_name
-          end
+          NPM_SET_REGISTRY_COMMAND = "npm --userconfig ./.npmrc config set @shopify:registry https://registry.npmjs.com"
+          NPM_SET_ENGINE_STRICT_COMMAND = "npm --userconfig ./.npmrc config set engine-strict true"
+          NPM_INSTALL_COMMAND = "npm install --no-audit --no-optional --legacy-peer-deps --loglevel error"
 
           def build
             compile
@@ -23,10 +22,10 @@ module Script
           end
 
           def install_dependencies
-            check_node_version!
+            run_cmd_with_env_check(NPM_INSTALL_COMMAND)
 
-            output, status = ctx.capture2e("npm install --no-audit --no-optional --legacy-peer-deps --loglevel error")
-            raise Errors::DependencyInstallError, output unless status.success?
+          rescue Errors::SystemCallFailureError => e
+            raise Errors::DependencyInstallError, e.out
           end
 
           def dependencies_installed?
@@ -39,14 +38,32 @@ module Script
           end
 
           def library_version(library_name)
-            output = JSON.parse(CommandRunner.new(ctx: ctx).call("npm -s list --json"))
+            output = JSON.parse(run_cmd_with_env_check("npm -s list --json"))
             library_version_from_npm_list(output, library_name)
           rescue Errors::SystemCallFailureError => error
             library_version_from_npm_list_error_output(error, library_name)
           end
 
+          def set_npm_config
+            run_cmd_with_env_check(NPM_SET_REGISTRY_COMMAND)
+            run_cmd_with_env_check(NPM_SET_ENGINE_STRICT_COMMAND)
+          end
+
           private
 
+          def ensure_environment
+            return if defined?(@environment_checked)
+            @environment_checked = true
+
+            ToolVersionChecker.check_node(minimum_version: NODE_MIN_VERSION)
+            ToolVersionChecker.check_npm(minimum_version: NPM_MIN_VERSION)
+          end
+
+          def run_cmd_with_env_check(cmd)
+            ensure_environment
+            CommandRunner.new(ctx: ctx).call(cmd)
+          end
+
           def library_version_from_npm_list_error_output(error, library_name)
             # npm list can return a failure status code, even when returning the correct data.
             # This causes the CommandRunner to throw a SystemCallFailure error that contains the data.
@@ -65,23 +82,10 @@ module Script
             end
           end
 
-          def check_node_version!
-            output, status = @ctx.capture2e("node", "--version")
-            raise Errors::DependencyInstallError, output unless status.success?
-
-            require "semantic/semantic"
-            version = ::Semantic::Version.new(output[1..-1])
-            unless version >= ::Semantic::Version.new(TypeScriptProjectCreator::MIN_NODE_VERSION)
-              raise Errors::DependencyInstallError,
-                "Node version must be >= v#{TypeScriptProjectCreator::MIN_NODE_VERSION}. "\
-            "Current version: #{output.strip}."
-            end
-          end
-
           def compile
             check_compilation_dependencies!
-            CommandRunner.new(ctx: ctx).call(SCRIPT_SDK_BUILD)
-            CommandRunner.new(ctx: ctx).call(GEN_METADATA)
+            run_cmd_with_env_check(SCRIPT_SDK_BUILD)
+            run_cmd_with_env_check(GEN_METADATA)
           end
 
           def check_compilation_dependencies!

data/lib/project_types/script/layers/infrastructure/languages/wasm_task_runner.rb

@@ -4,19 +4,15 @@ module Script
   module Layers
     module Infrastructure
       module Languages
-        class WasmTaskRunner
+        class WasmTaskRunner < TaskRunner
           BYTECODE_FILE = "script.wasm"
-          attr_reader :ctx, :script_name
-
-          def initialize(ctx, script_name)
-            @ctx = ctx
-            @script_name = script_name
-          end
 
           def dependencies_installed?
             true
           end
 
+          def install_dependencies; end
+
           def library_version(_library_name)
             nil
           end

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

@@ -20,21 +20,22 @@ module Script
         project.env = env
         project
       rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
-        handle_error(error, context: context, env_file_present: env_file_present)
+        handle_error(error, context: context)
       end
 
-      def self.handle_error(error, context:, env_file_present:)
-        if env_file_present
+      def self.handle_error(error, context:)
+        if ShopifyCLI::Environment.interactive?
           properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
           missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          raise ShopifyCLI::Abort,
-            context.message("script.error.missing_env_file_variables", missing_env_variables, ShopifyCLI::TOOL_NAME)
+          message = context.message("script.error.missing_env_file_variables", missing_env_variables)
+          message += context.message("script.error.missing_env_file_variables_solution", ShopifyCLI::TOOL_NAME)
         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,
-            ShopifyCli::TOOL_NAME)
+          message = context.message("script.error.missing_push_options_ci", missing_options)
+          message += context.message("script.error.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
         end
+        raise ShopifyCLI::Abort, message
       end
 
       def self.env_file_exists?(directory)

data/lib/project_types/script/messages/messages.rb

@@ -113,6 +113,10 @@ module Script
           dependency_install_cause: "Something went wrong while installing the needed dependencies.",
           dependency_install_help: "Correct the errors.",
 
+          invalid_environment_cause: "Your environment %{tool} version, %{env_version}, "\
+                                     "is too low. It must be at least %{minimum_version}.",
+          invalid_environment_help: "Update %{tool}.",
+
           failed_api_request_cause: "Something went wrong while communicating with Shopify.",
           failed_api_request_help: "Try again.",
 
@@ -149,12 +153,14 @@ module Script
 
           language_library_for_api_not_found_cause: "Script can’t be pushed because the %{language} library for API %{api} is missing.",
           language_library_for_api_not_found_help: "Make sure extension_point.yml contains the correct API library.",
-          no_scripts_found_in_app: "The selected apps have no scripts. Create them first on the partners' dashboard.",
-          missing_env_file_variables: "The following variables are missing in the .env file: %s."\
-            " This can occur when the script hasn't been connected to an app."\
-            " To connect the script to an app, run {{command:%s script connect}}",
-          missing_push_options: "The following options are missing from .env: %s."\
-            " Run {{command:%s script connect}} to connect the script to an app and generate these options.",
+          no_scripts_found_in_app: "The selected apps have no scripts. Please, create them first on the partners' dashboard.",
+          missing_push_options_ci: "The following are missing: %s. ",
+          missing_push_options_ci_solution: "To add them to a CI environment:\n\t1. Run a connect command " \
+          "({{command:%1$s script connect}})\n\t2. Navigate to the .env file at the root of your project\n\t" \
+          "3. Copy the missing values and pass them through as arguments in {{command:%1$s script push}}",
+          missing_env_file_variables: "The following are missing in the .env file: %s. ",
+          missing_env_file_variables_solution: "To add it, connect your script with " \
+          "{{command:%1$s script connect}} ",
         },
 
         create: {
@@ -164,7 +170,7 @@ module Script
               Options:
                 {{command:--name=NAME}} Script project name.
                 {{command:--api=TYPE}} Script API name. Supported values: %2$s.
-                {{command:--language=LANGUAGE}} Programming language. Supported values: %3$s.
+                {{command:--language=LANGUAGE}} Programming language. Defaults to wasm. Supported values: %3$s.
           HELP
 
           error: {
@@ -191,9 +197,7 @@ module Script
           HELP
 
           error: {
-            operation_failed_no_uuid: "UUID is required to push in a CI environment.",
-            operation_failed_with_api_key: "Couldn't push script to app (API key: %{api_key}).",
-            operation_failed_no_api_key: "Couldn't push script to app.",
+            operation_failed: "Couldn't push script to app.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
@@ -206,8 +210,6 @@ module Script
           HELP
           error: {
             operation_failed: "Couldn't connect script to app.",
-            missing_env_file_variables: "The following variables are missing in the .env file: %s."\
-            " To connect the script to an app, enter the value into the .env file or delete the .env file, and then run {{command:%s script connect}}",
           },
         },
         javy: {
@@ -233,7 +235,6 @@ module Script
         forms: {
           create: {
             select_extension_point: "Which Script API do you want to use?",
-            select_language: "Which language do you want to use?",
             script_name: "What do you want to name your script?",
           },
         },

data/lib/project_types/script/ui/error_handler.rb

@@ -237,6 +237,19 @@ module Script
             ),
             help_suggestion: ShopifyCLI::Context.message("script.error.graphql_error_help"),
           }
+        when Layers::Infrastructure::Errors::InvalidEnvironmentError
+          {
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.invalid_environment_cause",
+              tool: e.tool,
+              env_version: e.env_version,
+              minimum_version: e.minimum_version,
+            ),
+            help_suggestion: ShopifyCLI::Context.message(
+              "script.error.invalid_environment_help",
+              tool: e.tool,
+            ),
+          }
         when Layers::Infrastructure::Errors::SystemCallFailureError
           {
             cause_of_error: ShopifyCLI::Context

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

@@ -4,7 +4,6 @@ require "theme_check"
 module Theme
   class Command
     class Check < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       class Options < ShopifyCLI::Options

data/lib/project_types/theme/commands/common/root_helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Theme
+  class Command
+    module Common
+      module RootHelper
+        def root_value(options, name)
+          argv = default_argv(options)
+          command_index = argv.index(name.to_s)
+
+          return "." if command_index.nil?
+
+          next_index = command_index + 1
+          option_by_key = options_map(options)
+
+          while next_index < argv.size
+            element = argv[next_index]
+            option = option_by_key[element]
+
+            return element if option.nil?
+
+            # Skip the option argument
+            next_index += 1 unless option.arg.nil?
+
+            # PATTERN arguments take precedence over the `root`
+            if option.arg =~ /PATTERN/
+              next_index += 1 while option_argument?(argv, next_index, option_by_key)
+              next
+            end
+
+            next_index += 1
+          end
+
+          "."
+        end
+
+        private
+
+        def default_argv(options)
+          options.parser.default_argv
+        end
+
+        def options_map(options)
+          map = {}
+          options_list(options).each do |option|
+            map[option.short.first] = option
+            map[option.long.first] = option
+          end
+          map
+        end
+
+        def options_list(options)
+          options.parser.top.list
+        end
+
+        def option_argument?(argv, next_index, option_by_key)
+          return false unless next_index < argv.size
+
+          element = argv[next_index]
+          option_by_key[element].nil?
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,6 @@ require "shopify_cli/theme/development_theme"
 module Theme
   class Command
     class Delete < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       options do |parser, flags|

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

@@ -3,13 +3,14 @@
 module Theme
   class Command
     class Init < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       options do |parser, flags|
         parser.on("-u", "--clone-url URL") { |url| flags[:clone_url] = url }
       end
 
+      prerequisite_task :ensure_git_dependency
+
       DEFAULT_CLONE_URL = "https://github.com/Shopify/dawn.git"
 
       def call(args, _name)

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

@@ -4,7 +4,6 @@ require "theme_check"
 module Theme
   class Command
     class LanguageServer < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       def call(*)

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

@@ -5,7 +5,6 @@ require "json"
 module Theme
   class Command
     class Package < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       THEME_DIRECTORIES = %w[

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

@@ -4,7 +4,6 @@ require "shopify_cli/theme/theme"
 module Theme
   class Command
     class Publish < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
       recommend_default_ruby_range
 
       options do |parser, flags|

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

@@ -1,38 +1,46 @@
 # frozen_string_literal: true
 require "shopify_cli/theme/theme"
+require "shopify_cli/theme/development_theme"
 require "shopify_cli/theme/ignore_filter"
 require "shopify_cli/theme/include_filter"
 require "shopify_cli/theme/syncer"
+require "project_types/theme/commands/common/root_helper"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
 
 module Theme
   class Command
     class Pull < ShopifyCLI::Command::SubCommand
-      recommend_default_node_range
+      include Common::RootHelper
+
       recommend_default_ruby_range
 
       options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
         parser.on("-n", "--nodelete") { flags[:nodelete] = true }
         parser.on("-i", "--themeid=ID") { |theme_id| flags[:theme_id] = theme_id }
         parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
         parser.on("-l", "--live") { flags[:live] = true }
         parser.on("-d", "--development") { flags[:development] = true }
-        parser.on("-o", "--only=PATTERN") do |pattern|
+        parser.on("-o", "--only=PATTERN", Conversions::IncludeGlob) do |pattern|
           flags[:includes] ||= []
-          flags[:includes] << pattern
+          flags[:includes] += pattern
         end
-        parser.on("-x", "--ignore=PATTERN") do |pattern|
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
           flags[:ignores] ||= []
-          flags[:ignores] << pattern
+          flags[:ignores] += pattern
         end
       end
 
-      def call(args, _name)
-        root = args.first || "."
+      def call(_args, name)
+        root = root_value(options, name)
         delete = !options.flags[:nodelete]
         theme = find_theme(root, **options.flags)
         return if theme.nil?
 
-        include_filter = ShopifyCLI::Theme::IncludeFilter.new(options.flags[:includes])
+        include_filter = ShopifyCLI::Theme::IncludeFilter.new(root, options.flags[:includes])
         ignore_filter = ShopifyCLI::Theme::IgnoreFilter.from_path(root)
         ignore_filter.add_patterns(options.flags[:ignores]) if options.flags[:ignores]
 
@@ -74,7 +82,8 @@ module Theme
         end
 
         if development
-          return ShopifyCLI::Theme::Theme.development(@ctx, root: root)
+          dev_theme = ShopifyCLI::Theme::DevelopmentTheme.find(@ctx, root: root)
+          return dev_theme || @ctx.abort(@ctx.message("theme.pull.theme_not_found", "development"))
         end
 
         select_theme(root)