From 25365ff8fe2ca8df62cafdf0aa2efe70e23828a5 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 4 Jan 2024 09:13:59 -0600 Subject: [PATCH] DEVDOCS-5703: node sass version (#14) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # [DEVDOCS-5703] ## What changed? Ensuring the node sass versions are consistent ## Release notes draft * ## Anything else? ping {names} [DEVDOCS-5703]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5703?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --- .../api-docs/storefront/widgets/widget-builder.mdx | 2 +- .../installing-stencil-cli/installing-stencil.mdx | 14 +++++++------- .../stencil-cli-options-and-commands.mdx | 2 +- .../troubleshooting-your-setup.mdx | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api-docs/storefront/widgets/widget-builder.mdx b/docs/api-docs/storefront/widgets/widget-builder.mdx index b20be2688..474c7de6f 100644 --- a/docs/api-docs/storefront/widgets/widget-builder.mdx +++ b/docs/api-docs/storefront/widgets/widget-builder.mdx @@ -7,7 +7,7 @@ This article is a guide to help you learn how to use Widget Builder. ## Prerequisites -* Node.js 18 +* Node.js 18+ * [npm](https://www.npmjs.com/) 9.5.1 * A BigCommerce [store](https://support.bigcommerce.com/s/article/Starting-a-Bigcommerce-Trial) or [sandbox store](/docs/start/about/sandboxes). * A [store-level or app-level API account](/docs/start/authentication/api-accounts) with the following OAuth scopes: diff --git a/docs/stencil-docs/installing-stencil-cli/installing-stencil.mdx b/docs/stencil-docs/installing-stencil-cli/installing-stencil.mdx index 0bdd7d06d..590130f22 100644 --- a/docs/stencil-docs/installing-stencil-cli/installing-stencil.mdx +++ b/docs/stencil-docs/installing-stencil-cli/installing-stencil.mdx @@ -1,7 +1,7 @@ # Installing Stencil CLI -BigCommerce is currently targeting 01/31/2024 to sunset its node-sass fork in favor of the latest [sass/node-sass](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the latest node version (Node 18) in Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](/docs/storefront/stencil/cli/unexpected-behavior#incompatible-scss-directives), which can cause issues with the styling of your storefront. +BigCommerce is currently targeting 01/31/2024 to sunset its node-sass fork in favor of the latest [sass/node-sass](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the latest active or maintenance node version in Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](/docs/storefront/stencil/cli/unexpected-behavior#incompatible-scss-directives), which can cause issues with the styling of your storefront. @@ -30,10 +30,10 @@ arch -x86_64 /bin/zsh curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash # Install Stencil CLI supported version of Node.js -nvm install 18.15.0 +nvm install 20.10.0 # Switch to Stencil CLI supported version of Node.js: -nvm use 18.15.0 +nvm use 20.10.0 # Install Stencil CLI npm install -g @bigcommerce/stencil-cli @@ -56,7 +56,7 @@ choco install git # Install nvm windows and stencil-compatible node.js -choco install nvm; nvm install 18.15.0; nvm use 18.15.0 +choco install nvm; nvm install 20.10.0; nvm use 20.10.0 # Install Stencil CLI npm install -g @bigcommerce/stencil-cli @@ -78,7 +78,7 @@ If you're a pro at installing and configuring Python and Node.js environments on **Required Dependencies:** * [Git](https://git-scm.com/downloads) - required to run npm install -* [Node.js 18.15.0 and npm](https://nodejs.org/en/download/releases/) +* [Node.js 20.10.0 and npm](https://nodejs.org/en/download/releases/) Once they're installed and configured, use `npm` to install Stencil CLI: @@ -103,9 +103,9 @@ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash source ~/.bashrc # Explicitly install and use supported node version -nvm install 18.15.0 +nvm install 20.10.0 -nvm use 18.15.0 +nvm use 20.10.0 # Install stencil npm install -g @bigcommerce/stencil-cli diff --git a/docs/stencil-docs/installing-stencil-cli/stencil-cli-options-and-commands.mdx b/docs/stencil-docs/installing-stencil-cli/stencil-cli-options-and-commands.mdx index 44fd2741a..78489d4e8 100644 --- a/docs/stencil-docs/installing-stencil-cli/stencil-cli-options-and-commands.mdx +++ b/docs/stencil-docs/installing-stencil-cli/stencil-cli-options-and-commands.mdx @@ -5,7 +5,7 @@ This article is a comprehensive command reference for Stencil CLI, BigCommerce's powerful theme development and deployment tool. For installation instructions for your OS, see [Installing Stencil CLI](/docs/storefront/stencil/cli/install). For more information on BigCommerce's Stencil Theme Engine, see [About Stencil](/docs/storefront/stencil/start). Continue reading below for detailed information on each Stencil CLI command and option. -BigCommerce is currently targeting January 31, 2024 to sunset its node-sass fork in favor of the latest [sass/node-sass](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the latest node version (Node 18) in Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](/docs/storefront/stencil/cli/unexpected-behavior#incompatible-scss-directives), which can cause issues with the styling of your storefront. +BigCommerce is currently targeting January 31, 2024 to sunset its node-sass fork in favor of the latest [sass/node-sass](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the latest active or maintenance node version in Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](/docs/storefront/stencil/cli/unexpected-behavior#incompatible-scss-directives), which can cause issues with the styling of your storefront. ## Commands overview diff --git a/docs/stencil-docs/installing-stencil-cli/troubleshooting-your-setup.mdx b/docs/stencil-docs/installing-stencil-cli/troubleshooting-your-setup.mdx index a6e1b528f..61bb7373c 100644 --- a/docs/stencil-docs/installing-stencil-cli/troubleshooting-your-setup.mdx +++ b/docs/stencil-docs/installing-stencil-cli/troubleshooting-your-setup.mdx @@ -6,7 +6,7 @@ When you encounter unexpected behavior while developing your Stencil theme, star In some cases, the terminal provides verbose error messages specifying where to look for problems. These have the potential to provide insight into the root cause of errors. For error messages that may not be helpful in revealing the issue you're experiencing, diagnostic suggestions are listed in this article. - BigCommerce is currently targeting January 31, 2024 to sunset its node-sass fork in favor of the latest [sass/node-sass (GitHub)](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the [latest Node.js version with long-term support (Node 18 LTS)](https://nodejs.org/en) to run the Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](#incompatible-scss-directives), which can cause errors and consistency issues with your storefront's CSS. + BigCommerce is currently targeting January 31, 2024, to sunset its node-sass fork in favor of the latest [sass/node-sass (GitHub)](https://github.com/sass/node-sass). To ensure that your storefront is up to date, use the [latest Node.js version with long-term support](https://nodejs.org/en) or the maintenance node version to run the Stencil CLI and use the CLI command to resolve [incompatible SCSS directives](#incompatible-scss-directives), which can cause errors and consistency issues with your storefront's CSS. ## Incompatible SCSS directives @@ -48,7 +48,7 @@ For more information, see [Incompatible Directives](/docs/storefront/stencil/cli ## Unsupported Node version -If you receive the following error message, please reinstall Node.js to the [latest Node.js version with long-term support (Node 18 LTS)](https://nodejs.org/en): +If you receive the following error message, please reinstall Node.js to the [latest Node.js version with long-term support](https://nodejs.org/en): ```text filename="Error, no parse method" showLineNumbers copy Debug: internal, implementation, error @@ -154,7 +154,7 @@ The following error indicates that there is a trailing comma in the frontmatter Error: Found unallowed trailing symbol in: "4,", while parsing frontmatter at ".....templates/pages/home.html". ``` -### Node 18 support +### Node support When you update the Node.js version, you can check to see whether you can update other theme packages, such as webpack, for updated feature support.