shopify-cli 2.6.4 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b5808e81e2d168620af088bec6f155869a9870b516960927735f9b7b886e55
-  data.tar.gz: 47c04e0dbabd30bb2c03e8c99771e724e16fe7c336fd342be01540749088bee5
+  metadata.gz: 6009a6f735f27532db922768483b5563cc1a89417742616d0712837f7a4c3f8a
+  data.tar.gz: 501ee710f57e5ffc27f7f9abfbb23e155a55da8f67127bfe32031c46fa2df08e
 SHA512:
-  metadata.gz: d75f831a6214930264f60c6c5699beddba9ae73c834878723b2b6c764a5e98d30e427183fa6946fdf57c45a90859cc0a4bbd5420616a72b2f340c0c91093a430
-  data.tar.gz: b73c3d43b0a711994930c0490de71bfeeeff0775b5e0ce6efc48c8c40935b630e5d0ed7182d6eb20188357199a469325b7b40f6cbf317dccb34655745e315ef6
+  metadata.gz: 783329de6e2b6481c6ebcd747284dcd5e3c81c4303bf82f1d9a22e2e5f9a81aeda51a211c0344636ec03ff17fa1e5aae492fd750540387c85de4204bab8f4327
+  data.tar.gz: 6af49d1fff422d17362c2e05f68341fc530cd7849f7d375a39ea8cb5abcb5d825ed8a4f04d8f25cc9265c9b2660c57b028be280db23882d58506e7c184b0d4cc

data/.devcontainer.json

@@ -0,0 +1,5 @@
+{
+  "build": {
+    "dockerfile": "Codespace.dockerfile"
+  },
+}

data/.github/DESIGN.md

@@ -30,7 +30,7 @@ The user understands the following mechanics of a CLI:
 When creating a new command or subcommand there are a few things to keep in mind.
 
 ### What is the quickest way to execute a command?
-Commands are best executed autonomously. Most of the time the command should be self contained and should not requre additional input from the user. For example when running `shopify populate products` the command will execute without additional inputs required from the user even though the command could ask for things like `product name`, `price`, etc.
+Commands are best executed autonomously. Most of the time the command should be self contained and should not require additional input from the user. For example when running `shopify populate products` the command will execute without additional inputs required from the user even though the command could ask for things like `product name`, `price`, etc.
 
 When creating a new command or subcommand consider how much information is absolutely necessary for the command to execute autonomously. If a command always requires arguments or additional information then  adding smart defaults could help make inputting the command faster. 
 

data/.github/ISSUE_TEMPLATE.md

@@ -25,6 +25,13 @@ Tip: include an error message (in a `<details></details>` tag) if your issue is
 1.
 
 
+## Stacktrace
+
+<!--Stacktrace
+Add any stacktrace that might help debug the reported issue.
+Otherwise, delete this section.
+-->
+
 
 ## Specifications
 

data/.gitignore

@@ -21,4 +21,5 @@ packaging/rpm/build
 packaging/rpm/shopify-cli.spec
 .byebug_history
 ext/shopify-extensions/shopify-extensions
+ext/javy/bin
 .console_history

data/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "dracula-theme.theme-dracula",
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "files.exclude": {
+    "**/.git": true,
+    "**/node_modules": true,
+    "**/.DS_Store": true
+  },
+  "editor.formatOnSave": false,
+  "workbench.colorTheme": "Dracula Soft",
+}

data/CHANGELOG.md

@@ -1,6 +1,37 @@
 From version 2.6.0, the sections in this file adhere to the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification.
 ## [Unreleased]
 
