shopify-cli 1.4.0 → 1.7.1

data/docs/help/start-app/index.md

@@ -1,6 +1,4 @@
 ---
-title: Start your app
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-Your app is not running, and no app URL has been set. Try running `shopify serve` in your project to get started.

data/docs/index.md

@@ -1,26 +1,4 @@
 ---
-title: Introduction
-section: intro
-toc: false
+title: Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli
 ---
-
-Shopify App CLI helps you build Shopify apps faster. It quickly scaffolds Node.js and Ruby on Rails apps, and automates many common development tasks.
-
-**[Get started with Shopify App CLI]({{ site.baseurl }}{% link getting-started/index.md %})**
-
-## Quick start
-
-1. [Install Shopify App CLI]({{ site.baseurl }}{% link getting-started/install/index.md %}).
-2. Create an app:
-    ```console
-    $ shopify create
-    ```
-3. Start and install your app on a Shopify development store:
-    ```console
-    $ shopify serve
-    ```
-    ```console
-    $ shopify open
-    ```
-
-**[Learn more in our Getting Started guide]({{ site.baseurl }}{% link getting-started/index.md %})**

data/ext/shopify-cli/extconf.rb

@@ -1,8 +1,8 @@
-require 'rbconfig'
-require 'fileutils'
+require "rbconfig"
+require "fileutils"
 
-gem = File.expand_path('../../../', __FILE__)
-exe = File.join(gem, 'bin', 'shopify')
+gem = File.expand_path("../../../", __FILE__)
+exe = File.join(gem, "bin", "shopify")
 
 if RUBY_PLATFORM.match(/mingw32/)
   bat_path = File.dirname(RbConfig.ruby)
@@ -22,8 +22,8 @@ if RUBY_PLATFORM.match(/mingw32/)
     \t echo "#{script_content}">> "#{bat}"
   MAKEFILE
 else
-  script = exe + '.sh'
-  symlink = '/usr/local/bin/shopify'
+  script = exe + ".sh"
+  symlink = "/usr/local/bin/shopify"
 
   script_content = <<~SCRIPT
     #!/usr/bin/env bash
@@ -44,4 +44,4 @@ else
   MAKEFILE
 end
 
-File.write('Makefile', makefile_content)
+File.write("Makefile", makefile_content)

data/install.sh

@@ -3,5 +3,5 @@
 This install method for Shopify App CLI is no longer supported.
 
 Please visit this page for complete instructions:
-  https://shopify.github.io/shopify-app-cli/migrate/
+  https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version
 EOF

data/lib/docgen/markdown.rb

@@ -1,5 +1,5 @@
-require 'rdoc/rdoc'
-require 'erb'
+require "rdoc/rdoc"
+require "erb"
 
 module RDoc
   module Generator
@@ -26,13 +26,13 @@ module RDoc
       private
 
       def render(data)
-        class_template_path = File.join(File.dirname(__FILE__), 'class_template.md.erb')
-        class_renderer = ERB.new(File.read(class_template_path), nil, '-')
+        class_template_path = File.join(File.dirname(__FILE__), "class_template.md.erb")
+        class_renderer = ERB.new(File.read(class_template_path), nil, "-")
         data.each do |cls|
           File.write("#{cls.filename}.md", class_renderer.result(cls.instance_eval { binding }))
         end
-        index_template_path = File.join(File.dirname(__FILE__), 'index_template.md.erb')
-        index_renderer = ERB.new(File.read(index_template_path), nil, '-')
+        index_template_path = File.join(File.dirname(__FILE__), "index_template.md.erb")
+        index_renderer = ERB.new(File.read(index_template_path), nil, "-")
         File.write("Core-APIs.md", index_renderer.result(OpenStruct.new(classes: data).instance_eval { binding }))
       end
 
@@ -46,8 +46,8 @@ module RDoc
             kind: kind,
             comment: @converter.convert(klass.comment.parse),
             constants: build_members(klass.constants),
