Skip to content

Commit

Permalink
DEVDOCS-5703: node sass version (#14)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [DEVDOCS-5703]


## What changed?
Ensuring the node sass versions are consistent

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* 

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-5703]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5703?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter committed Jan 4, 2024
1 parent 3d2a2c3 commit 25365ff
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/api-docs/storefront/widgets/widget-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
14 changes: 7 additions & 7 deletions docs/stencil-docs/installing-stencil-cli/installing-stencil.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing Stencil CLI

<Callout type="warning">
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.

</Callout>

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:

Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Callout type="warning">
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.
</Callout>

## Commands overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Callout type="warning">
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.
</Callout>

## Incompatible SCSS directives
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 25365ff

Please sign in to comment.