shopify-cli 1.4.1 → 1.8.0

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

@@ -1,27 +1,27 @@
-require 'uri'
+require "uri"
 
 module Rails
   module Forms
     class Create < ShopifyCli::Form
       attr_accessor :name
       flag_arguments :title, :organization_id, :shop_domain, :type, :db
-      VALID_DB_TYPES = ['sqlite3',
-                        'mysql',
-                        'postgresql',
-                        'sqlite3',
-                        'oracle',
-                        'frontbase',
-                        'ibm_db',
-                        'sqlserver',
-                        'jdbcmysql',
-                        'jdbcsqlite3',
-                        'jdbcpostgresql',
-                        'jdbc']
+      VALID_DB_TYPES = ["sqlite3",
+                        "mysql",
+                        "postgresql",
+                        "sqlite3",
+                        "oracle",
+                        "frontbase",
+                        "ibm_db",
+                        "sqlserver",
+                        "jdbcmysql",
+                        "jdbcsqlite3",
+                        "jdbcpostgresql",
+                        "jdbc"]
 
       def ask
-        self.title ||= CLI::UI::Prompt.ask(ctx.message('rails.forms.create.app_name'))
+        self.title ||= CLI::UI::Prompt.ask(ctx.message("rails.forms.create.app_name"))
+        self.name = format_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)
         self.organization_id = res[:organization_id]
         self.shop_domain = res[:shop_domain]
@@ -30,26 +30,36 @@ module Rails
 
       private
 
+      def format_name
+        name = title.downcase.split(" ").join("_")
+
+        if name.include?("shopify")
+          ctx.abort(ctx.message("rails.forms.create.error.invalid_app_name"))
+        end
+
+        name
+      end
+
       def ask_type
         if type.nil?
-          return CLI::UI::Prompt.ask(ctx.message('rails.forms.create.app_type.select')) do |handler|
-            handler.option(ctx.message('rails.forms.create.app_type.select_public')) { 'public' }
-            handler.option(ctx.message('rails.forms.create.app_type.select_custom')) { 'custom' }
+          return CLI::UI::Prompt.ask(ctx.message("rails.forms.create.app_type.select")) do |handler|
+            handler.option(ctx.message("rails.forms.create.app_type.select_public")) { "public" }
+            handler.option(ctx.message("rails.forms.create.app_type.select_custom")) { "custom" }
           end
         end
 
         unless ShopifyCli::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
-          ctx.abort(ctx.message('rails.forms.create.error.invalid_app_type', type))
+          ctx.abort(ctx.message("rails.forms.create.error.invalid_app_type", type))
         end
-        ctx.puts(ctx.message('rails.forms.create.app_type.selected', type))
+        ctx.puts(ctx.message("rails.forms.create.app_type.selected", type))
         type
       end
 
       def ask_db
         if db.nil?
-          return 'sqlite3' unless CLI::UI::Prompt.confirm(ctx.message('rails.forms.create.db.want_select'),
-                                                          default: false)
-          @db = CLI::UI::Prompt.ask(ctx.message('rails.forms.create.db.select')) do |handler|
+          return "sqlite3" unless CLI::UI::Prompt.confirm(ctx.message("rails.forms.create.db.want_select"),
+            default: false)
+          @db = CLI::UI::Prompt.ask(ctx.message("rails.forms.create.db.select")) do |handler|
             VALID_DB_TYPES.each do |db_type|
               handler.option(ctx.message("rails.forms.create.db.select_#{db_type}")) { db_type }
             end
@@ -57,9 +67,9 @@ module Rails
         end
 
         unless VALID_DB_TYPES.include?(db)
-          ctx.abort(ctx.message('rails.forms.create.error.invalid_db_type', db))
+          ctx.abort(ctx.message("rails.forms.create.error.invalid_db_type", db))
         end
-        ctx.puts(ctx.message('rails.forms.create.db.selected', db))
+        ctx.puts(ctx.message("rails.forms.create.db.selected", db))
         db
       end
     end

data/lib/project_types/rails/gem.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Rails
   class Gem
