shopify-cli 1.5.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d907a49558ca8dfb5998667698b5bf262d850a55951ac2af30c178f141d9063
-  data.tar.gz: 833124c900634e59426bef89dd7fbf35948d19b73e55ecb96becfb6307b3cc3a
+  metadata.gz: a1eb0f785e6ead5199faf7921e48209506987a24d942568e24661e96f2bc0861
+  data.tar.gz: 06e4effc8a4b95bf78404630b452e4cf364407019846660b0d293cace45ae245
 SHA512:
-  metadata.gz: 4670c00c70ae907f1d5eea958ba512ac61e2579566dabf4bb09345925d6da2cd882e5c4d0e9bededd92fd779f85326d4b4cbc66d3c268ee816aa0d23330bc55c
-  data.tar.gz: 33a780da492b11846f89d84b74da119d707236846e4b9617ccb1541cde9be83b0f33fcf302d92b3aaa58c3634ed9004d3d2b7673f0a2a916b33ed2336b2835f9
+  metadata.gz: 65df9edf44e3c2ce1263acb79d619736ffc6c4b30c50d9d71f6943dfa7c740dd0a9c9440a6879d46c59387f9bc2db6671cd65a31f700bf964b65bfb9dc1da2dc
+  data.tar.gz: a1b9f5a17dc58b2570294205e33dd3fc1cb0a198bb4b7ca9594d91366d6169d4c92f7c9b7df0cbf8401f9a81123e78b55331ef8afd909247889a17cc046e58a2

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/.rubocop_todo.yml

@@ -1,11 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-12-01 16:33:09 UTC using RuboCop version 1.4.1.
+# on 2021-04-08 18:25:36 UTC using RuboCop version 1.12.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 30
+# Offense count: 35
 Minitest/MultipleAssertions:
   Max: 9
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/docgen/markdown.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/shopify-cli/shopifolk.rb'
+    - 'test/shopify-cli/tunnel_test.rb'

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,36 @@
 Unreleased
 ------
 
