shopify-cli 1.6.0 → 1.7.0

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

@@ -4,10 +4,11 @@ module Script
   module Commands
     class Create < ShopifyCli::SubCommand
       options do |parser, flags|
-        parser.on('--name=NAME') { |name| flags[:name] = name }
-        parser.on('--description=DESCRIPTION') { |description| flags[:description] = description }
-        parser.on('--extension_point=EP_NAME') { |ep_name| flags[:extension_point] = ep_name }
-        parser.on('--language=LANGUAGE') { |language| flags[:language] = language }
+        parser.on("--name=NAME") { |name| flags[:name] = name }
+        parser.on("--description=DESCRIPTION") { |description| flags[:description] = description }
+        parser.on("--extension_point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
+        parser.on("--extension-point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
+        parser.on("--language=LANGUAGE") { |language| flags[:language] = language }
       end
 
       def call(args, _name)
@@ -27,17 +28,17 @@ module Script
           extension_point_type: form.extension_point,
           description: form.description
         )
-        @ctx.puts(@ctx.message('script.create.change_directory_notice', project.script_name))
+        @ctx.puts(@ctx.message("script.create.change_directory_notice", project.script_name))
       rescue Script::Errors::ScriptProjectAlreadyExistsError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.create.error.operation_failed"))
       rescue StandardError => e
         ScriptProject.cleanup(ctx: @ctx, script_name: form.name, root_dir: cur_dir) if form
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.create.error.operation_failed"))
       end
 
       def self.help
         allowed_values = Script::Layers::Application::ExtensionPoints.types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCli::Context.message('script.create.help', ShopifyCli::TOOL_NAME, allowed_values.join(', '))
+        ShopifyCli::Context.message("script.create.help", ShopifyCli::TOOL_NAME, allowed_values.join(", "))
       end
     end
   end

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

@@ -12,13 +12,13 @@ module Script
           shop_domain: project.env[:shop],
           extension_point_type: project.extension_point_type
         )
-        @ctx.puts(@ctx.message('script.disable.script_disabled'))
+        @ctx.puts(@ctx.message("script.disable.script_disabled"))
       rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.disable.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.disable.error.operation_failed"))
       end
 
       def self.help
-        ShopifyCli::Context.message('script.disable.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("script.disable.help", ShopifyCli::TOOL_NAME)
       end
     end
   end

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

@@ -4,8 +4,10 @@ module Script
   module Commands
     class Enable < ShopifyCli::Command
       options do |parser, flags|
-        parser.on('--config_props=KEYVALUEPAIRS', Array) { |t| flags[:config_props] = t }
-        parser.on('--config_file=CONFIGFILEPATH') { |t| flags[:config_file] = t }
+        parser.on("--config_props=KEYVALUEPAIRS", Array) { |t| flags[:config_props] = t }
+        parser.on("--config-props=KEYVALUEPAIRS", Array) { |t| flags[:config_props] = t }
+        parser.on("--config_file=CONFIGFILEPATH") { |t| flags[:config_file] = t }
+        parser.on("--config-file=CONFIGFILEPATH") { |t| flags[:config_file] = t }
       end
 
       def call(_args, _name)
@@ -23,21 +25,21 @@ module Script
           title: project.script_name
         )
         @ctx.puts(@ctx.message(
-          'script.enable.script_enabled',
+          "script.enable.script_enabled",
           api_key: api_key,
           shop_domain: shop_domain,
           type: project.extension_point_type.capitalize,
           title: project.script_name
         ))
-        @ctx.puts(@ctx.message('script.enable.info'))
+        @ctx.puts(@ctx.message("script.enable.info"))
       rescue Errors::InvalidConfigYAMLError => e
         UI::ErrorHandler.pretty_print_and_raise(e)
       rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.enable.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.enable.error.operation_failed"))
       end
 
       def self.help
