shopify-cli 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b440a68e264b97888e3cb181eea5e2465522c3d67338851e08775cc743416a5
-  data.tar.gz: a6f2acacf046ab9c6bd174d7bd077a0ea87312f844db05de015c9cacf5d972bf
+  metadata.gz: 6d907a49558ca8dfb5998667698b5bf262d850a55951ac2af30c178f141d9063
+  data.tar.gz: 833124c900634e59426bef89dd7fbf35948d19b73e55ecb96becfb6307b3cc3a
 SHA512:
-  metadata.gz: dc49412e3aa3f7bc5dde8fa5943d2d52ae09138e92de3fcbd949353430a2ea5275dd157951dcf81770cdb36ccb5c023a570ddea3eb7756a357709360d51bb3b4
-  data.tar.gz: 648a9df9b5647e869d92cc23241628fbe336efeeb8c9c6ade691d55b14cb075c419e87a2f97c5eddf851e99bba1da5e595cfcd13d2d78c6c5c0cafbaeaa85dc1
+  metadata.gz: 4670c00c70ae907f1d5eea958ba512ac61e2579566dabf4bb09345925d6da2cd882e5c4d0e9bededd92fd779f85326d4b4cbc66d3c268ee816aa0d23330bc55c
+  data.tar.gz: 33a780da492b11846f89d84b74da119d707236846e4b9617ccb1541cde9be83b0f33fcf302d92b3aaa58c3634ed9004d3d2b7673f0a2a916b33ed2336b2835f9

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,4 @@ 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)

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

@@ -11,4 +11,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,11 @@
 Unreleased
 ------
 
+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
+
 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

@@ -16,6 +16,7 @@ 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

data/Gemfile.lock

@@ -13,13 +13,15 @@ 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)
+    parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
@@ -33,21 +35,21 @@ GEM
     rake (13.0.1)
     regexp_parser (1.8.2)
     rexml (3.2.4)
-    rubocop (0.93.1)
+    rubocop (1.4.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.1.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.0)
+    rubocop-ast (1.1.1)
       parser (>= 2.7.1.5)
     rubocop-minitest (0.10.1)
       rubocop (>= 0.87)
-    rubocop-shopify (1.0.6)
-      rubocop (>= 0.92, < 0.94)
+    rubocop-shopify (1.0.7)
+      rubocop (~> 1.4)
     ruby-progressbar (1.10.1)
     timecop (0.9.2)
     unicode-display_width (1.7.0)
@@ -63,6 +65,7 @@ DEPENDENCIES
   byebug
   fakefs (>= 1.0)
   minitest (>= 5.0.0)
+  minitest-fail-fast
   minitest-reporters
   mocha
   pry-byebug

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/lib/project_types/extension/cli.rb

@@ -3,7 +3,8 @@
 module Extension
   class Project < ShopifyCli::ProjectType
     hidden_feature
-    creator 'App Extension', 'Extension::Commands::Create'
+    title('App Extension')
+    creator('Extension::Commands::Create')
 
     register_command('Extension::Commands::Build', "build")
     register_command('Extension::Commands::Register', "register")

data/lib/project_types/node/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Node
   class Project < ShopifyCli::ProjectType
-    creator 'Node.js App', 'Node::Commands::Create'
+    title('Node.js App')
+    creator('Node::Commands::Create')
+    connector('Node::Commands::Connect')
 
     register_command('Node::Commands::Deploy', "deploy")
     register_command('Node::Commands::Generate', "generate")
@@ -17,6 +19,7 @@ module Node
 
   # define/autoload project specific Commands
   module Commands
+    autoload :Connect, Project.project_filepath('commands/connect')
     autoload :Create, Project.project_filepath('commands/create')
     autoload :Deploy, Project.project_filepath('commands/deploy')
     autoload :Generate, Project.project_filepath('commands/generate')

data/lib/project_types/node/commands/connect.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Node
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      def call(*)
+        if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
+          @ctx.puts(@ctx.message('node.connect.production_warning'))
+        end
+
+        app = ShopifyCli::Commands::Connect.new.default_connect('node')
+        @ctx.done(@ctx.message('node.connect.connected', app))
+      end
+    end
+  end
+end

data/lib/project_types/node/commands/create.rb

@@ -40,11 +40,11 @@ module Node
           scopes: 'write_products,write_customers,write_draft_orders',
         ).write(@ctx)
 
-        partners_url = "#{partners_endpoint}/#{form.organization_id}/apps/#{api_client['id']}"
+        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client['id'], local_debug?)
 
