Security News
npm Updates Search Experience with New Objective Sorting Options
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
@bigcommerce/stencil-cli
Advanced tools
CLI tool to run BigCommerce Stores locally for theme development.
The BigCommerce server emulator for local theme development.
Note: Stencil requires the Node.js runtime environment, version 8.x. We do not yet have support for Node 10 or greater.
Run npm install -g @bigcommerce/stencil-cli
.
Visit the installation guide for more details.
Usage: stencil [options] [command]
Commands:
init Interactively create a .stencil file which configures how to run a BigCommerce store locally.
start Starts up BigCommerce store using theme files in the current directory.
bundle Bundles up the theme into a zip file which can be uploaded to BigCommerce.
release Create a new release in the theme's github repository.
push Bundles up the theme into a zip file and uploads it to your store.
help [cmd] display help for [cmd]
Options:
-h, --help output usage information
-V, --version output the version number
Run stencil init
at the top level of your Stencil Theme. It will ask you a few questions to get your started.
Run stencil start
to run a local server so you can start developing your theme.
Run with -o
or --open
to automatically open up a browser.
-e
to load a local Theme Editor.Run stencil bundle
to validate your code and create a zip bundle file that can be uploaded to BigCommerce.
Run stencil release
to tag a new version of your theme, create a GitHub release in your theme repository, and upload the zip bundle file to the release assets. This is useful for tracking your changes in your Theme, and is the tool we use to create new releases in BigCommerce Cornerstone theme.
Stencil CLI comes packaged with BrowserSync so you can take advantage of all of those amazing goodies! Have a look at their web site for more information.
You can compile Sass (node-sass) scss files in assets/scss into CSS. For example, add an scss file named theme.scss to assets/scss and {{{stylesheet 'assets/css/theme.css'}}}
to your theme HTML template. Stencil-CLI will compile assets/scss/theme.scss to CSS on the fly.
Stencil CLI comes packaged with Autoprefixer. You can set which browsers should be targeted, as well as if it should cascade the generated rules in the theme's config.json file with these options:
autoprefixer_cascade
- Defaults to true
.autoprefixer_browsers
- Defaults to ["> 1%", "last 2 versions", "Firefox ESR"]
.If you need any help or experience any bugs, please create a GitHub issue in this repository.
In order to release stencil-cli you should first use the Squash and merge
option on GitHub, This step is important for generating the CHANGELOG.md
file with the pr link attached (if not using Squash and merge
, the changes will be logged only with links to the commits). After the changes are merged to master, pull the latest to your local environment, run gulp release
and follow the prompts. NOTE: It is required that all commit messages follow the Conventional Commits structure.
Copyright (c) 2015-present, BigCommerce Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY BIGCOMMERCE INC ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BIGCOMMERCE INC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<small>1.20.3 (2019-10-10)</small>
<a name="1.20.2"></a>
FAQs
CLI tool to run BigCommerce Stores locally for theme development.
The npm package @bigcommerce/stencil-cli receives a total of 3,015 weekly downloads. As such, @bigcommerce/stencil-cli popularity was classified as popular.
We found that @bigcommerce/stencil-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
Security News
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.