Module: Extension::Messages

Defined in:: lib/project_types/extension/messages/messages.rb,
lib/project_types/extension/messages/message_loading.rb

Defined Under Namespace

Constant Summary collapse

MESSAGES =

{
  extension: {
    help: <<~HELP,
  },
  create: {
    help: <<~HELP,
    ask_name: "Extension name",
    invalid_name: "Extension name must be under %s characters",
    ask_type: "What type of extension are you creating?",
    invalid_type: "Extension type is invalid.",
    setup_project_frame_title: "Initializing project",
    ready_to_start: <<~MESSAGE,
    learn_more: <<~MESSAGE,
    try_again: "{{*}} Fix the errors and run {{command:shopify extension create}} again.",
    errors: {
      directory_exists: "Directory ‘%s’ already exists. Please remove it or choose a new name for your project.",
    },
    incomplete_configuration: "Cannot create extension due to missing configuration information",
    invalid_api_key: "The API key %s does not match any of your apps.",
    ask_app: "Which app would you like to register this extension with?",
    no_apps: "{{x}} You don’t have any apps.",
    learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/apps>, " \
      "or try creating a new app using {{command:shopify [node|rails] create}}.",
    loading_apps: "Loading your apps…",
    no_available_extensions: "{{x}} There are no available extensions for this app.",
    ask_template: "Select a template to use for your extension",
  },
  connect: {
    connected: "Project now connected to {{green:%s: %s}}",
    incomplete_configuration: "Cannot connect extension due to missing configuration information",
    invalid_api_key: "The API key %s does not match any of your apps.",
    ask_registration: "Which extension would you like to connect to?",
    loading_extensions: "Loading your extensions…",
    no_extensions: "{{x}} You don't have any extensions of type %s",
    learn_about_extensions: "{{*}} Learn more about building extensions at <https://shopify.dev/concepts/apps>, " \
      "or try creating a new extension using {{command:shopify extension create}}.",
    help: <<~HELP,
  },
  build: {
    help: <<~HELP,
    frame_title: "Building extension with: %s…",
    build_failure_message: "Failed to build extension code.",
  },
  register: {
    help: <<~HELP,
    frame_title: "Registering Extension",
    waiting_text: "Registering with Shopify…",
    already_registered: "Extension is already registered.",
    confirm_info: "This will create a new extension registration for %s, which can’t be undone.",
    confirm_question: "Would you like to register this extension? (y/n)",
    confirm_abort: "Extension was not registered.",
    success: "{{v}} Registered {{green:%s}}.",
    success_info: "{{*}} Run {{command:shopify extension push}} to push your extension to Shopify.",
  },
  push: {
    help: <<~HELP,
    frame_title: "Pushing your extension to Shopify",
    waiting_text: "Pushing code to Shopify…",
    pushed_with_errors: "{{x}} Code pushed to Shopify with errors on %s.",
    push_with_errors_info: "{{*}} Fix these errors and run {{command:shopify extension push}} to " \
      "revalidate your extension.",
    success_confirmation: "{{v}} Pushed {{green:%s}} to a draft on %s.",
    success_info: "{{*}} Visit %s to version and publish your extension.",
  },
  serve: {
    help: <<~HELP,
    frame_title: "Viewing extension…",
    no_available_ports_found: "No available ports found to run extension.",
    serve_failure_message: "Failed to run extension code.",
    serve_missing_information: "Missing shop or api_key.",
    tunnel_already_running: "A tunnel running on another port has been detected. Close the tunnel and try again.",
    preview_message: <<~PREVIEW_MESSAGE,
  },
  tunnel: {
    duplicate_session: <<~MESSAGE,
    invalid_token: <<~MESSAGE,
    missing_token: "{{x}} {{red:auth requires a token argument}}. "\
      "Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.",
    invalid_port: "%s is not a valid port.",
    no_tunnel_running: "No tunnel running.",
    tunnel_running_at: "Tunnel running at: {{underline:%s}}",
    help: <<~HELP,
    extended_help: <<~HELP,
  },
  check: {
    help: "Check your extension for errors, suggestions, and best practices.",
    unsupported: "{{red:%s projects are not supported for `extension check`}}",
  },
  features: {
    argo: {
      missing_file_error: "Could not find built extension file.",
      script_prepare_error: "An error occurred while attempting to prepare your script.",
      initialization_error: "{{x}} There was an error while initializing the project.",
      dependencies: {
        node: {
          node_not_installed: "Node must be installed to create this extension.",
          version_too_low: "Your node version %s does not meet the minimum required version %s",
        },
        argo_missing_renderer_package_error: "Extension template references invalid renderer package "\
          "please contact Shopify for help.",
        yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
        yarn_run_script_error: "Something went wrong while running script. %s.",
      },
      config: {
        unpermitted_keys: "`%s` contains the following unpermitted keys: %s",
      },
    },
  },
  tasks: {
    errors: {
      parse_error: "Unable to parse response from Partners Dashboard.",
      store_error: "There was an error getting store data. Try again later.",
    },
  },
  errors: {
    unknown_type: "Unknown extension type %s. Valid extension types include: CHECKOUT_POST_PURCHASE, " \
    "THEME_APP_EXTENSION, and PRODUCT_SUBSCRIPTION.",
    package_not_found: "`%s` package not found.",
    missing_push_options_ci: "The following are missing: %s. ",
    missing_push_options_ci_solution: "To add them to a CI environment:\n\t1. Run a connect command " \
    "({{command:%1$s extension connect}})\n\t2. Navigate to the .env file at the root of your project\n\t" \
        "3. Copy the missing values and pass them through as arguments in {{command:%1$s extension push}}",
    missing_env_file_variables: "The following are missing in the .env file: %s. ",
    missing_env_file_variables_solution: "To add it, connect your extension with " \
    "{{command:%1$s extension connect}} " \
    "or run {{command:%1$s extension register}} to register a new extension.",
    module_not_found: "Unable to find module %s. Ensure your dependencies are up-to-date and try again.",
    development_server_binary_not_found: {
      title: "Development Server Binary Missing",
      message: <<~ERROR,
    },
    outdated_extensions: {
      unknown: <<~TEXT.strip,
      checkout_ui_extension: <<~TEXT.strip,
      product_subscription: <<~TEXT.strip,
      checkout_post_purchase: <<~TEXT.strip,
    },
  },
  warnings: {
    resource_url_auto_generation_failed: "{{*}} {{yellow:Warning:}} Unable to auto generate " \
    "the extension resource URL because %s does not have any products. " \
    "Please run {{bold:shopify populate products}} to generate sample products.",
  },
}

TYPES =

{
  product_subscription: {
    name: "Product Subscription",
    tagline: "(limit 1 per app)",
    overrides: {
      register: {
        confirm_info: "You can only create one %s extension per app, which can’t be undone.",
      },
    },
  },
  checkout_post_purchase: {
    name: "Checkout Post Purchase",
  },
  theme_app_extension: {
    name: "Theme App Extension",
    tagline: "(limit 1 per app)",
    overrides: {
      register: {
        confirm_info: "You can only create one %s extension per app, which can’t be undone.",
      },
      create: {
        ready_to_start: <<~MESSAGE,
      },

    },
  },
}