shopify-cli 1.4.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b440a68e264b97888e3cb181eea5e2465522c3d67338851e08775cc743416a5
-  data.tar.gz: a6f2acacf046ab9c6bd174d7bd077a0ea87312f844db05de015c9cacf5d972bf
+  metadata.gz: 30e766112b0e09d6de0e907ecf7e002377fe8a0ecb6776bf0975ec1677a5858a
+  data.tar.gz: 3fbcc004481a0b06c8ccfcd0fb5890d7ab4bf6ee778a6b4dc43c773508376a05
 SHA512:
-  metadata.gz: dc49412e3aa3f7bc5dde8fa5943d2d52ae09138e92de3fcbd949353430a2ea5275dd157951dcf81770cdb36ccb5c023a570ddea3eb7756a357709360d51bb3b4
-  data.tar.gz: 648a9df9b5647e869d92cc23241628fbe336efeeb8c9c6ade691d55b14cb075c419e87a2f97c5eddf851e99bba1da5e595cfcd13d2d78c6c5c0cafbaeaa85dc1
+  metadata.gz: d3b9f2da8984619e58cb73a5a066bd67b7b0e3f050a82f794b36079d3f0850d8c57e4e346e7f6ae0c0ea01601d07e26d54359cced3e132d23246ad88bbed314f
+  data.tar.gz: 1ec7d262e39e6b112cf25a35b85788faeb77fce56febdeb46e0f8630608ca19ec0eb032b668302515e23fbfa0831ad25492439cc8cb35e5fb376c6e2277e4596

data/.github/CODEOWNERS

@@ -1,4 +1,4 @@
 *       @shopify/platform-dev-tools-education
 
-/lib/project_types/script/ @shopify/scripts
-/test/project_types/script/ @shopify/scripts
+/lib/project_types/script/ @shopify/scripts-experience
+/test/project_types/script/ @shopify/scripts-experience

data/.github/CONTRIBUTING.md

