shopify-cli 1.0.2 → 1.1.1

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

@@ -38,10 +38,15 @@ module Script
           invalid_extension_cause: "Invalid extension point %s",
           invalid_extension_help: "Allowed values: %s.",
 
+          invalid_config: "Can't change the configuration values because %1$s is missing or "\
+                          "it is not formatted properly.",
+
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
           app_not_installed_cause: "App not installed on development store.",
 
+          app_script_not_pushed_help: "Push the script and then try this command again.",
+
           app_script_undefined_help: "Push script to app.",
 
           build_error_cause: "Something went wrong while building the script.",
@@ -72,32 +77,26 @@ module Script
           help: <<~HELP,
           {{command:%1$s create script}}: Creates a script project.
             Usage: {{command:%1$s create script}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--name=NAME}} Script project name. Use any string.
-              \s\s{{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
+            Options:
+              {{command:--name=NAME}} Script project name. Use any string.
+              {{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
           HELP
 
           error: {
             operation_failed: "Script not created.",
           },
 
-          script_path: "{{v}} Project directory: {{green:%{folder}}}",
-          script_created: "{{v}} Script created: {{green:%{script_id}}}",
+          change_directory_notice: "{{*}} Change directories to {{green:%s}} to run script commands",
           creating: "Creating script",
-          created: "Created script",
+          created: "Created script: {{green:%s}}",
         },
 
         push: {
           help: <<~HELP,
           Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
             Usage: {{command:%s push}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+            Options:
+              {{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
           HELP
 
           error: {
@@ -112,14 +111,10 @@ module Script
           Turn off script in development store.
             Usage: {{command:%s disable}}
           HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
-          HELP
 
           error: {
             operation_failed: "Can't disable script.",
+            not_pushed_to_app: "Can't disable the script because it hasn't been pushed to the app.",
           },
 
           script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
@@ -129,11 +124,9 @@ module Script
           help: <<~HELP,
           Turn on script in development store.
             Usage: {{command:%s enable}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
+            Options:
+              {{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
+              {{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config_props values override properties in this file.
           HELP
 
           info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
@@ -142,6 +135,7 @@ module Script
 
           error: {
             operation_failed: "Can't enable script.",
+            not_pushed_to_app: "Can't enable the script because it hasn't been pushed to the app.",
           },
 
           script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
@@ -177,25 +171,25 @@ module Script
           script_form: {
             ask_app_api_key_default: "Which app do you want this script to belong to?",
             ask_shop_domain_default: "Select a development store",
-            fetching_organizations: "{{i}} Fetching partner organizations",
+            fetching_organizations: "Fetching partner organizations",
+            fetched_organizations: "Fetched partner organizations",
             select_organization: "Select partner organization.",
             using_app: "Using app {{green:%{title} (%{api_key})}}.",
             using_development_store: "Using development store {{green:%{domain}}}",
             using_organization: "Partner organization {{green:%s}}.",
           },
-          enable: {
-            ask_app_api_key: "Which app is the script pushed to?",
-            ask_shop_domain: "Which development store is the app installed on?",
-          },
         },
 
         application: {
           building: "Building",
           building_script: "Building script",
           built: "Built",
-          pushed: "{{v}} Pushed",
-          disabled: "{{v}} Disabled",
-          enabled: "{{v}} Enabled",
+          pushing: "Pushing",
+          pushed: "Pushed",
+          disabling: "Disabling",
+          disabled: "Disabled",
+          enabling: "Enabling",
+          enabled: "Enabled",
         },
       },
     }.freeze

data/lib/project_types/script/script_project.rb

@@ -19,12 +19,16 @@ module Script
       }
     end
 
+    def file_name
+      "script.#{language}"
+    end
+
     def source_file
       "#{SOURCE_DIR}/#{file_name}"
     end
 
-    def file_name
-      "script.#{language}"
+    def source_path
+      "#{script_name}/#{source_file}"
     end
 
     private

data/lib/project_types/script/templates/ts/as-pect.config.js

@@ -17,5 +17,11 @@ module.exports = {
         reportMax: false,
         reportMin: false,
     },
+    wasi: {
+      args: [],
+      env: process.env,
+      preopens: {},
+      returnOnExit: false,
+    },
     outputBinary: false,
 };

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

@@ -44,6 +44,10 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidConfigYAMLError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_config', e.config_file),
+          }
         when Errors::InvalidScriptNameError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),
@@ -92,6 +96,10 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
+          }
         when Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Script
+  module UI
+    module PrintingSpinner
+      ##
+      # Creates a single spinner that runs the provided block.
+      # The block can take in a ctx argument that formats printed output to support
+      # printing from within the spin block.
+      #
+      # ==== Attributes
+      #
+      # * +ctx+   - The current context.
+      # * +title+ - Title of the spinner to use
+      #
+      # ==== Options
+      #
+      # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+      #
+      # ==== Block
+      #
+      # * +ctx+     - Instance of the PrintingSpinnerContext built from the ctx attribute.
+      #             - +ctx.puts(...)+ formats output to enable support for printing within spinners
+      # * +spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
+      #
+      def self.spin(ctx, title, auto_debrief: false)
+        StrictSpinner.spin(title, auto_debrief: auto_debrief) do |spinner, *args|
+          Thread.current[:cliui_output_hook] = nil
+          yield(PrintingSpinnerContext.from(ctx, spinner), spinner, *args)
+        end
+      end
+
+      ##
+      # Printing within spinners requires the manipulation of ANSI escape
+      # sequences in order to make sure the CLI::UI::Spinner does not overwrite
+      # previously printed content.
+      class PrintingSpinnerContext < ShopifyCli::Context
+        include SmartProperties
+        property :spinner, required: true
+
+        def self.from(ctx, spinner)
+          new_ctx = new(spinner: spinner)
+          ctx.instance_variables.each do |var|
+            new_ctx.instance_variable_set(var, ctx.instance_variable_get(var))
+          end
+          new_ctx
+        end
+
+        def puts(*input)
+          super(encoded_lines(*input) + "\n" + spinner_text)
+        end
+
+        private
+
+        def encoded_lines(*lines)
+          lines
+            .join("\n")
+            .split("\n")
+            .map { |line| encode_ansi(line) unless line.nil? }
+            .join(CLI::UI::ANSI.next_line + "\n")
+        end
+
+        def encode_ansi(line)
+          CLI::UI::ANSI.previous_line + line + CLI::UI::ANSI.clear_to_end_of_line
+        end
+
+        def spinner_text
+          spinner.render(0, true)
+        end
+      end
+      private_constant(:PrintingSpinnerContext)
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -1,17 +1,25 @@
 Gem.post_uninstall do |uninstaller|
   if uninstaller.spec.name == 'shopify-cli'
-    require 'fileutils'
+    if RUBY_PLATFORM.match(/mingw32/)
+      bat_path = File.dirname(RbConfig.ruby)
+      bat = "#{bat_path}\\shopify.bat"
 
-    symlink = '/usr/local/bin/shopify'
+      # delete the auto-generated batch script
+      File.unlink(bat)
+    else
+      require 'fileutils'
 
-    # delete the symbolic link IFF it exists AND it does not point to a file
-    # (i.e., it's been left hanging as a result of the uninstall, as expected)
-    #
-    # if the file still exists, either the uninstall failed (possible but
-    # unlikely) OR
-    # there's another installation of the gem in another ruby folder that has
-    # overwritten it, so leave the symbolic link alone
-    system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+      symlink = '/usr/local/bin/shopify'
+
+      # delete the symbolic link IFF it exists AND it does not point to a file
+      # (i.e., it's been left hanging as a result of the uninstall, as expected)
+      #
+      # if the file still exists, either the uninstall failed (possible but
+      # unlikely) OR
+      # there's another installation of the gem in another ruby folder that has
+      # overwritten it, so leave the symbolic link alone
+      system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+    end
   end
 
   true

data/lib/shopify-cli/admin_api/populate_resource_command.rb

@@ -118,7 +118,7 @@ module ShopifyCli
         kwargs = { input: data }
         kwargs[:shop] = @shop
         resp = AdminAPI.query(
-          @ctx, "create_#{snake_case_resource_type}", kwargs
+          @ctx, "create_#{snake_case_resource_type}", **kwargs
         )
         @ctx.abort(resp['errors']) if resp['errors']
         @ctx.done(message(resp['data'])) unless @silent

data/lib/shopify-cli/admin_api/schema.rb

@@ -3,16 +3,27 @@ require 'shopify_cli'
 module ShopifyCli
   class AdminAPI
     class Schema < Hash
-      def self.get(ctx)
-        unless ShopifyCli::DB.exists?(:shopify_admin_schema)
-          shop = Project.current.env.shop || get_shop(@ctx)
-          schema = AdminAPI.query(ctx, 'admin_introspection', shop: shop)
-          ShopifyCli::DB.set(shopify_admin_schema: JSON.dump(schema))
+      class << self
+        def get(ctx)
+          unless ShopifyCli::DB.exists?(:shopify_admin_schema)
+            shop = Project.current.env.shop || get_shop(ctx)
+            schema = AdminAPI.query(ctx, 'admin_introspection', shop: shop)
+            ShopifyCli::DB.set(shopify_admin_schema: JSON.dump(schema))
+          end
+          # This is ruby magic for making a new hash with another hash.
+          # It wraps the JSON in our Schema Class to have the helper methods
+          # available
+          self[JSON.parse(ShopifyCli::DB.get(:shopify_admin_schema))]
+        end
+
+        private
+
+        def get_shop(ctx)
+          res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
+          domain = res[:shop_domain]
+          Project.current.env.update(ctx, :shop, domain)
+          domain
         end
-        # This is ruby magic for making a new hash with another hash.
-        # It wraps the JSON in our Schema Class to have the helper methods
-        # available
-        self[JSON.parse(ShopifyCli::DB.get(:shopify_admin_schema))]
       end
 
       def type(name)
@@ -28,15 +39,6 @@ module ShopifyCli
           object["name"]
         end
       end
-
-      private
-
-      def get_shop(ctx)
-        res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
-        domain = res[:shop_domain]
-        Project.current.env.update(ctx, :shop, domain)
-        domain
-      end
     end
   end
 end

data/lib/shopify-cli/command.rb

@@ -3,30 +3,29 @@ require 'shopify_cli'
 
 module ShopifyCli
   class Command < CLI::Kit::BaseCommand
+    extend Feature::Set
+
     attr_writer :ctx
     attr_accessor :options
 
     class << self
-      attr_writer :ctx
-      attr_reader :hidden
+      attr_writer :ctx, :task_registry
 
       def call(args, command_name)
         subcommand, resolved_name = subcommand_registry.lookup_command(args.first)
         if subcommand
           subcommand.ctx = @ctx
+          subcommand.task_registry = @task_registry
           subcommand.call(args, resolved_name, command_name)
         else
           cmd = new(@ctx)
           cmd.options.parse(@_options, args)
           return call_help(command_name) if cmd.options.help
+          run_prerequisites
           cmd.call(args, command_name)
         end
       end
 
-      def hidden_command
-        @hidden = true
-      end
-
       def options(&block)
         @_options = block
       end
@@ -44,13 +43,16 @@ module ShopifyCli
       end
 
       def prerequisite_task(*tasks)
-        tasks.each do |task|
-          prerequisite_tasks[task] = ShopifyCli::Tasks::Registry[task]
-        end
+        @prerequisite_tasks ||= []
+        @prerequisite_tasks += tasks
+      end
+
+      def run_prerequisites
+        (@prerequisite_tasks || []).each { |task| task_registry[task]&.call(@ctx) }
       end
 
-      def prerequisite_tasks
-        @prerequisite_tasks ||= {}
+      def task_registry
+        @task_registry || ShopifyCli::Tasks::Registry
       end
 
       def call_help(*cmds)
@@ -60,6 +62,7 @@ module ShopifyCli
     end
 
     def initialize(ctx = nil)
+      super()
       @ctx = ctx || ShopifyCli::Context.new
       self.options = Options.new
     end

data/lib/shopify-cli/commands.rb

@@ -18,6 +18,7 @@ module ShopifyCli
       @core_commands.include?(cmd)
     end
 
+    register :Config, 'config', 'shopify-cli/commands/config', true
     register :Connect, 'connect', 'shopify-cli/commands/connect', true
     register :Create, 'create', 'shopify-cli/commands/create', true
     register :Help, 'help', 'shopify-cli/commands/help', true

data/lib/shopify-cli/commands/config.rb

@@ -0,0 +1,44 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  module Commands
+    class Config < ShopifyCli::Command
+      hidden_feature(feature_set: :debug)
+
+      subcommand :Feature, 'feature'
+
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        ShopifyCli::Context.message('core.config.help', ShopifyCli::TOOL_NAME)
+      end
+
+      class Feature < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(args, _name)
+          feature_name = args.shift
+          return @ctx.puts(@ctx.message('core.config.help', ShopifyCli::TOOL_NAME)) if feature_name.nil?
+          is_enabled = ShopifyCli::Feature.enabled?(feature_name)
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Feature.disable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Feature.enable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.feature.is_enabled', feature_name))
+          else
+            @ctx.puts(@ctx.message('core.config.feature.is_disabled', feature_name))
+          end
+        end
+      end
+    end
+  end
+end