-        ShopifyCli::Context.message('script.enable.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("script.enable.help", ShopifyCli::TOOL_NAME)
       end
 
       private
@@ -62,7 +64,7 @@ module Script
       def parse_config_props(config_props)
         Hash[
           config_props.map do |s|
-            args = s.split(':').map(&:strip)
+            args = s.split(":").map(&:strip)
             raise Errors::InvalidConfigProps unless args.size == 2
             args
           end

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

@@ -4,7 +4,7 @@ module Script
   module Commands
     class Push < ShopifyCli::Command
       options do |parser, flags|
-        parser.on('--force') { |t| flags[:force] = t }
+        parser.on("--force") { |t| flags[:force] = t }
       end
 
       def call(_args, _name)
@@ -14,13 +14,14 @@ module Script
         return @ctx.puts(self.class.help) unless api_key
 
         Layers::Application::PushScript.call(ctx: @ctx, force: options.flags.key?(:force))
-        @ctx.puts(@ctx.message('script.push.script_pushed', api_key: api_key))
+        @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
       rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.push.error.operation_failed'))
+        msg = @ctx.message("script.push.error.operation_failed", api_key: ShopifyCli::Project.current.env.api_key)
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: msg)
       end
 
       def self.help
-        ShopifyCli::Context.message('script.push.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("script.push.help", ShopifyCli::TOOL_NAME)
       end
     end
   end

data/lib/project_types/script/errors.rb

@@ -4,6 +4,23 @@ module Script
   module Errors
     class InvalidContextError < ScriptProjectError; end
     class InvalidScriptNameError < ScriptProjectError; end
+
+    class InvalidConfigUiDefinitionError < ScriptProjectError
+      attr_reader :filename
+      def initialize(filename)
+        super()
+        @filename = filename
+      end
+    end
+
+    class MissingSpecifiedConfigUiDefinitionError < ScriptProjectError
+      attr_reader :filename
+      def initialize(filename)
+        super()
+        @filename = filename
+      end
+    end
+
     class NoExistingAppsError < ScriptProjectError; end
     class NoExistingOrganizationsError < ScriptProjectError; end
 

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

@@ -16,21 +16,21 @@ module Script
 
       def ask_extension_point
         CLI::UI::Prompt.ask(
-          @ctx.message('script.forms.create.select_extension_point'),
+          @ctx.message("script.forms.create.select_extension_point"),
           options: Layers::Application::ExtensionPoints.non_deprecated_types
         )
       end
 
       def ask_name
-        CLI::UI::Prompt.ask(@ctx.message('script.forms.create.script_name'))
+        CLI::UI::Prompt.ask(@ctx.message("script.forms.create.script_name"))
       end
 
       def ask_description
-        CLI::UI::Prompt.ask(@ctx.message('script.forms.create.description'))
+        CLI::UI::Prompt.ask(@ctx.message("script.forms.create.description"))
       end
 
       def valid_name
-        n = (name || ask_name).downcase.gsub(' ', '_')
+        n = (name || ask_name).downcase.gsub(" ", "_")
         return n if n.match?(/^[0-9A-Za-z_-]*$/)
         raise Errors::InvalidScriptNameError
       end
@@ -48,7 +48,7 @@ module Script
         return all_languages.first if all_languages.count == 1
 
         CLI::UI::Prompt.ask(
-          ctx.message('script.forms.create.select_language'),
+          ctx.message("script.forms.create.select_language"),
           options: all_languages
         )
       end

data/lib/project_types/script/graphql/app_script_update_or_create.graphql

@@ -2,6 +2,7 @@ mutation AppScriptUpdateOrCreate(
   $extensionPointName: ExtensionPointName!,
   $title: String,
   $description: String,
+  $configUi: String,
   $sourceCode: String,
   $language: String,
   $force: Boolean,
@@ -13,6 +14,7 @@ mutation AppScriptUpdateOrCreate(
     extensionPointName: $extensionPointName
     title: $title
     description: $description
+    configUi: $configUi
     sourceCode: $sourceCode
     language: $language
     force: $force

data/lib/project_types/script/layers/application/build_script.rb

@@ -5,19 +5,17 @@ module Script
     module Application
       class BuildScript
         class << self
-          def call(ctx:, task_runner:, script_name:, description:, extension_point_type:)
-            CLI::UI::Frame.open(ctx.message('script.application.building')) do
+          def call(ctx:, task_runner:, script_project:)
+            CLI::UI::Frame.open(ctx.message("script.application.building")) do
               begin
-                UI::StrictSpinner.spin(ctx.message('script.application.building_script')) do |spinner|
+                UI::StrictSpinner.spin(ctx.message("script.application.building_script")) do |spinner|
                   Infrastructure::PushPackageRepository.new(ctx: ctx).create_push_package(
-                    extension_point_type: extension_point_type,
-                    script_name: script_name,
-                    description: description,
+                    script_project: script_project,
                     script_content: task_runner.build,
                     compiled_type: task_runner.compiled_type,
-                    metadata: task_runner.metadata
+                    metadata: task_runner.metadata,
                   )
-                  spinner.update_title(ctx.message('script.application.built'))
+                  spinner.update_title(ctx.message("script.application.built"))
                 end
               rescue StandardError => e
                 CLI::UI::Frame.with_frame_color_override(:red) do

data/lib/project_types/script/layers/application/create_script.rb

@@ -40,9 +40,9 @@ module Script
           end
 
           def bootstrap(ctx, project_creator)
-            UI::StrictSpinner.spin(ctx.message('script.create.creating')) do |spinner|
+            UI::StrictSpinner.spin(ctx.message("script.create.creating")) do |spinner|
               project_creator.bootstrap
-              spinner.update_title(ctx.message('script.create.created'))
+              spinner.update_title(ctx.message("script.create.created"))
             end
           end
         end

data/lib/project_types/script/layers/application/disable_script.rb

@@ -5,14 +5,14 @@ module Script
     module Application
       class DisableScript
         def self.call(ctx:, api_key:, shop_domain:, extension_point_type:)
-          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.disabling')) do |p_ctx, spinner|
+          UI::PrintingSpinner.spin(ctx, ctx.message("script.application.disabling")) do |p_ctx, spinner|
             script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
             script_service.disable(
               api_key: api_key,
               shop_domain: shop_domain,
               extension_point_type: extension_point_type,
             )
-            spinner.update_title(p_ctx.message('script.application.disabled'))
+            spinner.update_title(p_ctx.message("script.application.disabled"))
           end
         end
       end

data/lib/project_types/script/layers/application/enable_script.rb

@@ -5,7 +5,7 @@ module Script
     module Application
       class EnableScript
         def self.call(ctx:, api_key:, shop_domain:, configuration:, extension_point_type:, title:)
-          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.enabling')) do |p_ctx, spinner|
+          UI::PrintingSpinner.spin(ctx, ctx.message("script.application.enabling")) do |p_ctx, spinner|
             script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
             script_service.enable(
               api_key: api_key,
@@ -14,7 +14,7 @@ module Script
               extension_point_type: extension_point_type,
               title: title
             )
-            spinner.update_title(p_ctx.message('script.application.enabled'))
+            spinner.update_title(p_ctx.message("script.application.enabled"))
           end
         end
       end

data/lib/project_types/script/layers/application/project_dependencies.rb

@@ -3,14 +3,14 @@ module Script
     module Application
       class ProjectDependencies
         def self.install(ctx:, task_runner:)
-          CLI::UI::Frame.open(ctx.message('script.project_deps.checking_with_npm')) do
+          CLI::UI::Frame.open(ctx.message("script.project_deps.checking_with_npm")) do
             begin
               if task_runner.dependencies_installed?
-                ctx.puts(ctx.message('script.project_deps.none_required'))
+                ctx.puts(ctx.message("script.project_deps.none_required"))
               else
-                UI::StrictSpinner.spin(ctx.message('script.project_deps.installing')) do |spinner|
+                UI::StrictSpinner.spin(ctx.message("script.project_deps.installing")) do |spinner|
                   task_runner.install_dependencies
-                  spinner.update_title(ctx.message('script.project_deps.installed'))
+                  spinner.update_title(ctx.message("script.project_deps.installed"))
                 end
               end
               true

data/lib/project_types/script/layers/application/push_script.rb

@@ -9,24 +9,16 @@ module Script
             script_project = ScriptProject.current
             task_runner = Infrastructure::TaskRunner.for(ctx, script_project.language, script_project.script_name)
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
-            BuildScript.call(
-              ctx: ctx,
-              task_runner: task_runner,
-              extension_point_type: script_project.extension_point_type,
-              script_name: script_project.script_name,
-              description: script_project.description
-            )
+            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project)
 
-            UI::PrintingSpinner.spin(ctx, ctx.message('script.application.pushing')) do |p_ctx, spinner|
+            UI::PrintingSpinner.spin(ctx, ctx.message("script.application.pushing")) do |p_ctx, spinner|
               package = Infrastructure::PushPackageRepository.new(ctx: p_ctx).get_push_package(
-                extension_point_type: script_project.extension_point_type,
-                script_name: script_project.script_name,
-                description: script_project.description,
+                script_project: script_project,
                 compiled_type: task_runner.compiled_type,
                 metadata: task_runner.metadata
               )
               package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
-              spinner.update_title(p_ctx.message('script.application.pushed'))
+              spinner.update_title(p_ctx.message("script.application.pushed"))
             end
           end
         end

data/lib/project_types/script/layers/domain/push_package.rb

@@ -8,6 +8,7 @@ module Script
           :extension_point_type,
           :script_name,
           :description,
+          :config_ui,
           :script_content,
           :compiled_type,
           :metadata
@@ -19,7 +20,8 @@ module Script
           description:,
           script_content:,
           compiled_type:,
-          metadata:
+          metadata:,
+          config_ui:
         )
           @id = id
           @extension_point_type = extension_point_type
@@ -28,6 +30,7 @@ module Script
           @script_content = script_content
           @compiled_type = compiled_type
           @metadata = metadata
+          @config_ui = config_ui
         end
 
         def push(script_service, api_key, force)
@@ -40,6 +43,7 @@ module Script
             api_key: api_key,
             force: force,
             metadata: @metadata,
+            config_ui: @config_ui,
           )
         end
       end

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

@@ -19,7 +19,7 @@ module Script
         end
 
         def bootstrap
-          type = extension_point.type.gsub('_', '-')
+          type = extension_point.type.gsub("_", "-")
           out, status = ctx.capture2e(format(BOOTSTRAP, extension_point: type, base: path_to_project))
           raise Domain::Errors::ServiceFailureError, out unless status.success?
         end
@@ -28,10 +28,10 @@ module Script
 
         def write_npmrc
           ctx.system(
-            'npm', '--userconfig', './.npmrc', 'config', 'set', '@shopify:registry', 'https://registry.npmjs.com'
+            "npm", "--userconfig", "./.npmrc", "config", "set", "@shopify:registry", "https://registry.npmjs.com"
           )
           ctx.system(
-            'npm', '--userconfig', './.npmrc', 'config', 'set', 'engine-strict', 'true'
+            "npm", "--userconfig", "./.npmrc", "config", "set", "engine-strict", "true"
           )
         end
 

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

@@ -40,7 +40,7 @@ module Script
 
         def metadata
           unless @ctx.file_exist?(METADATA_FILE)
-            msg = @ctx.message('script.error.metadata_not_found_cause', METADATA_FILE)
+            msg = @ctx.message("script.error.metadata_not_found_cause", METADATA_FILE)
             raise Domain::Errors::MetadataNotFoundError, msg
           end
 
@@ -54,7 +54,7 @@ module Script
           output, status = @ctx.capture2e("node", "--version")
           raise Errors::DependencyInstallError, output unless status.success?
 
-          require 'semantic/semantic'
+          require "semantic/semantic"
           version = ::Semantic::Version.new(output[1..-1])
           unless version >= ::Semantic::Version.new(AssemblyScriptProjectCreator::MIN_NODE_VERSION)
             raise Errors::DependencyInstallError,
@@ -71,8 +71,8 @@ module Script
         end
 
         def check_compilation_dependencies!
-          pkg = JSON.parse(File.read('package.json'))
-          build_script = pkg.dig('scripts', 'build')
+          pkg = JSON.parse(File.read("package.json"))
+          build_script = pkg.dig("scripts", "build")
 
           raise Errors::BuildScriptNotFoundError,
             "Build script not found" if build_script.nil?
@@ -93,23 +93,23 @@ module Script
         end
 
         def check_if_ep_dependencies_up_to_date!
-          return true if ENV['SHOPIFY_CLI_SCRIPTS_IGNORE_OUTDATED']
+          return true if ENV["SHOPIFY_CLI_SCRIPTS_IGNORE_OUTDATED"]
 
           # ignore exit code since it will not be 0 unless every package is up to date which they probably won't be
           out, _ = ctx.capture2e("npm", "outdated", "--json", "--depth", "0")
           parsed_outdated_check = JSON.parse(out)
           outdated_ep_packages = parsed_outdated_check
-            .select { |package_name, _| package_name.start_with?('@shopify/extension-point-as-') }
+            .select { |package_name, _| package_name.start_with?("@shopify/extension-point-as-") }
             .select { |_, version_info| !package_is_up_to_date?(version_info) }
             .keys
           raise Errors::PackagesOutdatedError.new(outdated_ep_packages),
-            "NPM packages out of date: #{outdated_ep_packages.join(', ')}" unless outdated_ep_packages.empty?
+            "NPM packages out of date: #{outdated_ep_packages.join(", ")}" unless outdated_ep_packages.empty?
         end
 
         def package_is_up_to_date?(version_info)
-          require 'semantic/semantic'
-          current_version = version_info['current']
-          latest_version = version_info['latest']
+          require "semantic/semantic"
+          current_version = version_info["current"]
+          latest_version = version_info["latest"]
 
           # making an assumption that the script developer knows what they're doing if they're not referencing a
           # semver version