Menu
Guides

Release Notes
Release Notes

FastStore: Simplified FastStore setup with FastStore CLI dependency update

Added

The new FastStore CLI version now depends on the FastStore Core package, simplifying the installation process and reducing potential version conflicts.

September 11, 2024
2 min read

To simplify the installation process and reduce potential version conflicts, the FastStore CLI (@faststore/cli) package now directly depends on FastStore Core (@faststore/core).

What has changed?

Previously, both @faststore/core and @faststore/cli packages were required dependencies in the package.json file to install and run a FastStore project.

Now, the new @faststore/cli version depends on the @faststore/core package, eliminating the need for an explicit dependency of both in the package.json file, preventing potential version conflicts, and simplifying installation.

What needs to be done?

If the @faststore/cli is already listed in your dependencies, no further action is needed. To check if the package is listed, open your FastStore project in a code editor, go to the package.json file, and check the dependencies property. For example:

package.json

_10
"dependencies": {
_10
"@faststore/cli": "^3.0.87",
_10
"next": "^13.5.6",
_10
"react": "^18.2.0",
_10
"react-dom": "^18.2.0"
_10
},

If the @faststore/cli is not listed, follow these steps:

Before applying the following changes to your production environment, test them in a local development environment to ensure compatibility and avoid issues with your live store.

  1. Open your FastStore project in a code editor, navigate to the package.json file, and locate the dependencies property.

  2. In the dependencies property, replace @faststore/core with @faststore/cli. Before removing the @faststore/core, the dependencies property might look like this:

    package.json

    _10
    "dependencies": {
    _10
    "@faststore/core": "^3.0.xx",
    _10
    "next": "^13.5.6",
    _10
    "react": "^18.2.0",
    _10
    "react-dom": "^18.2.0"
    _10
    },

    After replacing @faststore/core with @faststore/cli, the dependencies property should look like this:

    package.json

    _10
    "dependencies": {
    _10
    + "@faststore/cli": "^3.0.87",
    _10
    "next": "^13.5.6",
    _10
    "react": "^18.2.0",
    _10
    "react-dom": "^18.2.0"
    _10
    },

    Replace for a @faststore/cli version equals or greater than 3.0.87. The 3.0.87 is when these package dependencies changes were applied.

  3. Still on the package.json file, remove the @faststore/cli from the devDependencies property. After removal, it should look like this:

    package.json

    _10
    "devDependencies": {
    _10
    "@cypress/code-coverage": "^3.12.1",
    _10
    "@faststore/lighthouse": "^3.0.68",
    _10
    "@lhci/cli": "^0.9.0",
    _10
    "@testing-library/cypress": "^10.0.1",
    _10
    "cypress": "12.17.4",
    _10
    "cypress-axe": "^1.5.0",
    _10
    "cypress-wait-until": "^2.0.1",
    _10
    "typescript": "^4.9.4"
    _10
    },

  4. Open the terminal and run yarn to install the updated dependencies and update your yarn.lock file.

  5. If no errors occur during or after running yarn, create a pull request with these changes to your remote repository to apply the updates to production.

If you encounter any errors when updating these dependencies, please open a ticket with VTEX Support.