+Version 1.9.0
+-------------
+* [1181](https://github.com/Shopify/shopify-app-cli/pull/1181): Remove the subcommand references of the `generate` command for node apps (fixes [1176](https://github.com/Shopify/shopify-app-cli/issues/1176))
+
+Version 1.8.0
+-------------
+* [1119](https://github.com/Shopify/shopify-app-cli/pull/1119): Enable guest serialization for scripts
+
+Version 1.7.1
+------
+* Updating internal features in development
+
+Version 1.7.0
+-----
+* [#1109](https://github.com/Shopify/shopify-app-cli/pull/1109): Abort app generation if name contains disallowed text.
+* [#1075](https://github.com/Shopify/shopify-app-cli/pull/1075): Add support for kebab-case flags
+
+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/Gemfile

@@ -5,19 +5,19 @@ source "https://rubygems.org"
 # They are all for CI and tests
 # `dev` uses no gems
 group :development, :test do
-  gem 'rake'
-  gem 'pry-byebug'
-  gem 'byebug'
-  gem 'rubocop-shopify', require: false
-  gem 'rubocop-minitest', require: false
+  gem "rake"
+  gem "pry-byebug"
+  gem "byebug"
+  gem "rubocop-shopify", require: false
+  gem "rubocop-minitest", require: false
 end
 
 group :test do
-  gem 'mocha', require: false
-  gem 'minitest', '>= 5.0.0', require: false
-  gem 'minitest-reporters', require: false
-  gem 'minitest-fail-fast', require: false
-  gem 'fakefs', '>= 1.0', require: false
-  gem 'webmock', require: false
-  gem 'timecop', require: false
+  gem "mocha", require: false
+  gem "minitest", ">= 5.0.0", require: false
+  gem "minitest-reporters", require: false
+  gem "minitest-fail-fast", require: false
+  gem "fakefs", ">= 1.0", require: false
+  gem "webmock", require: false
+  gem "timecop", require: false
 end

data/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -22,7 +22,7 @@ GEM
       ruby-progressbar
     mocha (1.11.2)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -33,26 +33,26 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
-    rubocop (1.4.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-minitest (0.10.1)
       rubocop (>= 0.87)
-    rubocop-shopify (1.0.7)
-      rubocop (~> 1.4)
-    ruby-progressbar (1.10.1)
+    rubocop-shopify (2.0.1)
+      rubocop (~> 1.11)
+    ruby-progressbar (1.11.0)
     timecop (0.9.2)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
     webmock (3.9.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

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

@@ -1,11 +1,11 @@
-require_relative 'bin/load_shopify'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-require 'bundler/gem_tasks'
+require_relative "bin/load_shopify"
+require "rake/testtask"
+require "rubocop/rake_task"
+require "bundler/gem_tasks"
 
 Rake::TestTask.new do |t|
   t.libs += %w(test)
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = false
   t.warning = false
 end
@@ -16,33 +16,37 @@ task(default: [:test, :rubocop])
 
 desc("Start up irb with cli loaded")
 task :console do
-  exec('irb', '-r', './bin/load_shopify.rb', '-r', 'byebug')
+  exec("irb", "-r", "./bin/load_shopify.rb", "-r", "byebug")
 end
 
 namespace :rdoc do
-  repo = 'https://github.com/Shopify/shopify-app-cli.wiki.git'
-  intermediate = 'markdown_intermediate'
+  repo = "https://github.com/Shopify/shopify-app-cli.wiki.git"
+  intermediate = "markdown_intermediate"
   file_to_doc = [
-    'lib/shopify-cli/admin_api.rb',
-    'lib/shopify-cli/context.rb',
-    'lib/shopify-cli/db.rb',
-    'lib/shopify-cli/git.rb',
-    'lib/shopify-cli/heroku.rb',
-    'lib/shopify-cli/js_deps.rb',
-    'lib/shopify-cli/partners_api.rb',
-    'lib/shopify-cli/process_supervision.rb',
-    'lib/shopify-cli/project.rb',
-    'lib/shopify-cli/tunnel.rb',
+    "lib/shopify-cli/admin_api.rb",
+    "lib/shopify-cli/context.rb",
+    "lib/shopify-cli/db.rb",
+    "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/transform_data_structure.rb",
+    "lib/shopify-cli/tunnel.rb",
+    "lib/shopify-cli/lazy_delegator.rb",
   ]
 
   task all: [:markdown, :wiki, :cleanup]
 
   desc("Generate markdown files from rdoc comments")
   task :markdown do
-    require 'rdoc/rdoc'
-    require 'docgen/markdown'
+    require "rdoc/rdoc"
+    require "docgen/markdown"
     options = RDoc::Options.new
-    options.setup_generator('markdown')
+    options.setup_generator("markdown")
     options.op_dir = intermediate
     options.files = file_to_doc
     RDoc::RDoc.new.document(options)
@@ -50,14 +54,14 @@ namespace :rdoc do
 
   desc("Copy markdown documentation to the wiki and commit them")
   task :wiki do
-    require 'tmpdir'
+    require "tmpdir"
     Dir.mktmpdir do |temp_dir|
       system("git clone --depth=1 #{repo} #{temp_dir}")
-      FileUtils.cp(Dir[File.join(intermediate, '*.md')], temp_dir)
+      FileUtils.cp(Dir[File.join(intermediate, "*.md")], temp_dir)
       Dir.chdir(temp_dir) do
-        system('git add --all')
+        system("git add --all")
         system('git commit -am "auto doc update"')
-        system('git push')
+        system("git push")
       end
     end
   end
@@ -69,10 +73,10 @@ namespace :rdoc do
 end
 
 desc("Generate markdown documentation and update the wiki")
-task(rdoc: 'rdoc:all')
+task(rdoc: "rdoc:all")
 
 namespace :package do
-  require 'shopify-cli/packager'
+  require "shopify-cli/packager"
 
   task all: [:debian, :rpm, :homebrew]
 
@@ -93,4 +97,4 @@ namespace :package do
 end
 
 desc("Builds all distribution packages of the CLI")
-task(package: 'package:all')
+task(package: "package:all")

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

@@ -5,13 +5,16 @@ type:
 up:
   - ruby: 2.5.1
   - bundler
+  - node:
+      version: 14.9.0
+      yarn: true
 
 test:
   desc: 'Run tests.'
   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
-```