t3-oss / t3-env

https://env.t3.gg
MIT License
2.45k stars 79 forks source link

Problems with package import in version 0.9.1, How can I make Jest work successfully? #242

Open hooty868 opened 1 month ago

hooty868 commented 1 month ago

backdround

When running individual Jest tests, I encounter an error due to the package not being resolved correctly.

the test will show this error: `

Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax.

Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration.

By default "node_modules" folder is ignored by transformers.

Here's what you can do:
 • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it.
 • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript
 • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
 • If you need a custom transformation specify a "transform" option in your config.
 • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

You'll find more details and examples of these config options in the docs:
https://jestjs.io/docs/configuration
For information about custom transformations, see:
https://jestjs.io/docs/code-transformation

Details:

/.pnpm/@t3-oss+env-nextjs@0.10.1_typescript@5.3.3_zod@3.21.4/node_modules/@t3-oss/env-nextjs/dist/index.js:1
({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){import { createEnv as createEnv$1 } from '@t3-oss/env-core';
                                                                                  ^^^^^^

SyntaxError: Cannot use import statement outside a module`

### My environment config:

`

import { createEnv } from '@t3-oss/env-nextjs';
import { z } from 'zod';

export const env = createEnv({
skipValidation: process.env.SKIP_ENV_VALIDATION === 'true',
isServer: typeof window === 'undefined',

server: {
    // Sentry
    SENTRY_RELEASE: z.string().optional(),
    ENABLE_SENTRY_LOG: z.string().optional(),
},

client: {
    // Sentry
    NEXT_PUBLIC_SENTRY_RELEASE: z.string().optional(),
    NEXT_PUBLIC_ENABLE_SENTRY_LOG: z.string().optional(),
},

runtimeEnv: {
    // Sentry
    SENTRY_RELEASE: process.env.SENTRY_RELEASE,
    NEXT_PUBLIC_SENTRY_RELEASE: process.env.NEXT_PUBLIC_SENTRY_RELEASE,
    NEXT_PUBLIC_ENABLE_SENTRY_LOG: process.env.NEXT_PUBLIC_ENABLE_SENTRY_LOG,
    ENABLE_SENTRY_LOG: process.env.ENABLE_SENTRY_LOG,
}

});`

Relevant Package Versions:

Project tsconfig settings:

{ "compilerOptions": { "target": "es5", "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, "strict": true, "forceConsistentCasingInFileNames": true, "noEmit": true, "esModuleInterop": true, "module": "esnext", "moduleResolution": "node", "resolveJsonModule": true, "isolatedModules": true, "jsx": "preserve", "incremental": true, "baseUrl": "src", "paths": { "@/*": ["*"] } }, "include": ["next-env.d.ts", "next.config.js", "**/*.ts", "**/*.tsx", "src/env.mjs"], "exclude": ["node_modules"] }

lichb0rn commented 1 month ago

Same issue. Next.js: v14.2.3, @t3-oss/env-nextjs: 0.10.1, jest: 29.7.0, typescript: 5.4.5

My jest.config.js is pretty default:

const nextJest = require('next/jest');

const createJestConfig = nextJest({
  dir: './',
});

const config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
};

module.exports = createJestConfig(config);
hooty868 commented 1 month ago

Here is my current solution.

Add the packages that need to be transpiled in next.config.js:

{
...
transpilePackages: [
      ...
        '@t3-oss/env-nextjs',
        '@t3-oss/env-core',
    ],
}

Due to Jest being unable to parse untranspiled ESM packages, it is necessary to have webpack transpile them first. In Next.js, this can be accomplished by adding transpilePackages to next.config.js.