-        @ctx.puts(@ctx.message('node.create.info.created', form.title, partners_url))
-        @ctx.puts(@ctx.message('node.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
-        @ctx.puts(@ctx.message('node.create.info.install', partners_url, form.title))
+        @ctx.puts(@ctx.message('apps.create.info.created', form.title, partners_url))
+        @ctx.puts(@ctx.message('apps.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
+        @ctx.puts(@ctx.message('apps.create.info.install', partners_url, form.title))
       end
 
       def self.help
@@ -113,9 +113,8 @@ module Node
         end
       end
 
-      def partners_endpoint
-        return 'https://partners.myshopify.io' if @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
-        'https://partners.shopify.com'
+      def local_debug?
+        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
       end
     end
   end

data/lib/project_types/node/messages/messages.rb

@@ -8,6 +8,13 @@ module Node
           generic: "Error",
         },
 
+        connect: {
+          connected: "Project now connected to {{green:%s}}",
+          production_warning: <<~MESSAGE,
+          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+          MESSAGE
+        },
+
         create: {
           help: <<~HELP,
           {{command:%s create node}}: Creates an embedded nodejs app.
@@ -26,12 +33,6 @@ module Node
             npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
               "the instructions at https://www.npmjs.com/get-npm.",
           },
-          info: {
-            created: "{{v}} {{green:%s}} was created in your Partner Dashboard {{underline:%s}}",
-            serve: "{{*}} Change directories to your new project folder {{green:%s}} and run {{command:%s serve}} " \
-              "to start a local server",
-            install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
-          },
           node_version: "node %s",
           npm_version: "npm %s",
         },

data/lib/project_types/rails/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Rails
   class Project < ShopifyCli::ProjectType
-    creator 'Ruby on Rails App', 'Rails::Commands::Create'
+    title('Ruby on Rails App')
+    creator('Rails::Commands::Create')
+    connector('Rails::Commands::Connect')
 
     register_command('Rails::Commands::Deploy', "deploy")
     register_command('Rails::Commands::Generate', "generate")
@@ -17,6 +19,7 @@ module Rails
 
   # define/autoload project specific Commands
   module Commands
+    autoload :Connect, Project.project_filepath('commands/connect')
     autoload :Create, Project.project_filepath('commands/create')
     autoload :Deploy, Project.project_filepath('commands/deploy')
     autoload :Generate, Project.project_filepath('commands/generate')

data/lib/project_types/rails/commands/connect.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Rails
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      def call(*)
+        if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
+          @ctx.puts(@ctx.message('rails.connect.production_warning'))
+        end
+
+        app = ShopifyCli::Commands::Connect.new.default_connect('rails')
+        @ctx.done(@ctx.message('rails.connect.connected', app))
+      end
+    end
+  end
+end

data/lib/project_types/rails/commands/create.rb

@@ -55,11 +55,11 @@ module Rails
           scopes: 'write_products,write_customers,write_draft_orders',
         ).write(@ctx)
 
-        partners_url = "#{partners_endpoint}/#{form.organization_id}/apps/#{api_client['id']}"
+        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client['id'], local_debug?)
 
-        @ctx.puts(@ctx.message('rails.create.info.created', form.title, partners_url))
-        @ctx.puts(@ctx.message('rails.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
-        @ctx.puts(@ctx.message('rails.create.info.install', partners_url, form.title))
+        @ctx.puts(@ctx.message('apps.create.info.created', form.title, partners_url))
+        @ctx.puts(@ctx.message('apps.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
+        @ctx.puts(@ctx.message('apps.create.info.install', partners_url, form.title))
       end
 
       def self.help
@@ -173,9 +173,8 @@ module Rails
         Gem.install(@ctx, name, version)
       end
 
-      def partners_endpoint
-        return 'https://partners.myshopify.io' if @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
-        'https://partners.shopify.com'
+      def local_debug?
+        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
       end
     end
   end

data/lib/project_types/rails/messages/messages.rb

@@ -17,6 +17,13 @@ module Rails
           setting_gem_path: "GEM_PATH being set to %s",
         },
 
+        connect: {
+          connected: "Project now connected to {{green:%s}}",
+          production_warning: <<~MESSAGE,
+          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+          MESSAGE
+        },
+
         create: {
           help: <<~HELP,
           {{command:%s create rails}}: Creates a ruby on rails app.
@@ -48,10 +55,6 @@ module Rails
           },
 
           info: {
-            created: "{{v}} {{green:%s}} was created in your Partner Dashboard {{underline:%s}}",
-            serve: "{{*}} Change directories to your new project folder {{green:%s}} and run {{command:%s serve}} " \
-              "to start a local server",
-            install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
             open_new_shell: "{{*}} {{yellow:After installing %s, please open a new Command Prompt or PowerShell " \
               "window to continue.}}",
           },