@@ -14,52 +14,52 @@ module Rails
         name = args.shift
         version = args.shift
         gem = new(ctx: ctx, name: name, version: version)
-        ctx.debug(ctx.message('rails.gem.installed_debug', name, gem.installed?))
+        ctx.debug(ctx.message("rails.gem.installed_debug", name, gem.installed?))
         gem.installed? ? true : gem.install!
       end
 
       def binary_path_for(ctx, binary)
-        path_to_binary = File.join(gem_home(ctx), 'bin', binary)
+        path_to_binary = File.join(gem_home(ctx), "bin", binary)
         File.exist?(path_to_binary) ? path_to_binary : binary
       end
 
       def gem_home(ctx)
-        ctx.getenv('GEM_HOME') || apply_gem_home(ctx)
+        ctx.getenv("GEM_HOME") || apply_gem_home(ctx)
       end
 
       def gem_path(ctx)
-        ctx.getenv('GEM_PATH') || apply_gem_path(ctx)
+        ctx.getenv("GEM_PATH") || apply_gem_path(ctx)
       end
 
       private
 
       def apply_gem_home(ctx)
-        path = ''
+        path = ""
         # extract GEM_HOME from `gem environment home` command
-        out, stat = ctx.capture2e('gem', 'environment', 'home')
-        path = out&.empty? ? '' : out.strip if stat.success?
+        out, stat = ctx.capture2e("gem", "environment", "home")
+        path = out&.empty? ? "" : out.strip if stat.success?
         # fallback if return from `gem environment home` is empty (somewhat unlikely)
         path = fallback_gem_home_path(ctx) if path.empty?
         # fallback if path isn't writable (if using a system installed ruby)
         path = fallback_gem_home_path(ctx) unless File.writable?(path)
         ctx.mkdir_p(path) unless Dir.exist?(path)
-        ctx.debug(ctx.message('rails.gem.setting_gem_home', path))
-        ctx.setenv('GEM_HOME', path)
+        ctx.debug(ctx.message("rails.gem.setting_gem_home", path))
+        ctx.setenv("GEM_HOME", path)
       end
 
       def apply_gem_path(ctx)
-        path = ''
-        out, stat = ctx.capture2e('gem', 'environment', 'path')
-        path = out&.empty? ? '' : out.strip if stat.success?
+        path = ""
+        out, stat = ctx.capture2e("gem", "environment", "path")
+        path = out&.empty? ? "" : out.strip if stat.success?
         # usually GEM_PATH already contains GEM_HOME
         # if gem_home() falls back to our fallback path, we need to add it
         path = gem_home(ctx) + File::PATH_SEPARATOR + path unless path.include?(gem_home(ctx))
-        ctx.debug(ctx.message('rails.gem.setting_gem_path', path))
-        ctx.setenv('GEM_PATH', path)
+        ctx.debug(ctx.message("rails.gem.setting_gem_path", path))
+        ctx.setenv("GEM_PATH", path)
       end
 
       def fallback_gem_home_path(ctx)
-        File.join(ctx.getenv('HOME'), '.gem', 'ruby', RUBY_VERSION)
+        File.join(ctx.getenv("HOME"), ".gem", "ruby", RUBY_VERSION)
       end
     end
 
@@ -67,7 +67,7 @@ module Rails
       found = false
       paths = self.class.gem_path(ctx).split(File::PATH_SEPARATOR)
       paths.each do |path|
-        ctx.debug(ctx.message('rails.gem.checking_installation_path', "#{path}/gems/", name))
+        ctx.debug(ctx.message("rails.gem.checking_installation_path", "#{path}/gems/", name))
         found = !!Dir.glob("#{path}/gems/#{name}-*").detect do |f|
           gem_satisfies_version?(f)
         end
@@ -78,18 +78,18 @@ module Rails
 
     def install!
       spin = CLI::UI::SpinGroup.new
-      spin.add(ctx.message('rails.gem.installing', name)) do |spinner|
+      spin.add(ctx.message("rails.gem.installing", name)) do |spinner|
         args = %w(gem install)
         args.push(name)
         unless version.nil?
