docs

@scayle/storefront-cli

0.15.0

Minor Changes

  • Added new Storefront CLI command: setup cms
    The new setup cms command streamlines the configuration of CMS providers for SCAYLE Storefront Application projects. It automates the setup process for both Contentful and Storyblok, ensuring quick and efficient integration with minimal manual configuration.

    Required Flags


    The following flags are required for all providers:
    • --provider (-p): The CMS provider to use (contentful or storyblok)
    • --space-id (-s): The space ID of the CMS space to use

    Contentful-specific required flags:

    • --access-token: The access token for the CMS
    • --preview-token: Preview token for Contentful preview API access
    • --management-token: Management token for Contentful management API access

    The access and preview access token for Contentful can be found in your space's settings page, while the personal access token is located in your account settings. For further information, refer to the official Contentful documentation.

    Storyblok-specific required flags:

    • --access-token: The access token for the CMS
    • --personal-access-token: Personal access token for Storyblok management API

    The access token for Storyblok can be found on your space's settings page, while the personal access token is located in your account settings. For further information, refer to the official Storyblok documentation.

    Optional flag:

    • --import-content-model (-i): Import the content model into the CMS

    Key features include:
    • Support for both Contentful and Storyblok CMS providers
    • Automatic generation of environment variables with CMS-specific tokens and configuration
    • Automatic updates to nuxt.config.ts with the selected CMS provider configuration
    • Optional content model import feature allows you to populate CMS spaces with predefined content structures. Use this option only with empty CMS spaces, as it may overwrite any existing content models.
  • Updated to fetch available features automatically from the live repository. This ensures that the list of features is always up-to-date even when using an older CLI version.

Patch Changes

0.14.0

Minor Changes

  • Updated the git-rev flag in the deploy command to be git-ref. This name more accurately reflects its usage as it requires a ref rather than a revision. The previous name is deprecated as a result of this change, but is still usable.

Patch Changes

0.13.4

Patch Changes

0.13.3

Patch Changes

0.13.2

Patch Changes

0.13.1

Patch Changes

0.13.0

Minor Changes

  • Introduced the features command.
    sfcli features list can be used to list the available Storefront features for installation.
    sfcli features add can be used to install a feature into your Storefront Application project. This command is equivalent to and replaces the previous sfcli add command.

Patch Changes

0.12.2

Patch Changes

  • Fixed incorrect file paths in the search and product-details feature packages.

0.12.1

Patch Changes

0.12.0

Minor Changes

  • Updated new/changed components for the @scayle/storefront-promotions package.

0.11.1

Patch Changes

0.11.0

Minor Changes

  • Added support for @scayle/storefront-basket in the add command, enabling the copying of components and composables from the latest Storefront Application into the current project.

0.10.6

Patch Changes

0.10.5

Patch Changes

0.10.4

Patch Changes

0.10.3

Patch Changes

0.10.2

Patch Changes

0.10.1

Patch Changes

0.10.0

Minor Changes

  • Fixed an issue where the deploy command would get stuck in an infinite loop when there were no new log lines to fetch. Now, when there are no new logs, fetching logs will be stopped until the next update cycle.

Patch Changes

0.9.16

Patch Changes

0.9.14

Patch Changes

0.9.13

Patch Changes

0.9.12

Patch Changes

  • Added dependency [email protected]
  • Fix issue with missing @nuxt/cli dependency and switch back to nuxi.

0.9.11

Patch Changes

  • Added support for the updated translation file format introduced in Storefront Application v1.10.0.

0.9.10

Patch Changes

0.9.9

Patch Changes

  • Fix creation of i18n translation files for current Storefront Application

0.9.8

Patch Changes

0.9.7

Patch Changes

0.9.6

Patch Changes

0.9.5

Patch Changes

0.9.4

Patch Changes

0.9.3

Patch Changes

  • Fixed the hostname of the SCAYLE Storefront Platform API

0.9.2

Patch Changes

0.9.1

Patch Changes

0.9.0

Minor Changes

  • [CLI] Update the setup command to generate configuration using the ICU Local Id's as translation file name.

0.8.3

Patch Changes

0.8.2

Patch Changes

0.8.1

Patch Changes

0.8.0

Minor Changes

  • Removed the unused SFPromotionHeadline component from the 'files to add' list of the @scayle/storefront-promotion SDK.

0.7.0

Minor Changes

  • Extended the list with of supported Storefront SDKs of the add command to include the new packages '@scayle/storefront-navigation', '@scayle/storefront-search' and '@scayle/storefront-promotions'.

0.6.2

Patch Changes

0.6.1

Patch Changes

0.6.0

Minor Changes

  • A new --only-env flag has been added to the setup command to generate only the .env file.
    Since the .env file is not included in version control, developers need to generate it manually when cloning a fresh copy of the repository. This flag simplifies that process.

Patch Changes

