shopify-cli 0.9.2 → 1.0.3

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

@@ -60,6 +60,8 @@ module Script
             raise Errors::AppScriptUndefinedError, api_key
           elsif user_errors.any? { |e| e['tag'] == 'shop_script_conflict' }
             raise Errors::ShopScriptConflictError
+          elsif user_errors.any? { |e| e['tag'] == 'app_script_not_pushed' }
+            raise Errors::AppScriptNotPushedError
           else
             raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
           end

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

@@ -18,8 +18,12 @@ module Script
           invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
           invalid_context_help: "See https://help.shopify.com",
 
+          invalid_script_name_cause: "Invalid script name.",
+          invalid_script_name_help: "Replace or remove unsupported characters. Valid characters "\
+                                    "are numbers, letters, hyphens, or underscores.",
+
           no_existing_apps_cause: "You don't have any apps.",
-          no_existing_apps_help: "Please create an app with {{command:shopify create}} or"\
+          no_existing_apps_help: "Please create an app with {{command:shopify create}} or "\
                                  "visit https://partners.shopify.com/.",
 
           no_existing_orgs_cause: "You don't have any partner organizations.",
@@ -38,6 +42,8 @@ module Script
 
           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.",
@@ -79,10 +85,9 @@ module Script
             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: {
@@ -92,7 +97,6 @@ module Script
           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.
           HELP
 
@@ -108,14 +112,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.",
@@ -128,8 +128,8 @@ module Script
           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.
+              \s\s{{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.
+              \s\s{{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 "\
@@ -138,6 +138,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}) "\
@@ -169,34 +170,29 @@ module Script
           create: {
             select_extension_point: "Which extension point do you want to use?",
             script_name: "Script Name",
-
-            error: {
-              invalid_name: "Invalid script name: replace or remove unsupported characters. Valid "\
-                            "characters are numbers, letters, spaces, hyphens, or underscores.",
-            },
           },
           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
@@ -36,14 +40,14 @@ module Script
 
     class << self
       def create(ctx, dir)
-        raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.exist?(dir)
+        raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.dir_exist?(dir)
         ctx.mkdir_p(dir)
         ctx.chdir(dir)
       end
 
       def cleanup(ctx:, script_name:, root_dir:)
         ctx.chdir(root_dir)
-        ctx.rm_r("#{root_dir}/#{script_name}") if ctx.exist?("#{root_dir}/#{script_name}")
+        ctx.rm_r("#{root_dir}/#{script_name}") if ctx.dir_exist?("#{root_dir}/#{script_name}")
       end
     end
   end

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/templates/ts/as-pect.d.ts

@@ -0,0 +1 @@
+/// <reference types="@as-pect/assembly/types/as-pect" />

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

@@ -44,6 +44,11 @@ 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::InvalidScriptNameError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.invalid_script_name_help'),
+          }
         when Errors::NoExistingAppsError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.no_existing_apps_cause'),
@@ -87,6 +92,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/shopify-cli/admin_api.rb

@@ -37,8 +37,7 @@ module ShopifyCli
       #
       #   ShopifyCli::AdminAPI.query(@ctx, 'all_organizations')
       #
-      def query(ctx, query_name, api_version: nil, shop: nil, **variables)
-        shop ||= Project.current.env.shop
+      def query(ctx, query_name, shop:, api_version: nil, **variables)
         authenticated_req(ctx, shop) do
           api_client(ctx, api_version, shop).query(query_name, variables: variables)
         end

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

@@ -41,6 +41,8 @@ module ShopifyCli
           return @ctx.puts(output)
         end
 
+        @shop ||= Project.current.env.shop || get_shop(@ctx)
+
         if @silent
           spin_group = CLI::UI::SpinGroup.new
           spin_group.add(@ctx.message('core.populate.populating', @count, camel_case_resource_type)) do |spinner|
@@ -114,7 +116,7 @@ module ShopifyCli
 
       def run_mutation(data)
         kwargs = { input: data }
-        kwargs[:shop] = @shop if @shop
+        kwargs[:shop] = @shop
         resp = AdminAPI.query(
           @ctx, "create_#{snake_case_resource_type}", kwargs
         )
@@ -145,6 +147,13 @@ module ShopifyCli
 
       private
 
+      def get_shop(ctx)
+        res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
+        domain = res[:shop_domain]
+        Project.current.env.update(ctx, :shop, domain)
+        domain
+      end
+
       def camel_case_resource_type
         @camel_case_resource_type ||= self.class.to_s.split('::').last
       end

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

@@ -3,15 +3,27 @@ require 'shopify_cli'
 module ShopifyCli
   class AdminAPI
     class Schema < Hash
-      def self.get(ctx)
-        unless ShopifyCli::DB.exists?(:shopify_admin_schema)
-          schema = AdminAPI.query(ctx, 'admin_introspection')
-          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)

data/lib/shopify-cli/command.rb

@@ -3,12 +3,13 @@ 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
 
       def call(args, command_name)
         subcommand, resolved_name = subcommand_registry.lookup_command(args.first)
@@ -23,10 +24,6 @@ module ShopifyCli
         end
       end
 
-      def hidden_command
-        @hidden = true
-      end
-
       def options(&block)
         @_options = block
       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

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

@@ -6,7 +6,7 @@ module ShopifyCli
       def call(*)
         project_type = ask_project_type unless Project.has_current?
 
-        if Project.has_current? && Project.current
+        if Project.has_current? && Project.current && Project.current.env
           @ctx.puts @ctx.message('core.connect.already_connected_warning')
           prod_warning = @ctx.message('core.connect.production_warning')
           @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
@@ -20,13 +20,13 @@ module ShopifyCli
 
         org = fetch_org
         id = org['id']
-        app = get_app(org['apps'])
+        app = get_app(id, org['apps'])
         shop = get_shop(org['stores'], id)
 
         write_env(app, shop, env_data[:scopes], env_data[:extra])
         write_cli_yml(project_type, id) unless Project.has_current?
 
-        @ctx.puts(@ctx.message('core.connect.connected', app.first['title']))
+        @ctx.puts(@ctx.message('core.connect.connected', app['title']))
       end
 
       def ask_project_type
@@ -54,15 +54,22 @@ module ShopifyCli
         org
       end
 
-      def get_app(apps)
-        app_id = if apps.count == 1
-          apps.first["id"]
+      def get_app(org_id, apps)
+        if apps.count == 1
+          apps.first
+        elsif apps.count == 0
+          @ctx.puts(@ctx.message('core.connect.no_apps'))
+          title = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_name'))
+          type = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_type.select')) do |handler|
+            handler.option(@ctx.message('core.connect.app_type.select_public')) { 'public' }
+            handler.option(@ctx.message('core.connect.app_type.select_custom')) { 'custom' }
+          end
+          ShopifyCli::Tasks::CreateApiClient.call(@ctx, org_id: org_id, title: title, type: type)
         else
           CLI::UI::Prompt.ask(@ctx.message('core.connect.app_select')) do |handler|
-            apps.each { |app| handler.option(app["title"]) { app["id"] } }
+            apps.each { |app| handler.option(app["title"]) { app } }
           end
         end
-        apps.select { |app| app["id"] == app_id }
       end
 
       def get_shop(shops, id)
@@ -83,8 +90,8 @@ module ShopifyCli
         extra = {} if extra.nil?
 
         Resources::EnvFile.new(
-          api_key: app.first["apiKey"],
-          secret: app.first["apiSecretKeys"].first["secret"],
+          api_key: app["apiKey"],
+          secret: app["apiSecretKeys"].first["secret"],
           shop: shop,
           scopes: scopes,
           extra: extra,