运行 Jest 时 NextJS 中未定义环境变量

我设置了一个简单的 NextJS 项目，但在让 Jest 识别我的环境变量时遇到问题。我已按照以下说明进行操作https://nextjs.org/docs/basic-features/environment-variables#test-environment-variables https://nextjs.org/docs/basic-features/environment-variables#test-environment-variables尽我所能，但无法让它发挥作用。

这是我的问题的简化版本。

// .env.test.local
MY_ENVIRONMENT_VARIABLE=my_value

// My function I want to test
export const getEnvironment = () => {
  const MY_ENVIRONMENT_VARIABLE = process.env.MY_ENVIRONMENT_VARIABLE;
  return MY_ENVIRONMENT_VARIABLE;
};

// My test
import { getEnvironment } from './getEnvironment';

describe('Get environment', () => {
  it('will have the correct environment variable', () => {
    const myEnvironmentVar = getEnvironment();
    const expectedEnv = "my_value";
    expect(myEnvironmentVar).toEqual(expectedEnv);
  });
});

我正在开玩笑jest --watch。我可以看到它获得了环境test，但我自己指定的变量都没有出现。

上面的测试失败了

Expected: "my_value"
Received: undefined

如果有任何其他文件相关，请发表评论，我将添加我所拥有的内容。

NextJS 12 与新编译器 SWC

NextJS 版本 12 引入了一个新的编译器 SWC，用 Rust 编写。使用此编译器管理环境变量非常简单并且是内置的。文档位于https://nextjs.org/docs/advanced-features/compiler#jest https://nextjs.org/docs/advanced-features/compiler#jest描述如何设置 Jest 配置：

// jest.config.js
const nextJest = require('next/jest');

// Providing the path to your Next.js app which will enable loading next.config.js and .env files
const createJestConfig = nextJest({ dir: './' });

// Any custom config you want to pass to Jest
const customJestConfig = {
  moduleDirectories: ['node_modules', __dirname]
};

// createJestConfig is exported in this way to ensure that next/jest can load the Next.js configuration, which is async
module.exports = createJestConfig(customJestConfig);

在这里我添加了一个自定义配置moduleDirectories因为我在运行测试时遇到了绝对导入的问题。由于我的代码位于.我想添加'.'作为模块目录。但由于一个Jest 中的开放错误 https://github.com/facebook/jest/issues/12889你必须指定__dirname反而。

NextJS 11 及更早版本

自从我问这个问题以来，文档已经更新，并提供了比在测试之前完全开始下一步更好的答案。

https://nextjs.org/docs/basic-features/environment-variables#test-environment-variables https://nextjs.org/docs/basic-features/environment-variables#test-environment-variables

将环境变量加载到测试环境中的建议方法是添加 jest 的配置文件，添加安装脚本，并在该脚本中使用包含的 NextJSloadEnvConfig功能。

The .env.test可以填充虚拟数据并签入您的存储库。与普通环境变量一样，您可以使用以下命令在本地覆盖它们.env.test.local-file.

// jest.config.js
module.exports = {
  globalSetup: '<rootDir>/__test__/setupEnv.js'
}

// __test__/setupEnv.js
import { loadEnvConfig } from '@next/env'

export default async () => {
  const projectDir = process.cwd()
  loadEnvConfig(projectDir)
}

# .env.test
MY_ENVIRONMENT_VARIABLE="a-variable-for-testing"