@@ -19,6 +19,14 @@ When contributing to the Shopify App CLI, there are a set of [design guidelines]
 
 We track all of our issues in GitHub and [bugs](https://github.com/Shopify/shopify-app-cli/labels/Bug) are labeled accordingly. If you are planning to work on an issue, avoid ones which already have an assignee, where someone has commented within the last two weeks they are working on it, or the issue is labeled with [fix in progress](https://github.com/Shopify/shopify-app-cli/labels/fix%20in%20progress). We will do our best to communicate when an issue is being worked on internally.
 
+### Running against a local environment
+
+This section only applies to Shopify staff:
+
+To run against a local Partners or Identity instance, you can use:
+
+`SHOPIFY_APP_CLI_LOCAL_PARTNERS=1 shopify`
+
 ### Reporting new issues
 
 To reduce duplicates, look through open issues before filing one. When [opening an issue](https://github.com/Shopify/shopify-app-cli/issues/new?template=ISSUE.md), complete as much of the template as possible.
@@ -48,4 +56,4 @@ Each contributor is required to [sign a CLA](https://cla.shopify.com/). This pro
 
 If you are changing the CLI version, please make sure to update all the places that use it:
 * ShopifyCLI::VERSION
-* Debian package version under `packaging/debian`
+* Debian package version under `packaging/debian`

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@
   - Prefix it with [Feature] (if applicable)
   - Start with a verb, for example: Add, Delete, Improve, Fix…
   - Give as much context as necessary and as little as possible
-  - Prefix it with [WIP] while it’s a work in progress
+  - Use a draft PR while it’s a work in progress
 -->
 
 ### WHY are these changes introduced?
@@ -27,4 +27,5 @@ Fixes #0000 <!-- link to issue if one exists -->
   `* [#PR](PR URL): Message`. You should consider adding your PR
   and then making the CHANGELOG update once you know the PR number.
 -->
-- [ ] I've added a CHANGELOG entry for this PR
+- [ ] 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/.github/workflows/release.yml

@@ -46,7 +46,6 @@ jobs:
         tap: shopify/shopify
         formula: shopify-cli
         tag: ${{ steps.folder.outputs.name }}
-        message: "Version bump, created by github actions"
 
     - name: Create Release # https://hub.github.com/hub-release.1.html
       env:

data/.github/workflows/triage.yml

@@ -0,0 +1,22 @@
+name: Triage new issues to DTE oncall project board ("Needs triage" column)
+
+on:
+  issues:
+    types: [opened, reopened]
+
+jobs:
+  triage-issue:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Extract issue id
+      id: issue
+      run: echo "::set-output name=id::$(jq -r '.issue.id' < "$GITHUB_EVENT_PATH")"
+
+    - name: Create card
+      env:
+        TOKEN: ${{ secrets.ACTIONS_TOKEN }}
+      run: |
+        curl -s -X POST -u "$GITHUB_ACTOR:$TOKEN" --retry 3 \
+          -H 'Accept: application/vnd.github.inertia-preview+json' \
+          -d "{\"content_type\": \"Issue\", \"content_id\": ${{ steps.issue.outputs.id }}}" \
+          "https://api.github.com/projects/columns/10507989/cards"

data/.rubocop.yml

@@ -51,6 +51,9 @@ Layout/EmptyLines:
     # Need extra line so comment at top isnt registered to the Dev namespace
     - 'lib/dev/helpers/chruby_reset.rb'
 
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
 # Changing this could effect the way the content is rendered.
 Layout/HeredocIndentation:
   Exclude:
@@ -74,13 +77,24 @@ Style/RegexpLiteral:
 
 Style/MethodCallWithArgsParentheses:
   IgnoredMethods:
+    - assert
+    - assert_equal
+    - assert_includes
+    - assert_nil
+    - assert_raises
+    - assert_requested # from Webmock
+    - puts
+    - raise
+    - refute
+    - refute_empty
+    - refute_nil
     - require
-    - require_relative
     - require_dependency
+    - require_relative
     - yield
-    - raise
-    - puts
-    - assert_equal
-    - assert
-    - refute
-    - assert_requested # from Webmock
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'ext/shopify-cli/extconf.rb' # unsure if safe to remove
+    - 'lib/project_types/extension/messages/messages.rb' # unsure if safe to remove
+    - 'test/project_types/extension/extension_test_helpers/stubs/argo_script.rb' # unsure if save to remove

data/.rubocop_todo.yml

@@ -1,24 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-10-24 22:13:10 UTC using RuboCop version 0.93.1.
+# on 2020-12-01 16:33:09 UTC using RuboCop version 1.4.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: 29
+# Offense count: 30
 Minitest/MultipleAssertions:
   Max: 9
-
-# Offense count: 74
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreMacros, IgnoredMethods, IgnoredPatterns, IncludedMacros, AllowParenthesesInMultilineCall, AllowParenthesesInChaining, AllowParenthesesInCamelCaseMethod, EnforcedStyle.
-# SupportedStyles: require_parentheses, omit_parentheses
-Style/MethodCallWithArgsParentheses:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantBegin:
-  Exclude:
-    - 'test/test_helper.rb'

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+ - 3.0.0
  - 2.5.8
  - 2.6.6
  - 2.7.1
@@ -11,4 +12,3 @@ install:
 - bundle install
 script:
   - bundle exec rake
-  - if [ -f "~/.config/shopify/config" ]; then echo "Found a config file in home directory. This means the tests would modify a developer's local config. Consider using FakeFS"; exit 1; fi

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 Unreleased
 ------
 
+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
 ------
 * [#917](https://github.com/Shopify/shopify-app-cli/pull/917): Ensure analytics for create action includes the same fields as other commands

data/Gemfile

@@ -5,18 +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 '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)
@@ -13,14 +13,16 @@ GEM
     hashdiff (1.0.1)
     method_source (1.0.0)
     minitest (5.14.2)
+    minitest-fail-fast (0.1.0)
+      minitest (~> 5)
     minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     mocha (1.11.2)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -31,26 +33,26 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.2)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
-    rubocop (0.93.1)
+    rubocop (1.11.0)
       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 (>= 0.6.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.0)
+      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.6)
-      rubocop (>= 0.92, < 0.94)
-    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)
@@ -63,6 +65,7 @@ DEPENDENCIES
   byebug
   fakefs (>= 1.0)
   minitest (>= 5.0.0)
+  minitest-fail-fast
   minitest-reporters
   mocha
   pry-byebug

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/RELEASING.md

@@ -31,19 +31,11 @@
 
 1. Deploy using Shipit
 
-1. Update your `master` branch to the latest version
-   ```
-   $ git checkout master
-   $ git pull
-   ```
+1. Check the "Actions" tab to see if the _Create Release_ workflow is successful. 
+   The workflow will automatically create a [release](https://github.com/Shopify/shopify-app-cli/releases) with the latest tag and `.deb`, `.rpm` assets attached.
 
-1. On local machine and _AFTER_ gem has been published to https://rubygems.org, run
-   ```
-   $ rake package
-   ```
-   This will generate the `.deb`, `.rpm` and brew formula files, which will be located in `packaging/builds/X.Y.Z/`.
+2. Check the `Shopify/homebrew-shopify` repository for new PR `shopify-cli {version}`
+   * rename PR to `Packaging for release of v{version} of shopify-cli`
+   * when PR is approved, merge into main branch
 
-1. Check the "Actions" tab to see if the _Create Release_ workflow is successful. 
-   The workflow will automatically create a release with the latest tag and the `.deb`, `.rpm` assets attached.
 
-1. Check the `Shopify/homebrew-shopify` repository for new branch `bump-shopify-cli-{version}` and create PR.

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")