+## Version 2.7.1
+### Fixed
+* [#1722](https://github.com/Shopify/shopify-cli/pull/1722): Fix `theme serve` failing when the port is already being used
+* [#1751](https://github.com/Shopify/shopify-cli/pull/1751): A bug in the app creation flow that caused the CLI to abort when the form validation failed.
+* [#1750](https://github.com/Shopify/shopify-cli/pull/1750): Runtime errors in Windows' environments when the `PATHEXT` environment variable is not defined. 
+* [#1758](https://github.com/Shopify/shopify-cli/pull/1758): Fix tunnel creation for expired anonymous tunnels
+
+## Version 2.7.0
+### Changed
+* [#1650](https://github.com/Shopify/shopify-cli/pull/1650): **Breaking** Move app commands under `shopify app`.
+
+### Fixed
+* [#1714](https://github.com/Shopify/shopify-cli/pull/1714): Fix theme serve not serving assets locally when two URLs are on the same line
+* [#1729](https://github.com/Shopify/shopify-cli/pull/1729): Update theme-check to 1.8.0
+
+## Version 2.6.6
+### Added
+* [#1609](https://github.com/Shopify/shopify-cli/pull/1609): Add `--http-bind=HOST` option to `shopify theme serve`.
+
+### Fixed
+* [#1678](https://github.com/Shopify/shopify-cli/pull/1678): Fix migrator's incompatibility with Ruby 2.5.
+* [#1690](https://github.com/Shopify/shopify-cli/pull/1690): Fix `extension push` command for `PRODUCT_SUBSCRIPTION` extensions
+  
+### Changed
+* [#1678](https://github.com/Shopify/shopify-cli/pull/1678): Change the `@shopify/scripts-checkout-apis-temp` package name to `@shopify/scripts-discount-apis`.
+
+### Removed
+* [#1664](https://github.com/Shopify/shopify-cli/pull/1664): Remove ruby-locking extension
+## Version 2.6.5
+### Fixed
+* [#1661](https://github.com/Shopify/shopify-cli/pull/1661): Handle npm list non-zero exit status when pushing scripts
 ## Version 2.6.4
 ### Fixed
 * [#1633](https://github.com/Shopify/shopify-cli/pull/1633): Runtime error when the shop passed on login is invalid
@@ -14,6 +45,7 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ### Changed
 * [#1635](https://github.com/Shopify/shopify-cli/pull/1635): Automatic usage and error reporting configuration has been unified under `analytics.enabled`.
+
 ### Security
 
 ## Version 2.6.3
@@ -21,7 +53,7 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## Version 2.6.2
 * Fix broken installation due to a missing variable in `extconf.rb`
-  
+
 ## Version 2.6.1
 * [#1608](https://github.com/Shopify/shopify-cli/pull/1608): Fix errors not being reported.
 ## Version 2.6.0
@@ -37,11 +69,11 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 * [#1553](https://github.com/Shopify/shopify-cli/pull/1553): Add support for PHP app projects
 
 ## Version 2.4.0
-* [#1488](https://github.com/Shopify/shopify-cli/pull/1488): Update Theme-Check to 1.4
+* [#1488](https://github.com/Shopify/shopify-cli/pull/1488): Update theme-check to 1.4
 * [#1507](https://github.com/Shopify/shopify-cli/pull/1507): Limit the generated name for themes to 50 characters
 
 ## Version 2.3.0
-* [#1386](https://github.com/Shopify/shopify-cli/pull/1386): Update Theme-Check to 1.2
+* [#1386](https://github.com/Shopify/shopify-cli/pull/1386): Update theme-check to 1.2
 * [#1457](https://github.com/Shopify/shopify-cli/pull/1457): Fix uploading of binary theme files under Windows
 * [#1480](https://github.com/Shopify/shopify-cli/pull/1480): Fix customers pages not working with `theme serve`
 * [#1479](https://github.com/Shopify/shopify-cli/pull/1479): Add theme push & pull option to ignore files per command

data/CONTRIBUTING.md

@@ -1,23 +1,3 @@
 # Contributing
 
-This documents includes guidelines for contributors.
-
-## Testing
-
-The project employs a diverse suite tests that help ensure it works as intended and prevents regressions as it continues to grow and evolve.
-
-### Unit Tests
-Most of the internal components the project uses have unit tests to thoroughly test them. Here dependencies of components are mocked or stubbed appropriately to ensure tests are reliable, test only one component and are fast!
-
-### Acceptance Tests
-
-Acceptance tests run the built `shopify` command line against a wide range of fixtures and verify its output and results. They are the slowest to run however provide the most coverage. The idea is to test a few complete scenarios for each major feature.
-
-Those are written in [Cucumber](https://cucumber.io/) and Ruby and can be found in the [`features/`](/features) directory. They can be executed by running
-
-```bash
-bundle exec cucumber
-bundle exec cucumber features/theme.feature:3 # A specific test
-```
-
-> **Note** that we currently don't have an approach for stubbing the interactions with the GraphQL APIs and that therefore we can't write acceptance tests for commands that interact with APIs.
+Check out the [contributors' documentation](/docs)

data/{Dockerfile → Codespace.dockerfile}

@@ -6,8 +6,7 @@ FROM cimg/ruby:2.7.1
 RUN git config --global user.email "development-lifecycle@shopify.com"
 RUN git config --global user.name "Development Lifecycle"
 
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
+RUN gem update bundler
 
 WORKDIR /usr/src/app
 
@@ -24,4 +23,13 @@ RUN sudo apt-get install git -y
 # Install the latest version of NodeJS
 RUN sudo apt-get install ca-certificates -y
 RUN curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -
-RUN sudo apt-get install -y nodejs
+RUN sudo apt-get install -y nodejs
+
+# Install the latest version of Yarn
+RUN sudo npm install --global yarn
+
+# Python is necessary to compile NPM packages with native extensions through node-gyp
+RUN sudo apt install python-minimal -y
+
+# Install sqlite3
+RUN sudo apt-get install libsqlite3-dev -y

data/Gemfile

@@ -14,6 +14,7 @@ group :development, :test do
   gem "rubocop-minitest", require: false
   gem "rubocop-rake", require: false
   gem "iniparse", "~> 1.5"
+  gem "colorize", "~> 0.8.1"
 end
 
 group :test do

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.6.4)
+    shopify-cli (2.7.1)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
-      theme-check (~> 1.7.2)
+      theme-check (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,6 +18,7 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
+    colorize (0.8.1)
     concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
@@ -89,7 +90,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.6)
@@ -118,7 +119,7 @@ GEM
     ruby-progressbar (1.11.0)
     sys-uname (1.2.2)
       ffi (~> 1.1)
-    theme-check (1.7.2)
+    theme-check (1.8.0)
       liquid (>= 5.1.0)
       nokogiri (>= 1.12)
       parser (~> 3)
@@ -135,6 +136,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.2.2)
   byebug
+  colorize (~> 0.8.1)
   cucumber (~> 7.0)
   fakefs (>= 1.0)
   iniparse (~> 1.5)

data/README.md

@@ -1,113 +1,34 @@
-# Shopify CLI
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
-[![Build Status](https://github.com/Shopify/shopify-cli/workflows/CI/badge.svg)](https://github.com/Shopify/shopify-cli/actions)
+<div align="center">
+  <img src="assets/logo.png" width="150"/>
+  <h1>Shopify CLI</h1>
+  <a href=""><img src="https://github.com/shopify/shopify-cli/workflows/CI/badge.svg" alt="Shopify"></a>
+  <img src="https://img.shields.io/github/v/release/shopify/shopify-cli?include_prereleases&style=flat-square" alt="Latest Version">
+  <img src="https://img.shields.io/github/forks/shopify/shopify-cli?style=flat-square" alt="GitHub forks">
+  <img src="https://img.shields.io/github/stars/shopify/shopify-cli?style=flat-square" alt="GitHub stars">
+  <img src="https://img.shields.io/github/commit-activity/w/shopify/shopify-cli?style=flat-square" alt="Commit Activity">
+    <img src="https://img.shields.io/github/contributors/shopify/shopify-cli?style=flat-square" alt="Contributors">
+  <img src="https://img.shields.io/github/commits-since/shopify/shopify-cli/latest?style=flat-square" alt="Latest Commits">
+  <a href="http://twitter.com/ShopifyDevs"><img src="https://img.shields.io/twitter/follow/ShopifyDevs?style=flat-square" alt="Twitter Followers"></a>
+  <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License">
+  <img src="https://img.shields.io/badge/Powered%20by-Ruby-red" alt="Powered by Ruby">
+</div>
 
 
 Shopify CLI helps you build Shopify themes and apps. Use Shopify CLI to automate and enhance your local development workflow.
 
 Shopify CLI is available as a gem and can be run and installed on Mac, Linux and Windows systems.
 
-## Installation for Mac OS Users
-
-- Make sure you have [Homebrew](https://brew.sh/) installed
-- Open your terminal app
-- Run `brew tap shopify/shopify`
-- Run `brew install shopify-cli`
-- After the installation is completed, run `shopify version`, if this outputs a version number you've successfully installed the CLI.
-
-### To upgrade Shopify CLI
-
-#### Homebrew (Mac OS)
-
-```shell
-$ brew update
-$ brew upgrade shopify-cli
-```
-
-#### apt (Debian, Ubuntu)
-
-1.- Download the latest `.deb` binary for Shopify CLI from the releases page.
-
-2.- Install the downloaded file and make sure to replace /path/to/download/shopify-cli-x.y.z.deb with the path to your file's location:
-
-```shell
-$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
-```
-
-#### yum (CentOS 8+, Fedora, Red Hat, SUSE)
-
-1.- Download the latest .rpm file for Shopify App CLI from the releases page.
-
-2.- Install the downloaded file and make sure to replace /path/to/downloaded/shopify-cli-x.y.x.rpm with the path to your file's location:
-
-```shell
- $ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
-```
-
-#### RubyGems (macOS, Linux, Windows 10)
-
-```shell
-$ gem update shopify-cli
-```
-
-
-## Command specification and semantics
-
-Shopify CLI offers a command structure similar to other CLIs:
-
-`shopify [ GLOBAL_ACTION | RESOURCE [ ACTION ] ] [ VARIADIC_ARGS ] [ OPTIONS ]`
-
-The top level command will always be a **resource** or a **global action**:
-
-- Resources represent Shopify concepts that you can work with in the CLI, for example `theme`.
-- Usually, global actions are commands that alter the state of the CLI (e.g `config` or `login`)
-
-Actions are commands that you can run to interact with a resource.
-
-You can add `--help` or `-h` to the end of your command to get a full explanation of the available options for the command.
-
-## Quick start guide for theme developers
-
-This quick start guide shows you how to begin local theme development when working with a new theme from scratch.
-
-### 1.- Authenticate the CLI
-
-After you install Shopify CLI, you need to authenticate your CLI instance and connect to the store that you want to work on.
-
-Run:
-
-`shopify login --store=<your-shop-url>`
-
-When prompted, open the provided accounts.shopify.com URL in a browser. In your browser window, log into the account that's attached to the store that you want to use for development.
-
-### 2.- Create a new theme
-
-Run:
-
-`shopify theme init`
-
-To initialize a theme on your current working directory. This will actually clone Shopify's starter theme which you should use as a reference when building themes for Shopify.
-
-### 3.- Start the local theme server
-
-Shopify CLI comes with a local theme server which lets you preview your changes live on your local machine.
-
-After you create or navigate to your theme, you can run `shopify theme serve` to interact with the theme in a browser. Shopify CLI uploads the theme as a development theme on the store that you're connected to, and gives you an IP address and port to preview changes in real time using the store's data.
-
-Run:
-
-`shopify theme serve`
+## Installation 
 
-To start the server. The server includes hot reload for CSS & Sections.
+Check out our [installation steps](docs/users/installation.md).
 
-**Note:** Shopify CLI is the recommended and officially supported tool for developing themes and creating CI/CD workflows. Please refer to the [Theme Kit Migration Guide](https://github.com/Shopify/shopify-cli/blob/main/THEMEKIT_MIGRATION.md) for details.
+## Contributing 👩‍💻
 
-### Contributing
+Shopify CLI is an [open source tool](/LICENSE) and everyone is welcome to help the community by [contributing](/docs/README.md) to the project.
 
-Shopify CLI is an [open source tool](https://github.com/Shopify/shopify-cli/blob/main/LICENSE) and everyone is welcome to help the community by [contributing](https://github.com/Shopify/shopify-cli/blob/main/.github/CONTRIBUTING.md) to the project.
+## Help 🖐
 
-### Where to get help
+If you encounter issues using the CLI or have feedback you'd like to share with us, below are some options:
 
 - [Open a GitHub issue](https://github.com/Shopify/shopify-cli/issues) - To report bugs or request new features, open an issue in the Shopify CLI repository.
 

data/Rakefile

@@ -146,6 +146,33 @@ namespace :extensions do
   end
 end
 
+namespace :scripts do
+  namespace :javy do
+    task :symlink do
+      source = Paths.root("..", "javy", "target", "release", "javy")
+      error("Unable to find javy executable: #{executable}") unless File.executable?(source)
+      target = Paths.javy("javy")
+      File.delete(target) if File.exist?(target)
+      File.symlink(source, target)
+    end
+
+    task :install do
+      require_relative Paths.javy("javy.rb")
+      Javy.install
+    end
+
+    module Paths
+      def self.javy(*args)
+        root("ext", "javy", *args)
+      end
+
+      def self.root(*args)
+        Pathname(File.dirname(__FILE__)).join(*args).to_s
+      end
+    end
+  end
+end
+
 def error(message, output: STDERR, code: 1)
   output.puts(message)
   exit(code)

data/Tests.dockerfile

@@ -0,0 +1,35 @@
+# This is a Docker image to test the CLI in UNIX environments other than macOS
+# Build the image: docker build . -t shopify-cli
+# Run tests: docker run -t --rm --volume "$(pwd):/usr/src/app" shopify-cli bundle exec rake test
+FROM cimg/ruby:2.7.1
+
+RUN git config --global user.email "development-lifecycle@shopify.com"
+RUN git config --global user.name "Development Lifecycle"
+
+RUN gem update bundler
+
+WORKDIR /usr/src/app
+
+COPY Gemfile Gemfile.lock ./
+COPY shopify-cli.gemspec  shopify-cli.gemspec
+COPY lib/shopify_cli/version.rb  lib/shopify_cli/version.rb
+RUN bundle install
+
+# Update git
+RUN sudo add-apt-repository -y ppa:git-core/ppa
+RUN sudo apt-get update
+RUN sudo apt-get install git -y
+
+# Install the latest version of NodeJS
+RUN sudo apt-get install ca-certificates -y
+RUN curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -
+RUN sudo apt-get install -y nodejs
+
+# Install the latest version of Yarn
+RUN sudo npm install --global yarn
+
+# Python is necessary to compile NPM packages with native extensions through node-gyp
+RUN sudo apt install python-minimal -y
+
+# Install sqlite3
+RUN sudo apt-get install libsqlite3-dev -y

data/dev.yml

@@ -13,9 +13,6 @@ up:
       - rpm:
           version: 4.16.1.3
   - bundler
-  - node:
-      version: 14.9.0
-      yarn: true
   - docker
 
 test:

data/docs/README.md

@@ -0,0 +1,13 @@
+# Documentation
+
+This directory contains documentation for **contributors** of the Shopify CLI.
+It also contains documentation that is relevant to **users** like migration guidelines.
+
+## Contributors
+
+- [**Testing**](contributors/testing.md): Read about testing strategies and how they are used across the codebase.
+
+## Users
+
+- [**Installation**](users/installation.md): Learn how to install the Shopify CLI in different OSs.
+- [**Migrate from theme-kit**](users/migrate-from-themekit.md): If you were previously using theme-kit, check out this documentation to learn how to migrate to the Shopify CLI theme commands.

data/docs/contributors/testing.md

@@ -0,0 +1,27 @@
+## Testing
+
+The project employs a diverse suite tests that help ensure it works as intended and prevents regressions as it continues to grow and evolve.
+
+### Unit Tests
+Most of the internal components the project uses have unit tests to thoroughly test them. Here dependencies of components are mocked or stubbed appropriately to ensure tests are reliable, test only one component and are fast!
+
+### Acceptance Tests
+
+Acceptance tests run the built `shopify` command line against a wide range of fixtures and verify its output and results. They are the slowest to run however provide the most coverage. The idea is to test a few complete scenarios for each major feature.
+
+Those are written in [Cucumber](https://cucumber.io/) and Ruby and can be found in the [`features/`](/features) directory. They can be executed by running:
+
+```bash
+bundle exec cucumber
+bundle exec cucumber features/theme.feature:3 # A specific test
+```
+
+> **Note** that we currently don't have an approach for stubbing the interactions with the GraphQL APIs and that therefore we can't write acceptance tests for commands that interact with APIs.
+
+#### Debugging acceptance tests
+When developing acceptance tests, it can be helpful to see the outputs of running commands.
+To see outputs, append `--verbose` when running an acceptance test. Example:
+
+```sh
+bundle exec cucumber features/theme.feature --verbose
+```

data/docs/users/installation.md

@@ -0,0 +1,46 @@
+# Installation
+
+## Installation through RubyGems
+
+The easiest method to install the Shopify CLI is through RubyGems:
+
+```shell
+$ gem install shopify-cli
+```
+
+## Installation for macOS Users
+
+- Make sure you have [Homebrew](https://brew.sh/) installed
+- Open your terminal app
+- Run `brew tap shopify/shopify`
+- Run `brew install shopify-cli`
+- After the installation is completed, run `shopify version`, if this outputs a version number you've successfully installed the CLI.
+
+### To upgrade Shopify CLI
+
+#### Homebrew (Mac OS)
+
+```shell
+$ brew update
+$ brew upgrade shopify-cli
+```
+
+## Installation for Debian and Ubuntu users through `apt`
+
+1.- Download the latest `.deb` binary for Shopify CLI from the releases page.
+
+2.- Install the downloaded file and make sure to replace /path/to/download/shopify-cli-x.y.z.deb with the path to your file's location:
+
+```shell
+$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
+```
+
+## Installation for CentOS 8+, Fedora, Red Hat, and SUSE users through `yum`
+
+1.- Download the latest .rpm file for Shopify App CLI from the releases page.
+
+2.- Install the downloaded file and make sure to replace /path/to/downloaded/shopify-cli-x.y.x.rpm with the path to your file's location:
+
+```shell
+ $ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
+```

data/{THEMEKIT_MIGRATION.md → docs/users/migrate-from-themekit.md}

@@ -1,4 +1,4 @@
-# Theme Kit Migration
+# Migrate from Theme Kit
 
 Shopify CLI is the recommended and officially supported tool for developing Themes and creating CI/CD workflows.