0.5.6

Patch Changes

0.5.5

Patch Changes

0.5.4

Patch Changes

  • Updated the generation of shop configuration environment variables. The shop-specific variables are now placed directly after the example variables to maintain context and ensure that the most important settings appear near the top.

0.5.3

Patch Changes

  • Updated dependency [email protected] to [email protected]
  • Resolved an issue where the .env file was being generated incorrectly, with unresolved dynamic environment variables still present. This caused certain commands in the Storefront Application to fail.

0.5.2

Patch Changes

0.5.1

Patch Changes

0.5.0

Minor Changes

  • Add new Storefront CLI command: deploy
    The new deploy command simplifies the deployment of a Storefront Application project to the SCAYLE PaaS. It automates the process, ensuring that your storefront is quickly and efficiently deployed with minimal manual intervention.

Patch Changes

0.4.5

Patch Changes

0.4.4

Patch Changes

0.4.3

Patch Changes

0.4.2

Patch Changes

0.4.1

Patch Changes

0.4.0

Minor Changes

  • Added a new should-override flag to the setup command. When set, it automatically replaces existing .env and shops.ts files without prompting for confirmation.
    Usage

0.3.0

Minor Changes

  • Rename Storefront CLI flags from camelCase to kebab-case to ensure consistency with standard naming conventions.

0.2.2

Patch Changes

0.2.1

Patch Changes

0.2.0

Minor Changes

  • Support saving and loading flags to a config file. This allows you to store global and tenant-specific configurations like accessToken and adminApiToken, eliminating the need to input these values every time a command is executed.
    To use a config file place the ./scayle/config.json file either in your home directory or in the current working directory where commands are run. The structure of this config file should be as follows:

    When no config file is found, the command will prompt you to save the flags used in the current command within the current directory. This can be disabled by using the --no-config-file flag or setting the SCAYLE_CLI_NO_CONFIG_FILE environment variable to a truthy value.

0.1.5

Patch Changes

0.1.4

Patch Changes

0.1.3

Patch Changes

  • Updated the locale code adjustment logic to only modify the code when multiple shops share the same initial countryCode.
    Example: Countries with de code and en-US locale will now result in en-de code. This will result in shops to be created with en-de as code and not with multiple de.

0.1.2

Patch Changes

0.1.1

Patch Changes

0.1.0

Minor Changes

  • Added new Storefront CLI command: setup
    The new setup command streamlines the initial setup of a new SCAYLE Storefront Application project. It automatically creates tenant- and country-specific files, including:
    • .env file filled with correct environment variables according to the tenant and countries.
    • shops.ts config file that already includes all configuration for all added country shops.
    • Translation files that will be created out of the existing en-GB.json i18n file.

Patch Changes

0.0.10

Patch Changes

0.0.9

Patch Changes

0.0.8

Patch Changes

  • Added dependency @oclif/[email protected]
  • Added dependency @oclif/[email protected]
  • Removed dependency @oclif/plugin-plugins@^5
  • Improved the developer experience by adding functionality to list all available commands and handle command typos more gracefully, providing better error messages.
  • Updated the README.md file with recommended usage instructions to improve clarity and help developers get started more easily.

0.0.7

Patch Changes

0.0.6

Patch Changes

0.0.5

Patch Changes

0.0.4

Patch Changes

0.0.3

Patch Changes

  • Fixed an issue where the @scayle/storefront-cli package was missing the featurePackages.json in the dist folder.
  • Add the nuxi dependency to the @scayle/storefront-cli package to enable version-independent and Nuxt-context-independent command execution using npx @scayle/storefront-cli.

0.0.2

Patch Changes

  • This release introduces the initial version of the SCAYLE Storefront CLI (@scayle/storefront-cli), a powerful tool designed to streamline feature adoption within SCAYLE Storefront tenant projects. This addresses the challenge of integrating new features and updates delivered through independent feature packages, particularly when tenant projects are based on older versions of the SCAYLE Storefront Application.
    Key Features include:
    • Simplified Feature Integration: The add command automates the process of adding new features, including necessary UI components and dependencies. This leverages nuxi module add for seamless integration within Nuxt projects.
    • Preservation of Tenant Customizations: Intelligent conflict resolution prompts users to manage potential overwrites of existing components & files, ensuring tenant-specific code modifications are preserved. Alternatively, the CLI can generate copies of new components, facilitating side-by-side comparison and controlled updates.
    • Incremental Feature Adoption: Tenants can now adopt new features without requiring a full Storefront Application upgrade, reducing disruption and development overhead.
    • Efficient Component Delivery: While feature packages primarily contain composables and utilities, the CLI efficiently delivers associated components and tests by fetching those from the latest available SCAYLE Storefront Application release and extracting them during feature installation. This streamlines the integration process and minimizes manual file management.
Next up
@scayle/unstorage-scayle-kv-driver