立体声
BigCommerce服务器仿真器用于本地主题开发.
安装
注: Stencil 需要节点.js运行时环境, 需要24.x版本或稍后版本.
运行 npm install -g @bigcommerce/stencil-cli。 。 。 .
访问 安装指南 更多细节.
使用量
Usage: stencil [options] [command]
Commands:
init Interactively create a .stencil file which configures how to run a BigCommerce store locally.
start Starts up the BigCommerce storefront local development environment, using theme files in the current directory and data from the live store.
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.
pull Pulls the configuration from the active theme on your live store and updates your local configuration.
download Downloads the theme files from the active theme on your live store.
debug Prints environment and theme settings for debug purposes.
help [cmd] display help for [cmd]
Options:
-h, --help output usage information
-V, --version output the version number
运行 stencil init 在您的 Stencil 主题的顶层。 它会问你几个问题开始.
运行 stencil start 运行本地服务器,以便您开始开发您的主题.
运行 -o 或者说 --open 以自动打开浏览器.
- 在stencil运行时,您可以输入"rs",然后点击输入以自动重载所有浏览器. 这类似于 诺德蒙的rs选择.
使宽度预览
如果Makeswift被启用用于商店前端, stencil start 打开 Cloudflare 快速隧道
云层。 。 。 .
若为 cloudflared stencil CLI 询问它是否可以下载一个被绑定的、校验和校验过的
释放。 如果你同意,它会缓存释放 <cache dir>/stencil-cli/cloudflared/<version>/。如果拒绝,或
终端不是交互的, stencil start 继续不预览 Makeswift 。 缓存目录是 ~/Library/Caches 打开
马科斯, %LOCALAPPDATA% 窗口上,以及 $XDG_CACHE_HOME 或者说 ~/.cache 其他系统.
要使用自己的二进制并关闭下载( 例如下线), 设置 STENCIL_CLOUDFLARED_PATH 路径
联 合 国 cloudflared。 。 。 .
运行 stencil bundle 以验证您的代码并创建可上传到 BigCommerce 的zip捆绑文件.
运行 stencil release 标记新版本的主题,创建 GitHub 发布
在您的主题仓库中,然后将zip捆绑文件上传到释放资产.
用于跟踪您在主题中的变化, 也是我们在 BigCommerce 中创建新版本的工具
圆柱 主题.
运行 stencil push 将本地主题捆绑并上传到您的商店, 因此可以在 My Themes 中找到 .
推动主题并启动它,使用 stencil push -a中自动删除最老的主题
您的主题限制, 使用 stencil push -d。这些可以一起使用,因为 stencil push -a -d。您可以将主题应用到
多个存储前端, 仅指定想要的存储前端/通道的编号 -c 选项 stencil push -a -c 123 456 789。 。 。 .
如果您想要将主题应用到所有可用的商店前端, 请使用 -allc 选项 : stencil push -a -allc。 。 。 .
运行 stencil pull 以同步您在现场商店中修改主题配置。 例如,如果页面构建器已经
用于修改某些主题设置,这将更新配置中的设置。 json在您的主题文件中,所以您
不要在下次上传时覆盖它们.
运行 stencil debug 获取运行时环境和配置信息
特征
浏览器同步
Stencil CLI用浏览器Sync来包装 这样你就可以利用所有这些惊人的好东西了! 看看他们 网址 更多信息.
Sass 编译
可以在资产/证券中将 Sass(node-sass) scs 文件编译为 CSS. 例如,添加一个名为主题的 scs 文件.css
资产/杂费和 {{{stylesheet 'assets/css/theme.css'}}} 转到主题 HTML 模板。 Stencil- CLI 将编译
(原始内容存档于2017-06-26). at the fly.
自动前置器
Stencil CLI 被包装 自动前置器设置浏览器 应该针对目标,或者它应该将生成的规则级联到主题的配置中 选项:
autoprefixer_cascade- 默认为true。 。 。 .autoprefixer_browsers- 默认为["> 1%", "last 2 versions", "Firefox ESR"]。 。 。 .
如何获得帮助或报告错误
如果您需要帮助或体验任何错误, 请在此寄存器中创建 GitHub 问题 .
发展
如果你想改进这个项目 检查一下 贡献指南同时,你可以找到 详细情况.
版本和发行
Stencil CLI 的使用 语义释放。在拉动时使用的承诺消息 请求被合并决定下一个版本.
使用 常规武器委员会 用于拉动请求标题并合并 信件 :
fix:创建补丁释放.feat:创建一个小释放.- 突破的改变创造了一个主要的释放。 添加
BREAKING CHANGE:作为承诺页脚或附件!页:1 承诺类型(例如,feat!:) (中文(简体) ).
例如:
feat!: require Node.js 24
在拉出请求被合并后,Semantic Release创建了"GitHub"发行并发布新版本为npm. 见 贡献指南 更多信息.
在插座中运行
有可能在针头上运行stencil-cli. 以下是拥有此功能的步骤.
首先,从 Github 套件中取出图像( docker register):
docker pull ghcr.io/bigcommerce/stencil-cli
然后,你想运行一些命令 针对您的主题.
举个例子
docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it ghcr.io/bigcommerce/stencil-cli stencil init时 3005 是定义在其中的端口号码 config.stencil.json 财务报告和审定财务报表 /bigcommerce/cornerstone 路径.
docker run -p 3005:3005 -v /bigcommerce/cornerstone:/usr/src/app -it ghcr.io/bigcommerce/stencil-cli stencil start 诸如此类
许可证
版权 (c) 2015年至今, BigCommerce Inc. 版权所有.
源形式和二进制形式的再分配和使用,不论有无 修改,但必须符合下列条件:
- 源代码的再分配必须保留上述版权 通知、本条件清单和下列免责声明.
- 二进制形式的再分配必须复制上述版权 通知、本条件清单和 分发时提供的文件和/或其他材料.
- 所有提及该软件特征或使用的广告材料 必须显示下列确认: 该产品包括由BigCommerce Inc所开发的软件.
- BigCommerce Inc.)的名称或名称 或 其贡献者姓名可用于认可或推广产品 来源于此软件,无须事先具体书面许可.
这个软件是大公司提供的 "AS IS"和任何 战争遗留爆炸物,包括但不受限制的 对某一特别目的而言 分会。 绝对不能为任何人 提供大奖赛 直接、间接、突发事件、特别、紧急、或后果 (包括,但不限制,实质性货物或服务的采购; 使用、数据或赞助;或业务中断) 关于任何负债的理论,无论在合同、合同或合同中 以任何方式出现于此用途之外 苏发,即使咨询 的可能性 这样的灾难.