shopify-cli 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d907a49558ca8dfb5998667698b5bf262d850a55951ac2af30c178f141d9063
-  data.tar.gz: 833124c900634e59426bef89dd7fbf35948d19b73e55ecb96becfb6307b3cc3a
+  metadata.gz: 51b21780f8f46054f92124110152a903c94a6215436b73b5dce40c8ad7b072cc
+  data.tar.gz: 2884ba67316188cd05ae6b8cd3e7927a7dc8d99936fd328eed6a2480452eec4b
 SHA512:
-  metadata.gz: 4670c00c70ae907f1d5eea958ba512ac61e2579566dabf4bb09345925d6da2cd882e5c4d0e9bededd92fd779f85326d4b4cbc66d3c268ee816aa0d23330bc55c
-  data.tar.gz: 33a780da492b11846f89d84b74da119d707236846e4b9617ccb1541cde9be83b0f33fcf302d92b3aaa58c3634ed9004d3d2b7673f0a2a916b33ed2336b2835f9
+  metadata.gz: 8e1f3f1911ab79b7dc725236249219a0f5aff3703ed82f243cf2235621e1e45aef7c77e2fd06c2360a436c7601d344e4e01f0795eff53d519a2a992079825847
+  data.tar.gz: cc1c2de1b2bc5f624c0e249d4b7b8f0a58bd72ab164e02914b9ace0d6d542bbc6aa8d3a67387ce45060aa5fcc44ef5aed5fc4bed2ce8a67bb53bd7d65c03f608

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -28,3 +28,4 @@ Fixes #0000 <!-- link to issue if one exists -->
   and then making the CHANGELOG update once you know the PR number.
 -->
 - [ ] I've added a CHANGELOG entry for this PR (if the change is public-facing)
+- [ ] I've considered possible cross-platform impacts (Mac, Linux, Windows).

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+ - 3.0.0
  - 2.5.8
  - 2.6.6
  - 2.7.1

data/CHANGELOG.md

@@ -1,10 +1,19 @@
 Unreleased
 ------
 
+Version 1.6.0
+-----
+* [#1049](https://github.com/Shopify/shopify-app-cli/pull/1049): Add schema versioning support to the script project type
+* [#1059](https://github.com/Shopify/shopify-app-cli/pull/1059): Remove the functionality of the `generate` command for node apps, since it will no longer be feasible with the new node library
+* [#1046](https://github.com/Shopify/shopify-app-cli/pull/1046): Include a vendored copy of Webrick, as it's no longer included in Ruby 3.
+* [#1041](https://github.com/Shopify/shopify-app-cli/pull/1041): Remove unnecessary shell call to `spring stop`. We already pass `--skip-spring` when creating the app so running `spring stop` would have no effect.
+* [#1034](https://github.com/Shopify/shopify-app-cli/pull/1034): Abort if a system call fails.
+
 Version 1.5.0
 -----
 * [#965](https://github.com/Shopify/shopify-app-cli/pull/965): Remove --no-optional when using npm to create new project
 * [#958](https://github.com/Shopify/shopify-app-cli/pull/958): Split `connect` command into project-specific functionality
+* [#992](https://github.com/Shopify/shopify-app-cli/pull/992): Add Theme Kit functionality to CLI
 
 Version 1.4.1
 ------

data/README.md

@@ -1,13 +1,45 @@
-# Shopify App CLI 
+# [Shopify App CLI](https://shopify.dev/tools/cli)
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)[![Build Status](https://travis-ci.com/Shopify/shopify-app-cli.svg?token=qtPazgjyosjEEgxgq7VZ&branch=master)](https://travis-ci.com/Shopify/shopify-app-cli)
 
-Shopify App CLI helps you build Shopify apps faster. It automates many common tasks in the development process and lets you quickly add popular features, such as billing and webhooks.
+Shopify App CLI helps you build Shopify apps faster. It quickly generates Node.js and Ruby on Rails apps and automates many common development tasks.
 
-## Using the CLI
-Consult the [Shopify App CLI documentation](https://shopify.github.io/shopify-app-cli) to get started.
+## Features
 
-## Developing the CLI
-This is an [open-source](https://github.com/Shopify/shopify-app-cli/blob/master/.github/LICENSE.md) tool and developers are [invited to contribute](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CONTRIBUTING.md) to it. Please check the [code of conduct](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CODE_OF_CONDUCT.md) before you begin.
+Shopify App CLI helps your app development process in the following ways:
 
-[Read the development guide](https://github.com/Shopify/shopify-app-cli/wiki) to learn more.
+- Creates an app in the [Partner dashboard](https://partners.shopify.com/current/resources)
+- Populates test data for your app, including products, customers, and draft orders
+- Generates new [webhooks](https://shopify.dev/tutorials/manage-webhooks) for your app
+- Deploys your app to an external platform, such as [Heroku](https://www.heroku.com/)
+
+## Installation
+
+Refer to [*Install Shopify App CLI*](https://shopify.dev/tools/cli/installation) to learn how to install Shopify App CLI on Windows, macOS, or Linux.
+
+## Getting started
+
+Refer to [*Getting started with Shopify App CLI*](https://shopify.dev/tools/cli/getting-started) to learn how to create and manage different types of projects with Shopify App CLI.
+
+## References
+
+- **[Shopify App CLI core commands](https://shopify.dev/tools/cli/reference)** - A complete reference of core commands for Shopify App CLI.
+- **[Node.js app commands](https://shopify.dev/tools/cli/reference/node-app)** - A complete Shopify App CLI command reference for Node.js apps.
+- **[Ruby on Rails app commands](https://shopify.dev/tools/cli/reference/ruby-on-rails-app)** - A complete Shopify App CLI command reference for Ruby on Rails apps.
+
+## Troubleshooting
+
+Refer to [*Troubleshooting Shopify App CLI*](https://shopify.dev/tools/cli/troubleshooting) to learn how to upgrade, migrate from a legacy version, and uninstall Shopify App CLI.
+
+## Contributing to Shopify App CLI
+
+Shopify App CLI is an [open source](https://github.com/Shopify/shopify-app-cli/blob/master/.github/LICENSE.md) tool and you can [help contribute to the GitHub repository](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CONTRIBUTING.md).
+
+## Developing Shopify App CLI
+
+Read the [development guide](https://github.com/Shopify/shopify-app-cli/wiki).
+
+## Where to get help
+
+- **[Open a GitHub issue](https://github.com/Shopify/shopify-app-cli/issues)** - To report bugs or request new features, open an issue in the Shopify App CLI repository.
+- **[Shopify Community Forums](https://community.shopify.com/)** - Visit our forums to connect with the community and learn more about Shopify App CLI development.

data/Rakefile

@@ -29,9 +29,11 @@ namespace :rdoc do
     'lib/shopify-cli/git.rb',
     'lib/shopify-cli/heroku.rb',
     'lib/shopify-cli/js_deps.rb',
+    'lib/shopify-cli/method_object.rb',
     'lib/shopify-cli/partners_api.rb',
     'lib/shopify-cli/process_supervision.rb',
     'lib/shopify-cli/project.rb',
+    'lib/shopify-cli/result.rb',
     'lib/shopify-cli/tunnel.rb',
   ]
 

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 ]
-```