shopify-cli 1.4.0 → 1.7.1

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

@@ -5,15 +5,15 @@ module Node
       prerequisite_task :ensure_env, :ensure_dev_store
 
       options do |parser, flags|
-        parser.on('--host=HOST') do |h|
-          flags[:host] = h.gsub('"', '')
+        parser.on("--host=HOST") do |h|
+          flags[:host] = h.gsub('"', "")
         end
       end
 
       def call(*)
         project = ShopifyCli::Project.current
         url = options.flags[:host] || ShopifyCli::Tunnel.start(@ctx)
-        @ctx.abort(@ctx.message('node.serve.error.host_must_be_https')) if url.match(/^https/i).nil?
+        @ctx.abort(@ctx.message("node.serve.error.host_must_be_https")) if url.match(/^https/i).nil?
         project.env.update(@ctx, :host, url)
         ShopifyCli::Tasks::UpdateDashboardURLS.call(
           @ctx,
@@ -23,22 +23,22 @@ module Node
 
         if project.env.shop
           project_url = "#{project.env.host}/auth?shop=#{project.env.shop}"
-          @ctx.puts("\n" + @ctx.message('node.serve.open_info', project_url) + "\n")
+          @ctx.puts("\n" + @ctx.message("node.serve.open_info", project_url) + "\n")
         end
 
-        CLI::UI::Frame.open(@ctx.message('node.serve.running_server')) do
+        CLI::UI::Frame.open(@ctx.message("node.serve.running_server")) do
           env = project.env.to_h
-          env['PORT'] = ShopifyCli::Tunnel::PORT.to_s
-          @ctx.system('npm run dev', env: env)
+          env["PORT"] = ShopifyCli::Tunnel::PORT.to_s
+          @ctx.system("npm run dev", env: env)
         end
       end
 
       def self.help
-        ShopifyCli::Context.message('node.serve.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("node.serve.help", ShopifyCli::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message('node.serve.extended_help')
+        ShopifyCli::Context.message("node.serve.extended_help")
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'shopify_cli'
+require "shopify_cli"
 
 module Node
   module Commands
@@ -10,17 +10,17 @@ module Node
       def call(args, _name)
         subcommand = args.shift
         case subcommand
-        when 'auth'
+        when "auth"
           token = args.shift
           if token.nil?
-            @ctx.puts(@ctx.message('node.tunnel.error.token_argument_missing'))
+            @ctx.puts(@ctx.message("node.tunnel.error.token_argument_missing"))
             @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
           else
             ShopifyCli::Tunnel.auth(@ctx, token)
           end
-        when 'start'
+        when "start"
           ShopifyCli::Tunnel.start(@ctx)
-        when 'stop'
+        when "stop"
           ShopifyCli::Tunnel.stop(@ctx)
         else
           @ctx.puts(self.class.help)
@@ -28,11 +28,11 @@ module Node
       end
 
       def self.help
-        ShopifyCli::Context.message('node.tunnel.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("node.tunnel.help", ShopifyCli::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message('node.tunnel.extended_help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("node.tunnel.extended_help", ShopifyCli::TOOL_NAME)
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require 'uri'
+require "uri"
 
 module Node
   module Forms
@@ -7,7 +7,7 @@ module Node
       flag_arguments :title, :organization_id, :shop_domain, :type
 
       def ask
-        self.title ||= CLI::UI::Prompt.ask(ctx.message('node.forms.create.app_name'))
+        self.title ||= CLI::UI::Prompt.ask(ctx.message("node.forms.create.app_name"))
         self.type = ask_type
         self.name = self.title.downcase.split(" ").join("_")
         res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
@@ -19,16 +19,16 @@ module Node
 
       def ask_type
         if type.nil?
-          return CLI::UI::Prompt.ask(ctx.message('node.forms.create.app_type.select')) do |handler|
-            handler.option(ctx.message('node.forms.create.app_type.select_public')) { 'public' }
-            handler.option(ctx.message('node.forms.create.app_type.select_custom')) { 'custom' }
+          return CLI::UI::Prompt.ask(ctx.message("node.forms.create.app_type.select")) do |handler|
+            handler.option(ctx.message("node.forms.create.app_type.select_public")) { "public" }
+            handler.option(ctx.message("node.forms.create.app_type.select_custom")) { "custom" }
           end
         end
 
         unless ShopifyCli::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
-          ctx.abort(ctx.message('node.forms.create.error.invalid_app_type', type))
+          ctx.abort(ctx.message("node.forms.create.error.invalid_app_type", type))
         end
-        ctx.puts(ctx.message('node.forms.create.app_type.selected', type))
+        ctx.puts(ctx.message("node.forms.create.app_type.selected", type))
         type
       end
     end

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

@@ -8,15 +8,22 @@ 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.
             Usage: {{command:%s create node}}
             Options:
               {{command:--name=NAME}} App name. Any string.
-              {{command:--app_url=APPURL}} App URL. Must be a valid URL.
-              {{command:--organization_id=ID}} Partner organization ID. Must be an existing organization.
-              {{command:--shop_domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
+              {{command:--app-url=APPURL}} App URL. Must be a valid URL.
+              {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+              {{command:--shop-domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
           HELP
           error: {
             node_required: "node is required to create an app project. Download at https://nodejs.org/en/download.",
@@ -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",
         },
@@ -82,52 +83,17 @@ module Node
 
         generate: {
           help: <<~HELP,
-          Generate code in your Node project. Supports generating new billing API calls, new pages, or new webhooks.
-            Usage: {{command:%s generate [ billing | page | webhook ]}}
-          HELP
-          extended_help: <<~EXAMPLES,
-          {{bold:Examples:}}
-            {{cyan:%s generate webhook PRODUCTS_CREATE}}
-              Generate and register a new webhook that will be called every time a new product is created on your store.
-          EXAMPLES
-
-          error: {
-            name_exists: "%s already exists!",
-            generic: "Error generating %s",
-          },
-
-          billing: {
-            help: <<~HELP,
-            Enable charging for your app. This command generates the necessary code to call Shopify’s billing API.
-              Usage: {{command:%s generate billing [ one-time-billing | recurring-billing ]}}
-            HELP
-            type_select: "How would you like to charge for your app?",
-            generating: "Generating %s code ...",
-            generated: "{{green:%s}} generated in server/server.js",
-          },
+          {{red:The {{command:generate}} command is no longer supported.}}
+            You can complete any tasks previously supported by {{command:generate}} with these guides:
+            {{green:page}}
+              Create a page with Polaris design components: {{green:https://shopify.dev/tutorials/build-a-shopify-app-with-node-and-react/build-your-user-interface-with-polaris}}
 
-          page: {
-            help: <<~HELP,
-            Generate a new page in your app with the specified name. New files are generated inside the project’s “/pages” directory.
-              Usage: {{command:%s generate page <pagename>}}
-            HELP
-            error: {
-              invalid_page_type: "Invalid page type.",
-            },
-            type_select: "Which template would you like to use?",
-            generating: "Generating %s page...",
-            generated: "{{green: %s}} generated in pages/%s",
-          },
+            {{green:webhook}}
+              Register and process webhooks: {{green:https://github.com/Shopify/shopify-node-api/blob/main/docs/usage/webhooks.md}}
 
-          webhook: {
-            help: <<~HELP,
-            Generate and register a new webhook that listens for the specified Shopify store event.
-              Usage: {{command:%s generate webhook <type>}}
-            HELP
-            type_select: "What type of webhook would you like to create?",
-            generating: "Generating webhook: %s",
-            generated: "{{green:%s}} generated in server/server.js",
-          },
+            {{green:billing}}
+              Create and manage app billing models: {{green:https://shopify.dev/tutorials/bill-for-your-app-using-graphql-admin-api}}
+          HELP
         },
 
         open: {

data/lib/project_types/rails/cli.rb

@@ -1,29 +1,32 @@
 # 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")
-    register_command('Rails::Commands::Open', "open")
-    register_command('Rails::Commands::Populate', "populate")
-    register_command('Rails::Commands::Serve', "serve")
-    register_command('Rails::Commands::Tunnel', "tunnel")
+    register_command("Rails::Commands::Deploy", "deploy")
+    register_command("Rails::Commands::Generate", "generate")
+    register_command("Rails::Commands::Open", "open")
+    register_command("Rails::Commands::Populate", "populate")
+    register_command("Rails::Commands::Serve", "serve")
+    register_command("Rails::Commands::Tunnel", "tunnel")
     # register_task('Rails::Tasks::RailsTask', 'rails_task')
 
-    require Project.project_filepath('messages/messages')
+    require Project.project_filepath("messages/messages")
     register_messages(Rails::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
   module Commands
-    autoload :Create, Project.project_filepath('commands/create')
-    autoload :Deploy, Project.project_filepath('commands/deploy')
-    autoload :Generate, Project.project_filepath('commands/generate')
-    autoload :Open, Project.project_filepath('commands/open')
-    autoload :Populate, Project.project_filepath('commands/populate')
-    autoload :Serve, Project.project_filepath('commands/serve')
-    autoload :Tunnel, Project.project_filepath('commands/tunnel')
+    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")
+    autoload :Open, Project.project_filepath("commands/open")
+    autoload :Populate, Project.project_filepath("commands/populate")
+    autoload :Serve, Project.project_filepath("commands/serve")
+    autoload :Tunnel, Project.project_filepath("commands/tunnel")
   end
 
   # define/autoload project specific Tasks
@@ -32,9 +35,9 @@ module Rails
 
   # define/autoload project specific Forms
   module Forms
-    autoload :Create, Project.project_filepath('forms/create')
+    autoload :Create, Project.project_filepath("forms/create")
   end
 
-  autoload :Ruby, Project.project_filepath('ruby')
-  autoload :Gem, Project.project_filepath('gem')
+  autoload :Ruby, Project.project_filepath("ruby")
+  autoload :Gem, Project.project_filepath("gem")
 end

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

@@ -14,21 +14,25 @@ module Rails
 
       options do |parser, flags|
         # backwards compatibility allow 'title' for now
-        parser.on('--title=TITLE') { |t| flags[:title] = t }
-        parser.on('--name=NAME') { |t| flags[:title] = t }
-        parser.on('--organization_id=ID') { |url| flags[:organization_id] = url }
-        parser.on('--shop_domain=MYSHOPIFYDOMAIN') { |url| flags[:shop_domain] = url }
-        parser.on('--type=APPTYPE') { |url| flags[:type] = url }
-        parser.on('--db=DB') { |db| flags[:db] = db }
-        parser.on('--rails_opts=RAILSOPTS') { |opts| flags[:rails_opts] = opts }
+        parser.on("--title=TITLE") { |t| flags[:title] = t }
+        parser.on("--name=NAME") { |t| flags[:title] = t }
+        parser.on("--organization_id=ID") { |url| flags[:organization_id] = url }
+        parser.on("--organization-id=ID") { |url| flags[:organization_id] = url }
+        parser.on("--shop_domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
+        parser.on("--shop-domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
+        parser.on("--type=APPTYPE") { |url| flags[:type] = url }
+        parser.on("--db=DB") { |db| flags[:db] = db }
+        parser.on("--rails_opts=RAILSOPTS") { |opts| flags[:rails_opts] = opts }
+        parser.on("--rails-opts=RAILSOPTS") { |opts| flags[:rails_opts] = opts }
       end
 
       def call(args, _name)
         form = Forms::Create.ask(@ctx, args, options.flags)
         return @ctx.puts(self.class.help) if form.nil?
 
-        @ctx.abort(@ctx.message('rails.create.error.invalid_ruby_version')) unless
-          Ruby.version(@ctx).satisfies?('~>2.5')
+        ruby_version = Ruby.version(@ctx)
+        @ctx.abort(@ctx.message("rails.create.error.invalid_ruby_version")) unless
+          ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.0.0")
 
         check_node
         check_yarn
@@ -37,7 +41,7 @@ module Rails
         set_custom_ua
         ShopifyCli::Project.write(
           @ctx,
-          project_type: 'rails',
+          project_type: "rails",
           organization_id: form.organization_id,
         )
 
@@ -52,72 +56,74 @@ module Rails
           api_key: api_client["apiKey"],
           secret: api_client["apiSecretKeys"].first["secret"],
           shop: form.shop_domain,
-          scopes: 'write_products,write_customers,write_draft_orders',
+          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))
+        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
+        end
       end
 
       def self.help
-        ShopifyCli::Context.message('rails.create.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("rails.create.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
       end
 
       private
 
       def check_node
-        cmd_path = @ctx.which('node')
+        cmd_path = @ctx.which("node")
         if cmd_path.nil?
-          @ctx.abort(@ctx.message('rails.create.error.node_required')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.node_required') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'node'))
+          @ctx.abort(@ctx.message("rails.create.error.node_required")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.node_required") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "node"))
           raise ShopifyCli::AbortSilent
         end
 
-        version, stat = @ctx.capture2e('node', '-v')
+        version, stat = @ctx.capture2e("node", "-v")
         unless stat.success?
-          @ctx.abort(@ctx.message('rails.create.error.node_version_failure')) unless @ctx.windows?
+          @ctx.abort(@ctx.message("rails.create.error.node_version_failure")) unless @ctx.windows?
           # execution stops above if not Windows
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.node_version_failure') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'node'))
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.node_version_failure") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "node"))
           raise ShopifyCli::AbortSilent
         end
 
-        @ctx.done(@ctx.message('rails.create.node_version', version))
+        @ctx.done(@ctx.message("rails.create.node_version", version))
       end
 
       def check_yarn
-        cmd_path = @ctx.which('yarn')
+        cmd_path = @ctx.which("yarn")
         if cmd_path.nil?
-          @ctx.abort(@ctx.message('rails.create.error.yarn_required')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.yarn_required') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'yarn'))
+          @ctx.abort(@ctx.message("rails.create.error.yarn_required")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.yarn_required") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "yarn"))
           raise ShopifyCli::AbortSilent
         end
 
-        version, stat = @ctx.capture2e('yarn', '-v')
+        version, stat = @ctx.capture2e("yarn", "-v")
         unless stat.success?
-          @ctx.abort(@ctx.message('rails.create.error.yarn_version_failure')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.yarn_version_failure') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'yarn'))
+          @ctx.abort(@ctx.message("rails.create.error.yarn_version_failure")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.yarn_version_failure") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "yarn"))
           raise ShopifyCli::AbortSilent
         end
 
-        @ctx.done(@ctx.message('rails.create.yarn_version', version))
+        @ctx.done(@ctx.message("rails.create.yarn_version", version))
       end
 
       def build(name, db)
-        @ctx.abort(@ctx.message('rails.create.error.install_failure', 'rails')) unless install_gem('rails')
-        @ctx.abort(@ctx.message('rails.create.error.install_failure', 'bundler ~>2.0')) unless
-          install_gem('bundler', '~>2.0')
+        @ctx.abort(@ctx.message("rails.create.error.install_failure", "rails")) unless install_gem("rails", "<6.1")
+        @ctx.abort(@ctx.message("rails.create.error.install_failure", "bundler ~>2.0")) unless
+          install_gem("bundler", "~>2.0")
 
         full_path = File.join(@ctx.root, name)
-        @ctx.abort(@ctx.message('rails.create.error.dir_exists', name)) if Dir.exist?(full_path)
+        @ctx.abort(@ctx.message("rails.create.error.dir_exists", name)) if Dir.exist?(full_path)
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.generating_app', name)) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.generating_app", name)) do
           new_command = %w(rails new)
           new_command += DEFAULT_RAILS_FLAGS
           new_command << "--database=#{db}"
@@ -129,38 +135,34 @@ module Rails
 
         @ctx.root = full_path
 
-        File.open(File.join(@ctx.root, '.gitignore'), 'a') { |f| f.write('.env') }
+        File.open(File.join(@ctx.root, ".gitignore"), "a") { |f| f.write(".env") }
 
-        @ctx.puts(@ctx.message('rails.create.adding_shopify_gem'))
-        File.open(File.join(@ctx.root, 'Gemfile'), 'a') do |f|
-          f.puts "\ngem 'shopify_app', '>=11.3.0'"
+        @ctx.puts(@ctx.message("rails.create.adding_shopify_gem"))
+        File.open(File.join(@ctx.root, "Gemfile"), "a") do |f|
+          f.puts "\ngem 'shopify_app', '>=17.0.3'"
         end
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_bundle_install')) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_bundle_install")) do
           syscall(%w(bundle install))
         end
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_generator')) do
-          begin
-            syscall(%w(spring stop))
-          rescue
-          end
-          syscall(%w(rails generate shopify_app))
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_generator")) do
+          syscall(%w(rails generate shopify_app --new-shopify-cli-app))
         end
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_migrations')) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_migrations")) do
           syscall(%w(rails db:create))
           syscall(%w(rails db:migrate RAILS_ENV=development))
         end
 
-        unless File.exist?(File.join(@ctx.root, 'config/webpacker.yml'))
-          CLI::UI::Frame.open(@ctx.message('rails.create.running_webpacker_install')) do
+        unless File.exist?(File.join(@ctx.root, "config/webpacker.yml"))
+          CLI::UI::Frame.open(@ctx.message("rails.create.running_webpacker_install")) do
             syscall(%w(rails webpacker:install))
           end
         end
       end
 
       def set_custom_ua
-        ua_path = File.join('config', 'initializers', 'user_agent.rb')
+        ua_path = File.join("config", "initializers", "user_agent.rb")
         @ctx.write(ua_path, USER_AGENT_CODE)
       end
 
@@ -173,9 +175,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