shopify-cli 1.0.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b05da9533ccffc11607217b455d2a23590668a445a0af58c67c168fe5a5dfe96
-  data.tar.gz: e10408bf78ac963dd50953edbf438bc4dbf247d0001db8a1b1013b0f981189f1
+  metadata.gz: 453f515f6f175bcc507b9a967880660da88455a97fc4ac593e5526ce6d410b0d
+  data.tar.gz: 134e8f9fc243aaad0eee527c37784680fef10ad2b53ab6d5787965a026457772
 SHA512:
-  metadata.gz: 7626a67bc6ba0fe13b6223b4239927e4f4e39c74a2536e7fe0a38b4403d9c115771a913c4921d28a81175de84c1cc9e7fc9b84e046042a5957ba9f3aa1d56d7d
-  data.tar.gz: 630008b941f6c034f51fcdb370f6dd09dba5bcb18a44b5bd1035367443bdc28d679adf69ee9e0f3a9417ddfcbef473411d99934a9a14fc777310edf67677711c
+  metadata.gz: 950380758e1d7babd1db489718f7487c6511f8d72dc26e3e894d1779c8097303ed58cb308d8db8db3ed136fd0e659af96ed06fdeff2191af8afca1e85cd68921
+  data.tar.gz: e3ed02e945e4211f529b2aae0c1caa6de6c39947adcf91cdd99c0ddf641e930abbd994a0f5bf918eb6f37c0142e69de477c0062985e565a25480856beaf70dd0

data/.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@ Shopify App CLI is an open source project. We want to make it as easy and transp
 
 ## Code of conduct
 
