shopify-cli 1.4.1 → 1.8.0

data/docs/getting-started/migrate/index.md

@@ -1,96 +1,4 @@
 ---
-title: Migrate from the legacy Shopify App CLI
-section: getting-started
-redirect_from: "/migrate/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-As of version 0.9.0, Shopify App CLI is installed and managed as a software package, instead of as a git repository. If you’re using a legacy version, you’ll need to perform a one-time migration to keep using the CLI. Follow these steps to remove the legacy version and reinstall as a package.
-
-## Check whether you’re using the legacy version
-
-Prior to version 0.9.0, Shopify App CLI was installed as a Git repository. You can determine if you’re running a legacy version by running this command:
-
-```console
-$ shopify version
-```
-
-If you get a “Command not found” error, then you’re using a legacy version and will need to uninstall it manually.
-
-## 1. Uninstall the legacy Shopify App CLI
-
-There are two steps to completely uninstall the legacy version of Shopify App CLI:
-
-1. Delete the legacy CLI files
-1. Remove the legacy `shopify` command from your shell profile
-1. Reload your terminal
-
-### 1. Delete the CLI files
-
-By default, Shopify App CLI was installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete it to uninstall:
-
-```console
-$ rm -rf ~/.shopify-app-cli/
-```
-
-### 2. Remove the `shopify` command from your shell
-
-During the install process, Shopify App CLI added a line to your shell configuration. This line could be located in one of a few possible files in your home directory:
-
-- `~/.bash_profile`
-- `~/.zshrc`
-- `~/.bash_login`
-- `~/.profile`
-- `~/.config/fish/config.fish`
-
-It will look similar to one of the lines below. The exact syntax may vary depending on your system:
-
-```sh
-# The line won’t look *exactly* like this. `HOME_DIR` will instead be the absolute path to your home directory.
-if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
-
-# The line might not be wrapped in an `if` statement. Example:
-[ -f "/HOME_DIR/.shopify-app-cli/shopify.sh" ] && source "/HOME_DIR/.shopify-app-cli/shopify.sh"
-```
-
-Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command.
-
-### 3. Reload your terminal
-
-For the changes above to take effect, exit your terminal, and start a new one.
-
-If you try running `shopify` now, you should get a `command not found` error.
-
-> If you have the `shopify_api` gem installed, you may see the following response:
-> ```console
-> shopify command is no longer bundled with shopify_api.
-> if you need these tools, install the shopify_cli gem
-> ```
-> 
-> If so, then you will also need to upgrade the `shopify_api` gem to v9.2.0+ to remove a deprecated `shopify` command that is contained in that gem.
->
-> If you also have the `shopify_app` gem (which depends on `shopify_api` gem), you'll need to install or update `shopify_api` first, then uninstall the older version.
-> 
-> To get a list of the version(s) of `shopify_api` currently installed:
-> ```console
-> $ gem list shopify_api
-> ```
-> 
-> To install the latest version:
-> ```console
-> $ gem install shopify_api
-> ```
-> 
-> To uninstall the older version:
-> ```console
-> $ gem uninstall shopify_api -v x.y.z
-> ```
-> Replace x.y.z with a version number listed from the `gem list` command.  Repeat as needed.
-
-## 2. Install the new version
-
-Next, install the most recent version of Shopify App CLI. Follow the [install directions]({{ site.baseurl }}/getting-started/install/) for your platform.
-
-## 3. Re-authenticate the CLI
-
-The migration process moves some configuration files, so you’ll need to re-authenticate the CLI with your Shopify Partner Dashboard. The CLI will automatically prompt you to re-authenticate when needed.
-

data/docs/getting-started/uninstall/index.md

@@ -1,37 +1,4 @@
 ---
-title: Uninstall Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/uninstall/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-Shopify App CLI can be removed from your system using the same package manager you used to install it.
-
-### Homebrew (macOS)
-
-```console
-$ brew uninstall shopify-cli
-```
-
-### apt (Debian, Ubuntu)
-
-```console
-$ sudo apt remove shopify-cli
-```
-
-### yum (CentOS 8+, Fedora, Red Hat, SUSE)
-
-```console
-$ sudo yum remove shopify-cli
-```
-
-### RubyGems (macOS, Linux, Windows 10)
-
-```console
-$ gem uninstall shopify-cli
-```
-
-## Uninstall a legacy version
-
-If you’re using a legacy version of the CLI (`<0.9.0`), you’ll need to [uninstall it manually]({{ site.baseurl }}/getting-started/migrate/#1-uninstall-the-old-cli).
-

data/docs/getting-started/upgrade/index.md

@@ -1,41 +1,4 @@
 ---
-title: Upgrade Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/upgrade/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-You can manage upgrades to Shopify App CLI with the package manager for your platform.  **Note** that it's important to use the same package manager to upgrade that you originally used to install Shopify App CLI.
-
-### Homebrew (macOS)
-
-```console
-$ brew update
-$ brew upgrade shopify-cli
-```
-
-### apt (Debian, Ubuntu)
-
-On Debian-based Linux distributions, download the latest `.deb` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
-
-1. Download the `.deb` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
-```
-
-### yum (CentOS 8+, Fedora, Red Hat, SUSE)
-
-On Red Hat–based Linux distributions, download the latest `.rpm` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
-
-1. Download the `.rpm` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
-```
-
-### RubyGems (macOS, Linux, Windows 10)
-
-```console
-$ gem update shopify-cli
-```

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
@@ -89,11 +89,11 @@ module RDoc
         lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
         lines.each do |line|
           next unless line =~ /^ *(?=\S)/
-          n = $&.length
+          n = Regexp.last_match(0).length
           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/graphql/fetch_specifications.graphql

@@ -0,0 +1,14 @@
+query fetchSpecifications($api_key: String!) {
+  extensionSpecifications(apiKey: $api_key) {
+    name
+    identifier
+    options {
+      managementExperience
+    }
+    features {
+      argo {
+        surface
+      }
+    }
+  }
+}

data/lib/project_types/extension/cli.rb

@@ -3,75 +3,82 @@
 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")
 end