shopify-cli 1.14.0 → 2.0.0

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

@@ -3,10 +3,12 @@
 require "shopify_cli"
 
 module Rails
-  module Commands
-    class Tunnel < ShopifyCli::Command
+  class Command
+    class Tunnel < ShopifyCli::SubCommand
       # subcommands :auth, :start, :stop
 
+      prerequisite_task ensure_project_type: :rails
+
       def call(args, _name)
         subcommand = args.shift
         case subcommand

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

@@ -4,6 +4,11 @@ module Rails
   module Messages
     MESSAGES = {
       rails: {
+        help: <<~HELP,
+          Suite of commands for developing Ruby on Rails apps. See {{command:%1$s rails <command> --help}} for usage of each command.
+            Usage: {{command:%1$s rails [ %2$s ]}}
+        HELP
+
         error: {
           generic: "Error",
         },
@@ -19,30 +24,29 @@ module Rails
 
         connect: {
           connected: "Project now connected to {{green:%s}}",
+          help: <<~HELP,
+            {{command:%s rails connect}}: Connects an existing Ruby on Rails app to Shopify CLI. Creates a config file.
+              Usage: {{command:%s rails connect}}
+          HELP
           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.
+            {{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:--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:%s rails create}}: Creates a ruby on rails app.
+              Usage: {{command:%s rails create}}
+              Options:
+                {{command:--name=NAME}} App name. Any string.
+                {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+                {{command:--store=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.
           HELP
 
           error: {
-            invalid_ruby_version: <<~MSG,
-            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
+            invalid_ruby_version: "This project requires a Ruby version ~> 2.5 or Ruby 3.0.",
             dir_exists: "Project directory %s already exists. Please use a different name.",
             install_failure: "Error installing %s gem",
             node_required: "node is required to create a rails project. Download at https://nodejs.org/en/download.",
@@ -71,19 +75,19 @@ module Rails
 
         deploy: {
           help: <<~HELP,
-          Deploy the current Rails project to a hosting service. Heroku ({{underline:https://www.heroku.com}}) is currently the only option, but more will be added in the future.
-            Usage: {{command:%s deploy [ heroku ]}}
+            Deploy the current Rails project to a hosting service. Heroku ({{underline:https://www.heroku.com}}) is currently the only option, but more will be added in the future.
+              Usage: {{command:%s rails deploy [ heroku ]}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Subcommands:}}
-            {{cyan:heroku}}: Deploys the current Rails project to Heroku.
-              Usage: {{command:%s deploy heroku}}
+            {{bold:Subcommands:}}
+              {{cyan:heroku}}: Deploys the current Rails project to Heroku.
+                Usage: {{command:%s rails deploy heroku}}
           HELP
 
           heroku: {
             help: <<~HELP,
-            Deploy the current Rails project to Heroku
-            Usage: {{command:%s deploy heroku}}
+              Deploy the current Rails project to Heroku
+              Usage: {{command:%s rails deploy heroku}}
             HELP
             downloading: "Downloading Heroku CLI...",
             downloaded: "Downloaded Heroku CLI",
@@ -100,9 +104,9 @@ module Rails
               validated: "Database type \"%s\" validated for platform \"Heroku\"",
               problem: "A problem was encountered while checking your database type.",
               sqlite: <<~SQLITE,
-              Heroku does not support deployment using the SQLite database system.
-              Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
-              {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+                Heroku does not support deployment using the SQLite database system.
+                Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+                {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
               SQLITE
             },
             git: {
@@ -126,13 +130,13 @@ module Rails
 
         generate: {
           help: <<~HELP,
-          Generate code in your Rails project. Currently supports generating new webhooks.
-            Usage: {{command:%s generate [ webhook ]}}
+            Generate code in your Rails project. Currently supports generating new webhooks.
+              Usage: {{command:%s rails generate [ 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.
+            {{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: {
@@ -142,8 +146,8 @@ module Rails
 
           webhook: {
             help: <<~HELP,
-            Generate and register a new webhook that listens for the specified Shopify store event.
-              Usage: {{command:%s generate webhook <type>}}
+              Generate and register a new webhook that listens for the specified Shopify store event.
+                Usage: {{command:%s rails generate webhook <type>}}
             HELP
 
             select: "What type of webhook would you like to create?",
@@ -153,70 +157,19 @@ module Rails
 
         open: {
           help: <<~HELP,
-          Open your local development app in the default browser.
-            Usage: {{command:%s open}}
-          HELP
-        },
-
-        populate: {
-          help: <<~HELP,
-          Populate your Shopify development store with example customers, orders, or products.
-            Usage: {{command:%s populate [ customers | draftorders | products ]}}
+            Open your local development app in the default browser.
+              Usage: {{command:%s rails open}}
           HELP
-          extended_help: <<~HELP,
-          {{bold:Subcommands:}}
-
-            {{cyan:customers [options]}}: Add dummy customers to the specified development store.
-              Usage: {{command:%1$s populate customers}}
-
-            {{cyan:draftorders [options]}}: Add dummy orders to the specified development store.
-              Usage: {{command:%1$s populate draftorders}}
-
-            {{cyan:products [options]}}: Add dummy products to the specified development store.
-              Usage: {{command:%1$s populate products}}
-
-          {{bold:Options:}}
-
-            {{cyan:--count [integer]}}: The number of dummy items to populate. Defaults to 5.
-            {{cyan:--silent}}: Silence the populate output.
-            {{cyan:--help}}: Display more options specific to each subcommand.
-
-          {{bold:Examples:}}
-
-            {{command:%1$s populate products}}
-              Populate your development store with 5 additional products.
-
-            {{command:%1$s populate customers --count 30}}
-              Populate your development store with 30 additional customers.
-
-            {{command:%1$s populate draftorders}}
-              Populate your development store with 5 additional orders.
-
-            {{command:%1$s populate products --help}}
-              Display the list of options available to customize the {{command:%1$s populate products}} command.
-          HELP
-
-          customer: {
-            added: "%s added to {{green:%s}} at {{underline:%scustomers/%d}}",
-          },
-
-          draft_order: {
-            added: "DraftOrder added to {{green:%s}} at {{underline:%sdraft_orders/%d}}",
-          },
-
-          product: {
-            added: "%s added to {{green:%s}} at {{underline:%sproducts/%d}}",
-          },
         },
 
         serve: {
           help: <<~HELP,
-          Start a local development rails server for your project, as well as a public ngrok tunnel to your localhost.
-            Usage: {{command:%s serve}}
+            Start a local development rails server for your project, as well as a public ngrok tunnel to your localhost.
+              Usage: {{command:%s rails serve}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Options:}}
-            {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+            {{bold:Options:}}
+              {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
           HELP
 
           error: {
@@ -232,20 +185,20 @@ module Rails
 
         tunnel: {
           help: <<~HELP,
-          Start or stop an http tunnel to your local development app using ngrok.
-            Usage: {{command:%s tunnel [ auth | start | stop ]}}
+            Start or stop an http tunnel to your local development app using ngrok.
+              Usage: {{command:%s rails tunnel [ auth | start | stop ]}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Subcommands:}}
+            {{bold:Subcommands:}}
 
-            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
-              Usage: {{command:%1$s tunnel auth <token>}}
+              {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
+                Usage: {{command:%1$s rails tunnel auth <token>}}
 
-            {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
-              Usage: {{command:%1$s tunnel start}}
+              {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
+                Usage: {{command:%1$s rails tunnel start}}
 
-            {{cyan:stop}}: Stops the ngrok tunnel.
-              Usage: {{command:%1$s tunnel stop}}
+              {{cyan:stop}}: Stops the ngrok tunnel.
+                Usage: {{command:%1$s rails tunnel stop}}
 
           HELP
 
@@ -270,9 +223,9 @@ module Rails
             },
             db: {
               want_select: <<~WANT_SELECT,
-              Would you like to select what database type to use now? (SQLite is the default)
-              If you want to change this in the future, run {{command:rails db:system:change --to=[new_db_type]}}. For more info:
-              {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+                Would you like to select what database type to use now? (SQLite is the default)
+                If you want to change this in the future, run {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+                {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
               WANT_SELECT
               select: "What database type would you like to use? Please ensure the database is installed.",
               select_sqlite3: "SQLite (default)",

data/lib/project_types/script/cli.rb

@@ -3,20 +3,18 @@
 module Script
   class Project < ShopifyCli::ProjectType
     hidden_feature(feature_set: :script_project)
-    title("Script")
-    creator("Script::Commands::Create")
-
-    register_command("Script::Commands::Push", "push")
 
     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")
+  class Command < ShopifyCli::ProjectCommands
+    hidden_feature(feature_set: :script_project)
+    subcommand :Create, "create", Project.project_filepath("commands/create")
+    subcommand :Push, "push", Project.project_filepath("commands/push")
   end
+  ShopifyCli::Commands.register("Script::Command", "script")
 
   # define/autoload project specific Forms
   module Forms

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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Script
-  module Commands
+  class Command
     class Create < ShopifyCli::SubCommand
+      prerequisite_task :ensure_authenticated
+
       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 }

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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Script
-  module Commands
-    class Push < ShopifyCli::Command
+  class Command
+    class Push < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :script
+
       options do |parser, flags|
         parser.on("--force") { |t| flags[:force] = t }
       end

data/lib/project_types/script/messages/messages.rb

@@ -4,22 +4,28 @@ module Script
   module Messages
     MESSAGES = {
       script: {
+        help: <<~HELP,
+          Suite of commands for developing script applications. See {{command:%1$s script <command> --help}} for usage of each command.
+            Usage: {{command:%1$s script [ %2$s ]}}
+        HELP
+
         error: {
-          deprecated_ep: "This project uses an extension point %s which has been deprecated. "\
-                         "This Script will no longer function in production.",
-          deprecated_ep_cause: "Try using a different extension point.",
+          deprecated_ep: "This project uses a Script API (%s) that has been deprecated. "\
+                         "This Script won't work in production.",
+          deprecated_ep_cause: "Try using a different Script API.",
           generic: "{{red:{{x}} Error}}",
           eacces_cause: "You don't have permission to write to this directory.",
-          eacces_help: "Change your directory permissions and try again.",
+          eacces_help: "Try again and choose a different directory.",
 
-          enospc_cause: "You don't have enough disk space to perform this action.",
+          enospc_cause: "You don't have enough disk space to do this action.",
           enospc_help: "Free up some space and try again.",
 
           oauth_cause: "Something went wrong while authenticating your account with the Partner Dashboard.",
           oauth_help: "Try again.",
 
-          invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
-          invalid_context_help: "See https://help.shopify.com",
+          invalid_context_cause: "Your .shopify-cli.yml file is not correct. Values are missing for "\
+                                 "extension_point_type or script_name.",
+          invalid_context_help: "Add these values and try again.",
 
           invalid_config_props_cause: "{{command:--config-props}} is formatted incorrectly.",
           invalid_config_props_help: "Try again using this format: "\
@@ -29,27 +35,27 @@ module Script
           invalid_script_name_help: "Replace or remove unsupported characters. Valid characters "\
                                     "are numbers, letters, hyphens, or underscores.",
 
-          no_existing_apps_cause: "You don't have any apps.",
-          no_existing_apps_help: "Create an app with {{command:shopify create}} or "\
-                                 "visit https://partners.shopify.com/.",
+          no_existing_apps_cause: "You don't have any apps in your Partner Dashboard.",
+          no_existing_apps_help: "Create an app with {{command:shopify [node|rails] create}}" \
+                                 " or visit https://partners.shopify.com/.",
 
           no_existing_orgs_cause: "You don't have any partner organizations.",
           no_existing_orgs_help: "Visit https://partners.shopify.com/ to create a partners account.",
 
-          no_existing_stores_cause: "You don't have any stores.",
+          no_existing_stores_cause: "You don't have any stores in your Partner Dashboard.",
           no_existing_stores_help: "Visit https://partners.shopify.com/%{organization_id}/stores/ to create one.",
 
-          project_exists_cause: "Directory with the same name as the script already exists.",
-          project_exists_help: "Use different script name and try again.",
+          project_exists_cause: "A directory with this same name already exists.",
+          project_exists_help: "Try again and enter a different name for the script.",
 
-          invalid_extension_cause: "Invalid extension point %s.",
+          invalid_extension_cause: "Invalid Script API %s.",
           invalid_extension_help: "Allowed values: %s.",
 
           invalid_language_cause: "Invalid language %s.",
           invalid_language_help: "Allowed values: %s.",
 
           invalid_config: "Can't change the configuration values because %1$s is missing or "\
-                          "it is not formatted properly.",
+                          "it isn't formatted properly.",
 
           missing_script_json_field_cause: "The script.json file is missing the required %s field.",
           missing_script_json_field_help: "Add the field and try again.",
@@ -57,43 +63,44 @@ module Script
           invalid_script_json_definition_cause: "The script.json file contains invalid JSON.",
           invalid_script_json_definition_help: "Fix the errors and try again.",
 
-          no_script_json_file_cause: "You are missing the required script.json file.",
+          no_script_json_file_cause: "The script.json file is missing.",
           no_script_json_file_help: "Create this file and try again.",
 
-          configuration_syntax_error_cause: "The script.json configuration schema is not formatted properly.",
+          configuration_syntax_error_cause: "The script.json is not formatted properly.",
           configuration_syntax_error_help: "Fix the errors and try again.",
 
-          configuration_missing_keys_error_cause: "The script.json configuration schema is missing required keys: "\
+          configuration_missing_keys_error_cause: "The script.json file is missing required keys: "\
                                               "%{missing_keys}.",
           configuration_missing_keys_error_help: "Add the keys and try again.",
 
           configuration_invalid_value_error_cause: "The script.json configuration only accepts "\
-                                              "one of the following types(s): %{valid_input_modes}.",
+                                                   "one of the following types(s): %{valid_input_modes}.",
           configuration_invalid_value_error_help: "Change the type and try again.",
 
-          configuration_schema_field_missing_keys_error_cause: "A field entry in the script.json configuration "\
-                                                     "schema is missing required keys: %{missing_keys}.",
+          configuration_schema_field_missing_keys_error_cause: "A configuration entry in the script.json file "\
+                                                     "is missing required keys: %{missing_keys}.",
           configuration_definition_schema_field_missing_keys_error_help: "Add the keys and try again.",
 
-          configuration_schema_field_invalid_value_error_cause: "The script.json configuration schema fields only "\
-                                                     "accept one of the following type(s): %{valid_types}.",
+          configuration_schema_field_invalid_value_error_cause: "The configuration entries in the "\
+                                                     "script.json file only accept one of the following "\
+                                                     "type(s): %{valid_types}.",
           configuration_schema_field_invalid_value_error_help: "Change the types and try again.",
 
-          script_not_found_cause: "Couldn't find script %s for extension point %s",
+          script_not_found_cause: "Couldn't find a script %s for the Script API %s",
 
           system_call_failure_cause: "An error was returned while running {{command:%{cmd}}}.",
           system_call_failure_help: "Review the following error and try again.\n{{red:%{out}}}",
 
-          metadata_validation_cause: "Invalid script extension metadata.",
+          metadata_validation_cause: "Invalid Script API metadata.",
           metadata_validation_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
-          metadata_schema_versions_missing: "Invalid script metadata:" \
+          metadata_schema_versions_missing: "Invalid Script metadata:" \
                                             " 'schemaVersions' field is missing",
-          metadata_schema_versions_single_key: "Invalid script extension metadata:" \
-                                               " 'schemaVersions' can have only one extension point name.",
-          metadata_schema_versions_missing_major: "Invalid script extension metadata:" \
+          metadata_schema_versions_single_key: "Invalid Script API metadata:" \
+                                               " 'schemaVersions' can have only one Script API name.",
+          metadata_schema_versions_missing_major: "Invalid Script API metadata:" \
                                                   " 'schemaVersions' is missing the 'major' field",
-          metadata_schema_versions_missing_minor: "Invalid script extension metadata:" \
+          metadata_schema_versions_missing_minor: "Invalid Script API metadata:" \
                                                   " 'schemaVersions' is missing the 'minor' field",
 
           metadata_not_found_cause: "Script version file (%s) cannot be found.",
@@ -105,7 +112,7 @@ module Script
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
 
-          dependency_install_cause: "Something went wrong while installing the dependencies that are needed.",
+          dependency_install_cause: "Something went wrong while installing the needed dependencies.",
           dependency_install_help: "Correct the errors and try again.",
 
           failed_api_request_cause: "Something went wrong while communicating with Shopify.",
@@ -116,7 +123,7 @@ module Script
           graphql_error_cause: "An error was returned: %s.",
           graphql_error_help: "\nReview the error and try again.",
 
-          script_repush_cause: "A script with this UUID already exists (UUID: %s).",
+          script_repush_cause: "A version of this script already exists on the app.",
           script_repush_help: "Use {{cyan:--force}} to replace the existing script.",
 
           shop_auth_cause: "Unable to authenticate with the store.",
@@ -138,12 +145,12 @@ module Script
 
         create: {
           help: <<~HELP,
-          {{command:%1$s create script}}: Creates a script project.
-            Usage: {{command:%1$s create script}}
-            Options:
-              {{command:--name=NAME}} Script project name. Use any string.
-              {{command:--extension-point=TYPE}} Extension point name. Allowed values: %2$s.
-              {{command:--no-config-ui}} Specify this option if you don’t want Scripts to render an interface in the Shopify admin.
+            {{command:%1$s script create}}: Creates a script project.
+              Usage: {{command:%1$s script create}}
+              Options:
+                {{command:--name=NAME}} Script project name. Use any string.
+                {{command:--extension-point=TYPE}} Script API name. Allowed values: %2$s.
+                {{command:--no-config-ui}} Specify this option when you don’t want your script to render an interface in Shopify admin.
           HELP
 
           error: {
@@ -157,10 +164,10 @@ module Script
 
         push: {
           help: <<~HELP,
-          Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
-            Usage: {{command:%s push}}
-            Options:
-              {{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+            Build the script, upload it to Shopify, and register it to an app.  If you've already pushed the script to this app, then use --force to replace the existing version on the app.
+              Usage: {{command:%s script push}}
+              Options:
+                {{command:[--force]}} Replaces the existing script on the app with this version.
           HELP
 
           error: {
@@ -180,9 +187,9 @@ module Script
 
         forms: {
           create: {
-            select_extension_point: "Which extension point do you want to use?",
+            select_extension_point: "Which Script API do you want to use?",
             select_language: "Which language do you want to use?",
-            script_name: "Script Name",
+            script_name: "Script name",
           },
         },
 
@@ -202,7 +209,7 @@ module Script
             app: "Script will be pushed to app {{green:%s}}.",
             app_select: "Which app do you want to push this script to?",
             ask_connect_to_existing_script: "The selected app has some scripts. Do you want to replace any of the "\
-              "existing scripts with the current script?",
+              "existing scripts on the app with this script?",
             ask_which_script_to_connect_to: "Which script do you want to replace?",
           },
         },