shopify-cli 1.4.1 → 1.8.0

data/bin/load_shopify.rb

@@ -3,20 +3,20 @@
 lib_path = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-ENV['SHELLPID'] ||= Process.ppid.to_s
-ENV['USER_PWD'] ||= Dir.pwd
+ENV["SHELLPID"] ||= Process.ppid.to_s
+ENV["USER_PWD"] ||= Dir.pwd
 
 # Prune non-absolute paths from PATH to prevent non-deterministic behavior
 # i.e. If user has "." or "./bin" in their PATH
 # Note that this logic is duplicated in lib/shopify.rb
-ENV['PATH'] = ENV['PATH'].split(File::PATH_SEPARATOR).select do |p|
-  p.start_with?('/', '~', /[A-Z]:\\/)
+ENV["PATH"] = ENV["PATH"].split(File::PATH_SEPARATOR).select do |p|
+  p.start_with?("/", "~", /[A-Z]:\\/)
 end.join(File::PATH_SEPARATOR)
 
 $original_env = ENV.to_hash
 
-require 'shopify_cli'
+require "shopify_cli"
 
-if ENV['PRINT_LOADED_FEATURES']
+if ENV["PRINT_LOADED_FEATURES"]
   puts $LOADED_FEATURES
 end

data/bin/shopify

@@ -14,7 +14,7 @@ module Kernel
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify App CLI."
     STDERR.puts "[LoadError] #{e.message}"
-    if ENV['DEBUG']
+    if ENV["DEBUG"]
       STDERR.puts e.backtrace
       STDERR.puts "\n"
     end
@@ -27,7 +27,7 @@ module Kernel
   end
 end
 