-          if ctx.windows? && version.include?('~')
-            args.push('-v', "\"#{version}\"")
+          if ctx.windows? && version.include?("~")
+            args.push("-v", "\"#{version}\"")
           else
-            args.push('-v', version)
+            args.push("-v", version)
           end
         end
         ctx.system(*args)
-        spinner.update_title(ctx.message('rails.gem.installed', name))
+        spinner.update_title(ctx.message("rails.gem.installed", name))
       end
       spin.wait
     end
@@ -98,8 +98,8 @@ module Rails
       if version
         # there was a specific version given during new(), so
         # check version of gem found to determine match
-        require 'semantic/semantic'
-        found_version, _ = path.match(%r{/#{Regexp.quote(name)}-([\d\.]+)})&.captures
+        require "semantic/semantic"
+        found_version, _ = path.match(%r{/#{Regexp.quote(name)}-(\d\.\d\.\d)})&.captures
         found_version.nil? ? false : Semantic::Version.new(found_version).satisfies?(version)
       else
         # otherwise ignore the actual version number,

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

@@ -17,22 +17,29 @@ 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.
             Usage: {{command:%s create rails}}
             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.
               {{command:--db=DB}} Database type. Must be one of: mysql, postgresql, sqlite3, oracle, frontbase, ibm_db, sqlserver, jdbcmysql, jdbcsqlite3, jdbcpostgresql, jdbc.
-              {{command:--rails_opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
+              {{command:--rails-opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
           HELP
 
           error: {
             invalid_ruby_version: <<~MSG,
-            This project requires a ruby version ~> 2.5.
+            This project requires a Ruby version ~> 2.5 or Ruby 3.0
             See {{underline:https://github.com/Shopify/shopify-app-cli/blob/master/docs/installing-ruby.md}}
             for our recommended method of installing ruby.
             MSG
@@ -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.}}",
           },
@@ -254,6 +257,7 @@ module Rails
         forms: {
           create: {
             error: {
+              invalid_app_name: "App name cannot contain 'Shopify'",
               invalid_app_type: "Invalid app type %s",
               invalid_db_type: "Invalid database type %s",
             },

data/lib/project_types/rails/ruby.rb

@@ -8,8 +8,8 @@ module Rails
 
     class << self
       def version(ctx)
-        require 'semantic/semantic'
-        out, _ = ctx.capture2('ruby', '-v')
+        require "semantic/semantic"
+        out, _ = ctx.capture2("ruby", "-v")
         Semantic::Version.new(VERSION_STRING.match(out)[1])
       end
     end

data/lib/project_types/script/cli.rb

@@ -3,73 +3,79 @@
 module Script
   class Project < ShopifyCli::ProjectType
     hidden_feature(feature_set: :script_project)
-    creator 'Script', 'Script::Commands::Create'
+    title("Script")
+    creator("Script::Commands::Create")
 
-    register_command('Script::Commands::Push', 'push')
-    register_command('Script::Commands::Disable', 'disable')
-    register_command('Script::Commands::Enable', 'enable')
+    register_command("Script::Commands::Push", "push")
+    register_command("Script::Commands::Disable", "disable")
+    register_command("Script::Commands::Enable", "enable")
 
-    require Project.project_filepath('messages/messages')
+    require Project.project_filepath("messages/messages")
     register_messages(Script::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
   module Commands
-    autoload :Create, Project.project_filepath('commands/create')
-    autoload :Push, Project.project_filepath('commands/push')
-    autoload :Disable, Project.project_filepath('commands/disable')
-    autoload :Enable, Project.project_filepath('commands/enable')
+    autoload :Create, Project.project_filepath("commands/create")
+    autoload :Push, Project.project_filepath("commands/push")
+    autoload :Disable, Project.project_filepath("commands/disable")
+    autoload :Enable, Project.project_filepath("commands/enable")
   end
 
   # define/autoload project specific Forms
   module Forms
-    autoload :Create, Project.project_filepath('forms/create')
-    autoload :ScriptForm, Project.project_filepath('forms/script_form')
+    autoload :Create, Project.project_filepath("forms/create")
+    autoload :ScriptForm, Project.project_filepath("forms/script_form")
   end
 
   module Layers
     module Application
-      autoload :BuildScript, Project.project_filepath('layers/application/build_script')
-      autoload :CreateScript, Project.project_filepath('layers/application/create_script')
-      autoload :PushScript, Project.project_filepath('layers/application/push_script')
-      autoload :DisableScript, Project.project_filepath('layers/application/disable_script')
-      autoload :EnableScript, Project.project_filepath('layers/application/enable_script')
-      autoload :ExtensionPoints, Project.project_filepath('layers/application/extension_points')
-      autoload :ProjectDependencies, Project.project_filepath('layers/application/project_dependencies')
+      autoload :BuildScript, Project.project_filepath("layers/application/build_script")
+      autoload :CreateScript, Project.project_filepath("layers/application/create_script")
+      autoload :PushScript, Project.project_filepath("layers/application/push_script")
+      autoload :DisableScript, Project.project_filepath("layers/application/disable_script")
+      autoload :EnableScript, Project.project_filepath("layers/application/enable_script")
+      autoload :ExtensionPoints, Project.project_filepath("layers/application/extension_points")
+      autoload :ProjectDependencies, Project.project_filepath("layers/application/project_dependencies")
     end
 
     module Domain
-      autoload :Errors, Project.project_filepath('layers/domain/errors')
-      autoload :PushPackage, Project.project_filepath('layers/domain/push_package')
-      autoload :ExtensionPoint, Project.project_filepath('layers/domain/extension_point')
-      autoload :Script, Project.project_filepath('layers/domain/script')
+      autoload :Errors, Project.project_filepath("layers/domain/errors")
+      autoload :ConfigUi, Project.project_filepath("layers/domain/config_ui")
+      autoload :PushPackage, Project.project_filepath("layers/domain/push_package")
+      autoload :Metadata, Project.project_filepath("layers/domain/metadata")
+      autoload :ExtensionPoint, Project.project_filepath("layers/domain/extension_point")
     end
 
     module Infrastructure
-      autoload :Errors, Project.project_filepath('layers/infrastructure/errors')
+      autoload :Errors, Project.project_filepath("layers/infrastructure/errors")
       autoload :AssemblyScriptDependencyManager,
-               Project.project_filepath('layers/infrastructure/assemblyscript_dependency_manager')
+        Project.project_filepath("layers/infrastructure/assemblyscript_dependency_manager")
       autoload :AssemblyScriptProjectCreator,
-               Project.project_filepath('layers/infrastructure/assemblyscript_project_creator')
-      autoload :AssemblyScriptTaskRunner, Project.project_filepath('layers/infrastructure/assemblyscript_task_runner')
-      autoload :AssemblyScriptTsConfig, Project.project_filepath('layers/infrastructure/assemblyscript_tsconfig')
-      autoload :PushPackageRepository, Project.project_filepath('layers/infrastructure/push_package_repository')
-      autoload :ExtensionPointRepository, Project.project_filepath('layers/infrastructure/extension_point_repository')
-      autoload :ProjectCreator, Project.project_filepath('layers/infrastructure/project_creator')
-      autoload :ScriptRepository, Project.project_filepath('layers/infrastructure/script_repository')
-      autoload :ScriptService, Project.project_filepath('layers/infrastructure/script_service')
-      autoload :TaskRunner, Project.project_filepath('layers/infrastructure/task_runner')
+        Project.project_filepath("layers/infrastructure/assemblyscript_project_creator")
+      autoload :AssemblyScriptTaskRunner, Project.project_filepath("layers/infrastructure/assemblyscript_task_runner")
+      autoload :AssemblyScriptTsConfig, Project.project_filepath("layers/infrastructure/assemblyscript_tsconfig")
+      autoload :RustProjectCreator,
+        Project.project_filepath("layers/infrastructure/rust_project_creator.rb")
+      autoload :RustTaskRunner, Project.project_filepath("layers/infrastructure/rust_task_runner")
+
+      autoload :ConfigUiRepository, Project.project_filepath("layers/infrastructure/config_ui_repository")
+      autoload :PushPackageRepository, Project.project_filepath("layers/infrastructure/push_package_repository")
+      autoload :ExtensionPointRepository, Project.project_filepath("layers/infrastructure/extension_point_repository")
+      autoload :ProjectCreator, Project.project_filepath("layers/infrastructure/project_creator")
+      autoload :ScriptService, Project.project_filepath("layers/infrastructure/script_service")
+      autoload :TaskRunner, Project.project_filepath("layers/infrastructure/task_runner")
     end
   end
 
   module UI
-    autoload :ErrorHandler, Project.project_filepath('ui/error_handler')
-    autoload :PrintingSpinner, Project.project_filepath('ui/printing_spinner')
-    autoload :StrictSpinner, Project.project_filepath('ui/strict_spinner')
+    autoload :ErrorHandler, Project.project_filepath("ui/error_handler")
+    autoload :PrintingSpinner, Project.project_filepath("ui/printing_spinner")
+    autoload :StrictSpinner, Project.project_filepath("ui/strict_spinner")
   end
 
-  autoload :ScriptProject, Project.project_filepath('script_project')
-  autoload :Errors, Project.project_filepath('errors')
+  autoload :ScriptProject, Project.project_filepath("script_project")
+  autoload :Errors, Project.project_filepath("errors")
 
   class ScriptProjectError < StandardError; end
 end

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

@@ -4,38 +4,43 @@ module Script
   module Commands
     class Create < ShopifyCli::SubCommand
       options do |parser, flags|
-        parser.on('--name=NAME') { |name| flags[:name] = name }
-        parser.on('--extension_point=EP_NAME') { |ep_name| flags[:extension_point] = ep_name }
+        parser.on("--name=NAME") { |name| flags[:name] = name }
+        parser.on("--description=DESCRIPTION") { |description| flags[:description] = description }
+        parser.on("--extension_point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
+        parser.on("--extension-point=EP_NAME") { |ep_name| flags[:extension_point] = ep_name }
+        parser.on("--language=LANGUAGE") { |language| flags[:language] = language }
+        parser.on("--no-config-ui") { |no_config_ui| flags[:no_config_ui] = no_config_ui }
       end
 
       def call(args, _name)
-        language = 'ts'
         cur_dir = @ctx.root
 
         form = Forms::Create.ask(@ctx, args, options.flags)
         return @ctx.puts(self.class.help) if form.nil?
 
-        unless !form.name.empty? && form.extension_point && ScriptProject::SUPPORTED_LANGUAGES.include?(language)
+        unless !form.name.empty? && form.extension_point && form.language
           return @ctx.puts(self.class.help)
         end
 
         project = Layers::Application::CreateScript.call(
           ctx: @ctx,
-          language: language,
+          language: form.language,
           script_name: form.name,
-          extension_point_type: form.extension_point
+          extension_point_type: form.extension_point,
+          description: form.description,
+          no_config_ui: options.flags.key?(:no_config_ui)
         )
-        @ctx.puts(@ctx.message('script.create.change_directory_notice', project.script_name))
+        @ctx.puts(@ctx.message("script.create.change_directory_notice", project.script_name))
       rescue Script::Errors::ScriptProjectAlreadyExistsError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.create.error.operation_failed"))
       rescue StandardError => e
         ScriptProject.cleanup(ctx: @ctx, script_name: form.name, root_dir: cur_dir) if form
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.create.error.operation_failed'))
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.create.error.operation_failed"))
       end
 
       def self.help
         allowed_values = Script::Layers::Application::ExtensionPoints.types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCli::Context.message('script.create.help', ShopifyCli::TOOL_NAME, allowed_values.join(', '))
+        ShopifyCli::Context.message("script.create.help", ShopifyCli::TOOL_NAME, allowed_values.join(", "))
       end
     end
   end