-            class_methods: build_members(klass.method_list.select { |m| m.type == 'class' }),
-            instance_methods: build_members(klass.method_list.select { |m| m.type == 'instance' }),
+            class_methods: build_members(klass.method_list.select { |m| m.type == "class" }),
+            instance_methods: build_members(klass.method_list.select { |m| m.type == "instance" }),
             attributes: build_members(klass.attributes),
             extended: build_members(klass.extends),
             included: build_members(klass.includes),
@@ -68,7 +68,7 @@ module RDoc
           ClassMember.new(
             title:     m.name,
             comment:   @converter.convert(m.comment.parse),
-            signature: m.respond_to?(:arglists) ? m.arglists : '',
+            signature: m.respond_to?(:arglists) ? m.arglists : "",
             source_code: source(m),
           )
         end
@@ -77,7 +77,7 @@ module RDoc
       # Just extracts sourcecode from html formatting/highlighting into a text
       # blob so that markdown can format it with a codeblock
       def source(m)
-        return '' unless m.respond_to?(:token_stream)
+        return "" unless m.respond_to?(:token_stream)
         # each line, get the text
         src = (m.token_stream || []).map do |t|
           next unless t
@@ -93,7 +93,7 @@ module RDoc
           indent = n if n < indent
           break if n == 0
         end