-require_relative './load_shopify'
+require_relative "./load_shopify"
 
 exit(ShopifyCli::ErrorHandler.call do
   ShopifyCli::Core::EntryPoint.call(ARGV.dup)

data/dev.yml

@@ -11,7 +11,7 @@ test:
   run: |
     if [ "$#" -eq 1 ] && [[ -f $1 ]];
     then
-      rake test TEST=$1
+      bundle exec rake test TEST=$1
     else
-      rake test $@
+      bundle exec rake test $@
     fi

data/docs/_config.yml

@@ -1,19 +1,2 @@
-title: Shopify App CLI
-markdown: kramdown
-url: https://shopify.github.io
-baseurl: /shopify-app-cli
-
-exclude: [
-  'heroku/',
-  'Gemfile',
-  'Gemfile.lock'
-]
-
-defaults:
-  - scope:
-      path: ""
-    values:
-      toc: true
-
 plugins:
-  - jekyll-redirect-from
+  - jekyll-redirect-from

data/docs/app/node/commands/index.md

@@ -1,82 +1,4 @@
 ---
-title: Node.js app project command reference
-section: node
+title: Node.js app commands
+redirect_to: https://shopify.dev/tools/cli/reference/node-app
 ---
-
-## `deploy`
-
-Deploy the current Node.js app to a hosting service. Currently, the only option is [Heroku](https://www.heroku.com).
-
-```console
-$ shopify deploy heroku
-```
-
-## `generate`
-
-Generate boilerplate code inside your app project. Node.js apps support generating new **pages**, **Billing API calls**, and **webhooks**.
-
-```console
-$ shopify generate page
-$ shopify generate billing
-$ shopify generate webhook
-```
-
-## `open`
-
-Open your local development app in your default browser.
-
-```console
-$ shopify open
-```
-
-## `populate`
-
-Add example data to your development store. This is useful for testing your app’s behavior. You can create the following types of example store records:
-
-- Products
-- Customers
-- Orders
-
-```console
-$ shopify populate products
-$ shopify populate customers
-$ shopify populate draftorders
-```
-
-By default, the `populate` command adds 5 records. Use the `--count` option to specify a different number:
-
-```console
-$ shopify populate products --count 10
-```
-
-## `serve`
-
-Start a local development server for your project, as well as a public [ngrok](https://ngrok.com/) tunnel to your localhost.
-
-```console
-$ shopify serve
-```
-
-## `tunnel`
-
-Control an HTTP tunnel to your local development app using [ngrok](https://ngrok.com). With the `tunnel` command you can authenticate with ngrok and start or stop the tunnel. (Note that the `serve` command will automatically run `tunnel start` for you.)
-
-To authenticate with ngrok, you need an authentication token. You can find it in [your ngrok dashboard](https://dashboard.ngrok.com/auth/your-authtoken). Copy your token and use it with the `tunnel auth` command:
-
-```console
-$ shopify tunnel auth <token>
-```
-
-This will write your ngrok auth token to `~/.ngrok2/ngrok.yml`. To learn more about ngrok configuration, [consult ngrok’s documentation](https://ngrok.com/docs#config).
-
-To start an ngrok tunnel to your app in your localhost development environment:
-
-```console
-$ shopify tunnel start
-```
-
-To stop the running ngrok tunnel:
-
-```console
-$ shopify tunnel stop
-```

data/docs/app/node/index.md

@@ -1,35 +1,4 @@
 ---
-title: Getting started with Node.js app projects
-section: node
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-## Create a new Node.js app project
-
-To create a new Node.js project, type `shopify create node`. This will scaffold a new Node.js app in a subdirectory.
-
-```console
-$ shopify create node
-? App Name
->
-```
-
-## Start a local development server
-
-Once your app is created, you can work with it immediately by running `shopify serve` to start a local development server. Shopify App CLI uses [ngrok](https://ngrok.com) to create a tunnel. ngrok will choose a unique URL for you. The server will stay open until you type **Ctrl-C**.
-
-```console
-$ shopify serve
-✓ ngrok tunnel running at https://example.ngrok.io
-✓ writing .env file...
-```
-
-## Install your app on your development store
-
-With the server running, open a new terminal window and run `shopify open` to open your app in your browser and install it on a development store.
-
-```console
-$ shopify open
-```
-
-For more information, consult the [Node.js project command reference]({{ site.baseurl }}{% link app/node/commands/index.md %}).

data/docs/app/rails/commands/index.md

@@ -1,80 +1,4 @@
 ---
-title: Rails app project command reference
-section: rails
+title: Ruby on Rails app commands
+redirect_to: https://shopify.dev/tools/cli/reference/ruby-on-rails-app
 ---
-
-## `deploy`
-
-Deploy the current Rails project to a hosting service. Currently, the only option is [Heroku](https://www.heroku.com).
-
-```console
-$ shopify deploy heroku
-```
-
-## `generate`
-
-Generate boilerplate code inside your app project. Rails projects support generating new webhooks.
-
-```console
-$ shopify generate webhook
-```
-
-## `open`
-
-Open your local development app in your default browser.
-
-```console
-$ shopify open
-```
-
-## `populate`
-
-Add example data to your development store. This is useful for testing your app’s behavior. You can create the following types of example store records:
-
-- Products
-- Customers
-- Orders
-
-```console
-$ shopify populate products
-$ shopify populate customers
-$ shopify populate draftorders
-```
-
-By default, the `populate` command adds 5 records. Use the `--count` option to specify a different number:
-
-```console
-$ shopify populate products --count 10
-```
-
-## `serve`
-
-Start a local development server for your project, as well as a public [ngrok](https://ngrok.com/) tunnel to your localhost.
-
-```console
-$ shopify serve
-```
-
-## `tunnel`
-
-Control an HTTP tunnel to your local development app using [ngrok](https://ngrok.com). With the `tunnel` command you can authenticate with ngrok and start or stop the tunnel. (Note that the `serve` command will automatically run `tunnel start` for you.)
-
-To authenticate with ngrok, you need an authentication token. You can find it in [your ngrok dashboard](https://dashboard.ngrok.com/auth/your-authtoken). Copy your token and use it with the `tunnel auth` command:
-
-```console
-$ shopify tunnel auth <token>
-```
-
-This will write your ngrok auth token to `~/.ngrok2/ngrok.yml`. To learn more about ngrok configuration, [consult ngrok’s documentation](https://ngrok.com/docs#config).
-
-To start an ngrok tunnel to your app in your localhost development environment:
-
-```console
-$ shopify tunnel start
-```
-
-To stop the running ngrok tunnel:
-
-```console
-$ shopify tunnel stop
-```

data/docs/app/rails/index.md

@@ -1,36 +1,4 @@
 ---
-title: Getting started with Rails app projects
-section: rails
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-## Create a new Rails app project
-
-To create a new Rails project, type `shopify create rails`. This will scaffold a new Rails app in a subdirectory.
-
-```console
-$ shopify create rails
-? App Name
->
-```
-
-## Start a local development server
-
-Once your app is created, you can work with it immediately by running `shopify serve` to start a local development server. Shopify App CLI uses [ngrok](https://ngrok.com) to create a tunnel. ngrok will choose a unique URL for you. The server will stay open until you type **Ctrl-C**.
-
-```console
-$ shopify serve
-✓ ngrok tunnel running at https://example.ngrok.io
-✓ writing .env file...
-```
-
-## Install your app on your development store
-
-With the server running, open a new terminal window and run `shopify open` to open your app in your browser and install it on a development store.
-
-```console
-$ shopify open
-```
-
-For more information, consult the [Rails project command reference]({{ site.baseurl }}{% link app/rails/commands/index.md %}).
-

data/docs/core/index.md

@@ -1,86 +1,4 @@
 ---
-title: Core commands
-section: core
+title: Shopify App CLI core commands
+redirect_to: https://shopify.dev/tools/cli/reference
 ---
-
-## `help`
-
-Lists the available commands and describes what they do. The commands available will vary depending on whether you are inside a project directory, and what kind of project it is.
-
-```console
-$ shopify help
-$ shopify -h
-$ shopify --help
-```
-
-You can also use the `help` command or options to get more detailed information about a specific command:
-
-```console
-$ shopify help [command]
-$ shopify [command] -h
-$ shopify [command] --help
-```
-
-## `connect`
-
-Connect an existing Shopify App CLI project with Shopify, such as a Partner account or a specific Shopify development store. This command re-creates the project’s `.env` file with your authentication tokens.
-
-This is useful if you are working on one project across multiple computers, or collaborating with other developers using a version control system like git.
-
-```console
-$ shopify connect
-```
-
-## `create`
-
-Create a new project of the specified type. The project will be created in a subdirectory of the current directory:
-
-```console
-$ shopify create
-```
-
-When running the `create` command on its own, the CLI will prompt you to choose a project type:
-
-```console
-$ shopify create
-? What type of project would you like to create? (Choose with ↑ ↓ ⏎, filter with 'f')
-> 1. Node.js App
-  2. Ruby on Rails App
-```
-
-You can also specify the type of app you want to create using a subcommand:
-- For a Node.js app: `node`
-- For a Ruby on Rails app: `rails`
-
-If you specify a type, then Shopify App CLI will skip ahead and prompt you to enter a name for your project:
-
-```console
-$ shopify create node
-? App Name
-> 
-```
-
-## `logout`
-
-Log out of the currently authenticated partner organization and store. The `logout` command clears any invalid credentials. You’ll need to re-authenticate the next time you connect your project to Shopify.
-
-```console
-$ shopify logout
-```
-
-## `config`
-
-Configure Shopify App CLI options. Currently there are two available options.
-
-### `analytics`
-
-Configure anonymous usage reporting by enabling or disabling analytics 
-```console
-$ shopify config analytics [ --status | --enable | --disable ]
-```
-
-### `feature`
-Configure active [feature sets](https://github.com/Shopify/shopify-app-cli/wiki/Feature-Sets) in the CLI. This command is used for development and debugging work on the CLI tool itself. Only alter it if you know what you're doing. Check the [Shopify App CLI development guide](https://github.com/Shopify/shopify-app-cli/wiki) for more information.
-```console
-$ shopify config feature [ feature_name ] [ --status | --enable | --disable ]
-```

data/docs/getting-started/index.md

@@ -1,27 +1,4 @@
 ---
-title: Getting started
-section: getting-started
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-Developers should have some prior knowledge of the [Shopify app ecosystem](https://shopify.dev/concepts/apps). Shopify App CLI creates apps using either [Node.js](https://nodejs.org/) or [Ruby on Rails](https://rubyonrails.org/).
-
-## Requirements
-
-- A [Shopify partner account](https://partners.shopify.com/signup)
-- A [Shopify development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) to install and test apps
-- [Ruby](https://www.ruby-lang.org) 2.5.1+ 
-
-### Windows requirements
-
-If you wish to use Shopify App CLI natively on **Windows 10**, we recommend installing Ruby using [RubyInstaller for Windows](https://rubyinstaller.org/downloads/).
-
-Alternatively, you can also use Shopify App CLI using **Windows Subsystem for Linux**, in which case you need:
-- [Linux Subsystem for Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
-- [Ubuntu VM](https://www.microsoft.com/en-ca/p/ubuntu/9nblggh4msv6)
-
-## Next steps
-
-- [Install the CLI]({{ site.baseurl }}/getting-started/install/)
-- [Upgrade]({{ site.baseurl }}/getting-started/upgrade/)
-- [Uninstall]({{ site.baseurl }}/getting-started/uninstall/)

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

@@ -1,121 +1,4 @@
 ---
 title: Install Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/install/"
+redirect_to: https://shopify.dev/tools/cli/installation
 ---
-
-Shopify App CLI can be installed on a variety of systems, using a variety of package managers.
-> Note that for systems that have multiple installation options, you only need to use one of these methods to install.
-
----
-### macOS
-
-Shopify App CLI is available through Homebrew _or_ RubyGems.
-
-**Homebrew**
-
-You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
-
-```console
-$ brew tap shopify/shopify
-$ brew install shopify-cli
-```
-
-**RubyGems**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### Debian/Ubuntu Linux
-
-On Debian-based Linux systems, Shopify App CLI is available through the `apt` command _or_ RubyGems.
-
-**apt**
-
-You’ll need to install a downloaded `.deb` file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
-
-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
-```
-
-**RubyGems**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### CentOS 8+/Fedora/Red Hat/SUSE Linux
-
-On RPM-based Linux systems, Shopify App CLI is available through the `yum` command _or_ RubyGems.
-
-**yum**
-
-You’ll need to install a downloaded `.rpm` file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
-
-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**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### Windows 10
-
-On Windows 10 systems, Shopify App CLI is available through [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygem-all-platforms).
-
----
-
-### RubyGems (all platforms)
-
-Shopify App CLI is available on all platforms as a RubyGem through [RubyGems.org](https://rubygems.org/).
-
-```console
-$ gem install shopify-cli
-```
-
----
-
-### To check that Shopify App CLI is installed correctly:
-
-```console
-$ shopify version
-1.0.0
-$
-```
-
-> Note 1: the version displayed may be newer.
-
-> Note 2: 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.