Cypress：如何仅将部分环境变量提交至源代码控制？

当然可以实现单个环境对应多个配置文件，核心是在Cypress的配置逻辑里分别加载公开配置和私密凭证文件，再合并两者的环境变量。具体步骤如下：

1. 拆分配置文件 #

• 保留原有的development.json和production.json，只存放无需隐藏的公开配置（比如baseUrl）：

  // cypress/config/development.json
  {
      "env": {
          "baseUrl": "test.com"
      }
  }
  

• 创建对应环境的私密凭证文件，比如development.credentials.json和production.credentials.json，仅存放敏感信息（比如账号密码）：

  // cypress/config/development.credentials.json
  {
      "env": {
          "freeUserEmail": "test",
          "freeUserPassword": "test123"
      }
  }
  

• 将私密凭证文件加入.gitignore，避免提交到源代码控制：

  // .gitignore
  cypress/config/*.credentials.json
  

2. 修改Cypress配置文件，合并多文件配置 #

在setupNodeEvents钩子中，依次加载公开配置和私密凭证文件，再将两者的环境变量合并到Cypress的全局配置中。同时处理私密文件不存在的情况（比如新克隆项目的用户可以先复制模板文件）：

import path from 'path';
import { defineConfig } from 'cypress';

export default defineConfig({
  e2e: {
    async setupNodeEvents(on, config) {
      const version = config.env.version || 'development';
      
      // 加载公开配置文件
      const publicConfig = await import(path.join(
        config.projectRoot,
        'cypress/config',
        `${version}.json`
      ));
      
      // 尝试加载私密凭证文件，不存在则跳过
      let credentialsConfig = { env: {} };
      try {
        credentialsConfig = await import(path.join(
          config.projectRoot,
          'cypress/config',
          `${version}.credentials.json`
        ));
      } catch (err) {
        console.log(`未找到${version}.credentials.json，请确保已创建该文件并填入正确凭证`);
      }
      
      // 合并环境变量：优先级为 命令行传入的env > 私密凭证 > 公开配置
      config.env = {
        ...config.env,
        ...publicConfig.env,
        ...credentialsConfig.env
      };
      
      return config;
    },
  },
});

3. 可选：提供凭证文件模板 #

为方便其他开发者快速上手，可以创建凭证文件的模板（比如development.credentials.example.json）并提交到版本控制，让开发者复制后修改为实际的凭证文件：

// cypress/config/development.credentials.example.json
{
    "env": {
        "freeUserEmail": "请填入你的测试邮箱",
        "freeUserPassword": "请填入你的测试密码"
    }
}

内容的提问来源于stack exchange，提问作者George