-We expect all participants to read our [code of conduct](https://github.com/Shopify/shopify-app-cli/.github/CODE_OF_CONDUCT.md) to understand which actions are and aren’t tolerated.
+We expect all participants to read our [code of conduct](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CODE_OF_CONDUCT.md) to understand which actions are and aren’t tolerated.
 
 ## Open development
 

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+Version 1.3.0
+------
+* Support for new `shopify config analytics` command to enable/disable anonymous usage reporting
+
+Version 1.2.0
+------
+* Improvements and new functionality to various internal components
+
+Version 1.1.2
+------
+* Fix various minor bugs (check dir before creating Rails project, catch stderr from failed git command)
+
+Version 1.1.1
+------
+* Fix a bug where usernames with spaces caused issues on Windows
+
+Version 1.1.0
+------
+* Add native Windows 10 support, including variety of stability fixes.
+
 Version 1.0.5
 ------
 * Fix a bug in out opt-in metrics

data/bin/load_shopify.rb

@@ -9,7 +9,9 @@ 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(':').select { |p| p.start_with?('/', '~') }.join(':')
+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
 

data/bin/shopify

@@ -8,6 +8,8 @@ module Kernel
   def require(name)
     original_require(name)
   rescue LoadError => e
+    # Special case for readline.so, which fails harmlessly on Windows
+    raise if (name == "readline.so") && ShopifyCli::Context.new.windows?
     # Special case for psych (yaml), which rescues this itself
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify App CLI."

data/docs/core/index.md

@@ -68,3 +68,19 @@ Log out of the currently authenticated partner organization and store. The `logo
 $ 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

@@ -8,14 +8,15 @@ Developers should have some prior knowledge of the [Shopify app ecosystem](https
 
 ## Requirements
 
-- [Ruby](https://www.ruby-lang.org) 2.5.1+ 
 - 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
 
-You’ll need to install the following tools to use Shopify App CLI on Windows:
+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)
 

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

@@ -5,9 +5,15 @@ toc: false
 redirect_from: "/install/"
 ---
 
-Shopify App CLI can be installed using a variety of package managers.
+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.
 
-### Homebrew (macOS)
+---
+### 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.
 
@@ -16,28 +22,68 @@ $ brew tap shopify/shopify
 $ brew install shopify-cli
 ```
 
-### apt (Debian, Ubuntu)
+**RubyGems**
+
+See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
+
+---
+
+### Debian/Ubuntu Linux
 
-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.
+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 shopify-cli-x.y.z.deb
+$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
 ```
 
-### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+**RubyGems**
+
+See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
+
+---
+
+### CentOS 8+/Fedora/Red Hat/SUSE Linux
 
-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.
+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 shopify-cli-x.y.x.rpm
+$ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
 ```
 
-### Ruby gem
+**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

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

@@ -25,7 +25,7 @@ $ sudo apt remove shopify-cli
 $ sudo yum remove shopify-cli
 ```
 
-### Ruby gem
+### RubyGems (macOS, Linux, Windows 10)
 
 ```console
 $ gem uninstall shopify-cli

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

@@ -5,7 +5,7 @@ toc: false
 redirect_from: "/upgrade/"
 ---
 
-You can manage upgrades to Shopify App CLI with the package manager for your platform.
+You can manage upgrades to Shopify App CLI with the package manager for your platform.  **Note** that it's important to use the same package manager to upgrade that you originally used to install Shopify App CLI.
 
 ### Homebrew (macOS)
 
@@ -18,19 +18,23 @@ $ brew upgrade shopify-cli
 
 On Debian-based Linux distributions, download the latest `.deb` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
 
+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 shopify-cli-x.y.z.deb
+$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
 ```
 
 ### yum (CentOS 8+, Fedora, Red Hat, SUSE)
 
 On Red Hat–based Linux distributions, download the latest `.rpm` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
 
+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 shopify-cli-x.y.z.rpm
+$ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
 ```
 
-### Ruby gem
+### RubyGems (macOS, Linux, Windows 10)
 
 ```console
 $ gem update shopify-cli

data/ext/shopify-cli/extconf.rb

@@ -3,25 +3,45 @@ require 'fileutils'
 
 gem = File.expand_path('../../../', __FILE__)
 exe = File.join(gem, 'bin', 'shopify')
-script = exe + '.sh'
-symlink = '/usr/local/bin/shopify'
-
-script_content = <<~SCRIPT
-  #!/usr/bin/env bash
-  #{RbConfig.ruby} --disable=gems -I #{gem} #{exe} $@
-SCRIPT
-
-File.write(script, script_content)
-FileUtils.chmod("+x", script)
-
-makefile_content = <<~MAKEFILE
-  .PHONY: clean install
-  
-  clean:
-  \t@sudo rm -f #{symlink}
-  
-  install: clean
-  \t@sudo ln -s #{script} #{symlink}
-MAKEFILE
+
+if RUBY_PLATFORM.match(/mingw32/)
+  bat_path = File.dirname(RbConfig.ruby)
+  bat = "#{bat_path}\\shopify.bat"
+
+  script_content = "#{RbConfig.ruby} --disable=gems -I '#{gem}' '#{exe}' %*"
+
+  FileUtils.mkdir_p(bat_path)
+  makefile_content = <<~MAKEFILE
+    .PHONY: clean install
+
+    clean:
+    \t rm -f "#{bat}"
+
+    install: clean
+    \t echo "@ECHO OFF"> "#{bat}"
+    \t echo "#{script_content}">> "#{bat}"
+  MAKEFILE
+else
+  script = exe + '.sh'
+  symlink = '/usr/local/bin/shopify'
+
+  script_content = <<~SCRIPT
+    #!/usr/bin/env bash
+    #{RbConfig.ruby} --disable=gems -I #{gem} #{exe} $@
+  SCRIPT
+
+  File.write(script, script_content)
+  FileUtils.chmod("+x", script)
+
+  makefile_content = <<~MAKEFILE
+    .PHONY: clean install
+    
+    clean:
+    \t@sudo rm -f #{symlink}
+    
+    install: clean
+    \t@sudo ln -s #{script} #{symlink}
+  MAKEFILE
+end
 
 File.write('Makefile', makefile_content)

data/lib/project_types/extension/cli.rb

@@ -48,11 +48,16 @@ module Extension
   end
 
   module Features
-    autoload :Argo, Project.project_filepath('features/argo')
     autoload :ArgoSetup, Project.project_filepath('features/argo_setup')
     autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
     autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
     autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
+    autoload :ArgoConfig, Project.project_filepath('features/argo_config')
+    module Argo
+      autoload :Base, Project.project_filepath('features/argo/base')
+      autoload :Admin, Project.project_filepath('features/argo/admin')
+      autoload :Checkout, Project.project_filepath('features/argo/checkout')
+    end
   end
 
   module Models

data/lib/project_types/extension/commands/register.rb

@@ -52,7 +52,7 @@ module Extension
         Tasks::CreateExtension.call(
           context: @ctx,
           api_key: app.api_key,
-          type: extension_type.identifier,
+          type: extension_type.graphql_identifier,
           title: project.title,
           config: {},
           extension_context: extension_type.extension_context(@ctx)

data/lib/project_types/extension/features/argo/admin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Extension
+  module Features
+    module Argo
+      class Admin < Base
+        GIT_TEMPLATE = 'https://github.com/Shopify/argo-admin-template.git'
+        RENDERER_PACKAGE = '@shopify/argo-admin'
+        private_constant :GIT_TEMPLATE, :RENDERER_PACKAGE
+
+        def git_template
+          GIT_TEMPLATE
+        end
+
+        def renderer_package_name
+          RENDERER_PACKAGE
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/features/argo/base.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require 'base64'
+require 'shopify_cli'
+require 'semantic/semantic'
+
+module Extension
+  module Features
+    module Argo
+      class Base
+        include SmartProperties
+
+        SCRIPT_PATH = %w(build main.js).freeze
+
+        NPM_LIST_COMMAND = %w(list).freeze
+        YARN_LIST_COMMAND = %w(list --pattern).freeze
+        NPM_LIST_PARAMETERS = %w(--prod).freeze
+        YARN_LIST_PARAMETERS = %w(--production).freeze
+        private_constant :NPM_LIST_COMMAND, :YARN_LIST_COMMAND, :NPM_LIST_PARAMETERS, :YARN_LIST_PARAMETERS
+
+        YARN_INSTALL_COMMAND = %w(install).freeze
+        YARN_INSTALL_PARAMETERS = %w(--silent).freeze
+        YARN_RUN_COMMAND = %w(run).freeze
+        YARN_RUN_SCRIPT_NAME = %w(build).freeze
+        private_constant :YARN_INSTALL_COMMAND, :YARN_INSTALL_PARAMETERS, :YARN_RUN_COMMAND, :YARN_RUN_SCRIPT_NAME
+
+        def create(directory_name, identifier, context)
+          Features::ArgoSetup.new(git_template: git_template).call(directory_name, identifier, context)
+        end
+
+        def config(context)
+          js_system = ShopifyCli::JsSystem.new(ctx: context)
+          if js_system.package_manager == 'yarn'
+            run_yarn_install(context, js_system)
+            run_yarn_run_script(context, js_system)
+          end
+          filepath = File.join(context.root, SCRIPT_PATH)
+          context.abort(context.message('features.argo.missing_file_error')) unless File.exist?(filepath)
+          begin
+            {
+              renderer_version: extract_argo_renderer_version(context),
+              serialized_script: Base64.strict_encode64(File.read(filepath).chomp),
+            }
+          rescue StandardError
+            context.abort(context.message('features.argo.script_prepare_error'))
+          end
+        end
+
+        def git_template
+          raise NotImplementedError, "'#{__method__}' must be implemented for #{self.class}"
+        end
+
+        def renderer_package_name
+          # The renderer_package_name is used as a regex pattern to
+          # find a match in the output of yarn or npm list command.
+          # Use the full package name as it appears in the template without targeting a version.
+          # Examples: "@shopify/some-renderer-package", "argo-renderer-package"
+
+          raise NotImplementedError, "'#{__method__}' must be implemented for #{self.class}"
+        end
+
+        private
+
+        def extract_argo_renderer_version(context)
+          result = run_list_command(context)
+          found_version = find_version_number(context, result)
+          context.abort(
+            context.message('features.argo.dependencies.argo_renderer_package_invalid_version_error')
+          ) if found_version.nil?
+          ::Semantic::Version.new(found_version).to_s
+        rescue ArgumentError
+          context.abort(
+            context.message('features.argo.dependencies.argo_renderer_package_invalid_version_error')
+          )
+        end
+
+        def find_version_number(context, result)
+          packages = result.to_json.split('\n')
+          found_package = packages.find do |package|
+            package.match(/#{renderer_package_name}@/)
+          end
+          if found_package.nil?
+            error = "'#{renderer_package_name}' not found."
+            context.abort(
+              context.message('features.argo.dependencies.argo_missing_renderer_package_error', error)
+            )
+          end
+          found_package.split('@')[2]&.strip
+        end
+
+        def run_list_command(context)
+          js_system = ShopifyCli::JsSystem.new(ctx: context)
+          result, error, status = js_system.call(
+            yarn: YARN_LIST_COMMAND + [renderer_package_name] + YARN_LIST_PARAMETERS,
+            npm: NPM_LIST_COMMAND + [renderer_package_name] + NPM_LIST_PARAMETERS,
+            capture_response: true
+          )
+          context.abort(
+            context.message('features.argo.dependencies.argo_missing_renderer_package_error', error)
+          ) unless status.success?
+          result
+        end
+
+        def run_yarn_install(context, js_system)
+          _result, error, status = js_system.call(
+            yarn: YARN_INSTALL_COMMAND + YARN_INSTALL_PARAMETERS,
+            npm: [],
+            capture_response: true
+          )
+
+          context.abort(
+            context.message('features.argo.dependencies.yarn_install_error', error)
+          ) unless status.success?
+        end
+
+        def run_yarn_run_script(context, js_system)
+          _result, error, status = js_system.call(
+            yarn: YARN_RUN_COMMAND + YARN_RUN_SCRIPT_NAME,
+            npm: [],
+            capture_response: true
+          )
+
+          context.abort(
+            context.message('features.argo.dependencies.yarn_run_script_error', error)
+          ) unless status.success?
+        end
+      end
+    end
+  end
+end