-        src.gsub!(/^#{' ' * indent}/, '') if indent > 0
+        src.gsub!(/^#{' ' * indent}/, "") if indent > 0
         src
       end
     end

data/lib/project_types/extension/cli.rb

@@ -3,75 +3,92 @@
 module Extension
   class Project < ShopifyCli::ProjectType
     hidden_feature
-    creator 'App Extension', 'Extension::Commands::Create'
+    title("App Extension")
+    creator("Extension::Commands::Create")
 
-    register_command('Extension::Commands::Build', "build")
-    register_command('Extension::Commands::Register', "register")
-    register_command('Extension::Commands::Push', "push")
-    register_command('Extension::Commands::Serve', "serve")
-    register_command('Extension::Commands::Tunnel', "tunnel")
+    register_command("Extension::Commands::Build", "build")
+    register_command("Extension::Commands::Register", "register")
+    register_command("Extension::Commands::Push", "push")
+    register_command("Extension::Commands::Serve", "serve")
+    register_command("Extension::Commands::Tunnel", "tunnel")
 
-    require Project.project_filepath('messages/messages')
-    require Project.project_filepath('messages/message_loading')
-    require Project.project_filepath('extension_project_keys')
+    require Project.project_filepath("messages/messages")
+    require Project.project_filepath("messages/message_loading")
+    require Project.project_filepath("extension_project_keys")
     register_messages(Extension::Messages::MessageLoading.load)
   end
 
   module Commands
-    autoload :ExtensionCommand, Project.project_filepath('commands/extension_command')
-    autoload :Create, Project.project_filepath('commands/create')
-    autoload :Register, Project.project_filepath('commands/register')
-    autoload :Build, Project.project_filepath('commands/build')
-    autoload :Serve, Project.project_filepath('commands/serve')
-    autoload :Push, Project.project_filepath('commands/push')
-    autoload :Tunnel, Project.project_filepath('commands/tunnel')
+    autoload :ExtensionCommand, Project.project_filepath("commands/extension_command")
+    autoload :Create, Project.project_filepath("commands/create")
+    autoload :Register, Project.project_filepath("commands/register")
+    autoload :Build, Project.project_filepath("commands/build")
+    autoload :Serve, Project.project_filepath("commands/serve")
+    autoload :Push, Project.project_filepath("commands/push")
+    autoload :Tunnel, Project.project_filepath("commands/tunnel")
   end
 
   module Tasks
-    autoload :UserErrors, Project.project_filepath('tasks/user_errors')
-    autoload :GetApps, Project.project_filepath('tasks/get_apps')
-    autoload :GetApp, Project.project_filepath('tasks/get_app')
-    autoload :CreateExtension, Project.project_filepath('tasks/create_extension')
-    autoload :UpdateDraft, Project.project_filepath('tasks/update_draft')
+    autoload :UserErrors, Project.project_filepath("tasks/user_errors")
+    autoload :GetApps, Project.project_filepath("tasks/get_apps")
+    autoload :GetApp, Project.project_filepath("tasks/get_app")
+    autoload :CreateExtension, Project.project_filepath("tasks/create_extension")
+    autoload :UpdateDraft, Project.project_filepath("tasks/update_draft")
+    autoload :FetchSpecifications, Project.project_filepath("tasks/fetch_specifications")
+    autoload :ConfigureFeatures, Project.project_filepath("tasks/configure_features")
 
     module Converters
-      autoload :RegistrationConverter, Project.project_filepath('tasks/converters/registration_converter')
-      autoload :VersionConverter, Project.project_filepath('tasks/converters/version_converter')
-      autoload :ValidationErrorConverter, Project.project_filepath('tasks/converters/validation_error_converter')
-      autoload :AppConverter, Project.project_filepath('tasks/converters/app_converter')
+      autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
+      autoload :VersionConverter, Project.project_filepath("tasks/converters/version_converter")
+      autoload :ValidationErrorConverter, Project.project_filepath("tasks/converters/validation_error_converter")
+      autoload :AppConverter, Project.project_filepath("tasks/converters/app_converter")
     end
   end
 
   module Forms
-    autoload :Create, Project.project_filepath('forms/create')
-    autoload :Register, Project.project_filepath('forms/register')
+    module Questions
+      autoload :AskApp, Project.project_filepath("forms/questions/ask_app")
+      autoload :AskName, Project.project_filepath("forms/questions/ask_name")
+      autoload :AskType, Project.project_filepath("forms/questions/ask_type")
+    end
+
+    autoload :Create, Project.project_filepath("forms/create")
+    autoload :Register, Project.project_filepath("forms/register")
   end
 
   module Features
-    autoload :ArgoSetup, Project.project_filepath('features/argo_setup')
-    autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
-    autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
-    autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
-    autoload :ArgoConfig, Project.project_filepath('features/argo_config')
-    module Argo
-      autoload :Base, Project.project_filepath('features/argo/base')
-      autoload :Admin, Project.project_filepath('features/argo/admin')
-      autoload :Checkout, Project.project_filepath('features/argo/checkout')
-    end
+    autoload :ArgoSetup, Project.project_filepath("features/argo_setup")
+    autoload :ArgoSetupStep, Project.project_filepath("features/argo_setup_step")
+    autoload :ArgoSetupSteps, Project.project_filepath("features/argo_setup_steps")
+    autoload :ArgoDependencies, Project.project_filepath("features/argo_dependencies")
+    autoload :ArgoConfig, Project.project_filepath("features/argo_config")
+    autoload :Argo, Project.project_filepath("features/argo")
   end
 
   module Models
-    autoload :App, Project.project_filepath('models/app')
-    autoload :Registration, Project.project_filepath('models/registration')
-    autoload :Version, Project.project_filepath('models/version')
-    autoload :Type, Project.project_filepath('models/type')
-    autoload :ValidationError, Project.project_filepath('models/validation_error')
-
-    class << self
-      Models::Type.load_all
+    module SpecificationHandlers
+      autoload :Default, Project.project_filepath("models/specification_handlers/default")
     end
+
+    autoload :App, Project.project_filepath("models/app")
+    autoload :Registration, Project.project_filepath("models/registration")
+    autoload :Version, Project.project_filepath("models/version")
+    autoload :ValidationError, Project.project_filepath("models/validation_error")
+    autoload :Specification, Project.project_filepath("models/specification")
+    autoload :Specifications, Project.project_filepath("models/specifications")
+    autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
   end
 
-  autoload :ExtensionProjectKeys, Project.project_filepath('extension_project_keys')
-  autoload :ExtensionProject, Project.project_filepath('extension_project')
+  autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")
+  autoload :ExtensionProject, Project.project_filepath("extension_project")
+
+  def self.specifications
+    @specifications ||= Models::Specifications.new(
+      fetch_specifications: Tasks::FetchSpecifications
+    )
+  end
+
+  def self.specifications=(specifications)
+    @specifications = specifications
+  end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -12,9 +12,9 @@ module Extension
       def call(_args, _command_name)
         system = ShopifyCli::JsSystem.new(ctx: @ctx)
 
-        CLI::UI::Frame.open(@ctx.message('build.frame_title', system.package_manager)) do
+        CLI::UI::Frame.open(@ctx.message("build.frame_title", system.package_manager)) do
           success = system.call(yarn: YARN_BUILD_COMMAND, npm: NPM_BUILD_COMMAND)
-          @ctx.abort(@ctx.message('build.build_failure_message')) unless success
+          @ctx.abort(@ctx.message("build.build_failure_message")) unless success
         end
       end
 

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

@@ -4,24 +4,30 @@ module Extension
   module Commands
     class Create < ShopifyCli::SubCommand
       options do |parser, flags|
-        parser.on('--name=NAME') { |name| flags[:name] = name }
-        parser.on('--type=TYPE') { |type| flags[:type] = type.upcase }
+        parser.on("--name=NAME") { |name| flags[:name] = name }
+        parser.on("--type=TYPE") { |type| flags[:type] = type.upcase }
+        parser.on("--api-key=KEY") { |key| flags[:api_key] = key.downcase }
       end
 
       def call(args, _)
         with_create_form(args) do |form|
           if Dir.exist?(form.directory_name)
-            @ctx.abort(@ctx.message('create.errors.directory_exists', form.directory_name))
+            @ctx.abort(@ctx.message("create.errors.directory_exists", form.directory_name))
           end
 
           if form.type.create(form.directory_name, @ctx)
             ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
-            ExtensionProject.write_env_file(context: @ctx, title: form.name)
-
-            @ctx.puts(@ctx.message('create.ready_to_start', form.directory_name, form.name))
-            @ctx.puts(@ctx.message('create.learn_more', form.type.name))
+            ExtensionProject.write_env_file(
+              context: @ctx,
+              title: form.name,
+              api_key: form.app.api_key,
+              api_secret: form.app.secret
+            )
+
+            @ctx.puts(@ctx.message("create.ready_to_start", form.directory_name, form.name))
+            @ctx.puts(@ctx.message("create.learn_more", form.type.name))
           else
-            @ctx.puts(@ctx.message('create.try_again'))
+            @ctx.puts(@ctx.message("create.try_again"))
           end
         end
       end
@@ -29,10 +35,11 @@ module Extension
       def self.help
         <<~HELP
           Create a new app extension.
-            Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension <name>}}
+            Usage: {{command:#{ShopifyCli::TOOL_NAME} create extension}}
             Options:
               {{command:--type=TYPE}} The type of extension you would like to create.
               {{command:--name=NAME}} The name of your extension (50 characters).”
+              {{command:--api-key=KEY}} The API key of your app.”
         HELP
       end
 

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -10,11 +10,14 @@ module Extension
 
       def extension_type
         @extension_type ||= begin
-          unless Models::Type.valid?(project.extension_type_identifier)
-            @ctx.abort(@ctx.message('errors.unknown_type', project.extension_type_identifier))
-          end
+          identifier = project.extension_type_identifier
+          Models::LazySpecificationHandler.new(identifier) do
+            unless Extension.specifications.valid?(identifier)
+              @ctx.abort(@ctx.message("errors.unknown_type", project.extension_type_identifier))
+            end
 
-          Models::Type.load_type(project.extension_type_identifier)
+            Extension.specifications[identifier]
+          end
         end
       end
     end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Commands
@@ -10,7 +10,7 @@ module Extension
         Commands::Register.new(@ctx).call(args, name) unless project.registered?
         Commands::Build.new(@ctx).call(args, name)
 
-        CLI::UI::Frame.open(@ctx.message('push.frame_title')) do
+        CLI::UI::Frame.open(@ctx.message("push.frame_title")) do
           updated_draft_version = update_draft
           show_message(updated_draft_version)
         end
@@ -30,18 +30,18 @@ module Extension
       end
 
       def output_success_messages(draft)
-        @ctx.puts(@ctx.message('push.success_confirmation', project.title, format_time(draft.last_user_interaction_at)))
-        @ctx.puts(@ctx.message('push.success_info', draft.location))
+        @ctx.puts(@ctx.message("push.success_confirmation", project.title, format_time(draft.last_user_interaction_at)))
+        @ctx.puts(@ctx.message("push.success_info", draft.location))
       end
 
       def output_validation_errors(draft)
-        @ctx.puts(@ctx.message('push.pushed_with_errors', format_time(draft.last_user_interaction_at)))
+        @ctx.puts(@ctx.message("push.pushed_with_errors", format_time(draft.last_user_interaction_at)))
 
         draft.validation_errors.each do |error|
-          @ctx.puts(format('{{x}} %s: %s', error.field.last, error.message))
+          @ctx.puts(format("{{x}} %s: %s", error.field.last, error.message))
         end
 
-        @ctx.puts(@ctx.message('push.push_with_errors_info'))
+        @ctx.puts(@ctx.message("push.push_with_errors_info"))
       end
 
       def format_time(time)
@@ -49,7 +49,7 @@ module Extension
       end
 
       def with_waiting_text
-        @ctx.puts(@ctx.message('push.waiting_text'))
+        @ctx.puts(@ctx.message("push.waiting_text"))
         yield
       end
 

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

@@ -3,23 +3,17 @@
 module Extension
   module Commands
     class Register < ExtensionCommand
-      options do |parser, flags|
-        parser.on('--api_key=KEY') { |key| flags[:api_key] = key.downcase }
-      end
-
-      def call(args, _command_name)
-        CLI::UI::Frame.open(@ctx.message('register.frame_title')) do
-          @ctx.abort(@ctx.message('register.already_registered')) if project.registered?
+      def call(_args, _command_name)
+        CLI::UI::Frame.open(@ctx.message("register.frame_title")) do
+          @ctx.abort(@ctx.message("register.already_registered")) if project.registered?
 
-          with_register_form(args) do |form|
-            should_continue = confirm_registration(form.app)
-            registration = should_continue ? register_extension(form.app) : abort_not_registered
+          should_continue = confirm_registration
+          registration = should_continue ? register_extension : abort_not_registered
 
-            update_project_files(form.app, registration)
+          update_project_files(registration)
 
-            @ctx.puts(@ctx.message('register.success', project.title, form.app.title))
-            @ctx.puts(@ctx.message('register.success_info'))
-          end
+          @ctx.puts(@ctx.message("register.success", project.title, app.title))
+          @ctx.puts(@ctx.message("register.success_info"))
         end
       end
 
@@ -27,27 +21,18 @@ module Extension
         <<~HELP
           Register your local extension to a Shopify app
               Usage: {{command:#{ShopifyCli::TOOL_NAME} register}}
-              Options:
-                {{command:--api_key=API_KEY}} The API key used to register an app with the extension. This can be found on the app page on Partners Dashboard.
         HELP
       end
 
       private
 
-      def with_register_form(args)
-        form = Forms::Register.ask(@ctx, args, options.flags)
-        return @ctx.puts(self.class.help) if form.nil?
-
-        yield form
+      def confirm_registration
+        @ctx.puts(@ctx.message("register.confirm_info", extension_type.name))
+        CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question", app.title))
       end
 
-      def confirm_registration(app)
-        @ctx.puts(@ctx.message('register.confirm_info', extension_type.name))
-        CLI::UI::Prompt.confirm(@ctx.message('register.confirm_question', app.title))
-      end
-
-      def register_extension(app)
-        @ctx.puts(@ctx.message('register.waiting_text'))
+      def register_extension
+        @ctx.puts(@ctx.message("register.waiting_text"))
 
         Tasks::CreateExtension.call(
           context: @ctx,
@@ -59,7 +44,7 @@ module Extension
         )
       end
 
-      def update_project_files(app, registration)
+      def update_project_files(registration)
         ExtensionProject.write_env_file(
           context: @ctx,
           api_key: app.api_key,
@@ -69,8 +54,12 @@ module Extension
         )
       end
 
+      def app
+        @app ||= project.app
+      end
+
       def abort_not_registered
-        @ctx.puts(@ctx.message('register.confirm_abort'))
+        @ctx.puts(@ctx.message("register.confirm_abort"))
         raise ShopifyCli::AbortSilent
       end
     end