如何在Gatsby中向gatsby-plugin-sass传递环境变量?
gatsby-plugin-sass 注入环境变量的正确实现方案
不生效的核心原因
- 插件版本结构调整:gatsby-plugin-sass v4及以上版本修改了参数透传逻辑,直接把
additionalData挂载在插件options根节点的写法,会被插件内置默认配置覆盖,无法传递到底层sass-loader执行流程。 - 环境变量读取异常:Gatsby构建流程默认仅加载带
GATSBY_前缀的环境变量,未加前缀的变量在构建阶段会被读取为undefined,最终注入的SCSS代码为无效值,表现为配置完全不生效。 - 本地缓存干扰:修改sass相关配置后若未清理Gatsby构建缓存,旧的编译规则会被持续复用,新配置不会触发重编译。
正确配置流程
- 调整环境变量命名,给需要注入SCSS的变量加上
GATSBY_前缀,确保构建阶段可正常读取。 - 将
additionalData参数嵌套到sassOptions配置项下,完成到底层sass-loader的参数透传,参考标准配置:// gatsby-config.js 插件配置块 { resolve: "gatsby-plugin-sass", options: { sassOptions: { // 字符串类型的变量值必须加双引号,避免SCSS解析报错 additionalData: `$storeName: "${process.env.GATSBY_SHOPIFY_STORE_NAME}";` } } } - 清理项目根目录下的
.cache文件夹后重启开发服务,让新配置生效。
注意事项
- 禁止将服务端敏感密钥通过该方式注入SCSS,最终编译产出的CSS为公开静态资源,注入的变量值会直接暴露在前端代码中。
- 项目若已配置全局SCSS导入规则,无需在多个配置项重复声明
additionalData,避免重复导入触发SCSS编译错误。
内容的提问来源于stack exchange,提问作者Jason Biondo
相关产品推荐
相关产品推荐

