[Feature]: Allow globalSetup to access things in globals

[ahnpnl]

🚀 Feature Proposal

Include globals in global config so that globalSetup or globalTeardown can use it.

Motivation

I notice that Jest has globals, but it isn't included in global config. When I look at name globals, I was thinking about it would be included in global config. So it would match with things related to "global".

I have a use case thymikee/jest-preset-angular#1348 which if Jest allows globals to be in global config, it will look beautiful.

Example

Define in Jest config

// jest.config.js
//...
globals: {
      'ngcc': { project: 'tsconfig.spec.json' },
}

In a globalSetup script

import type { Config } from '@jest/types';

export = async (globalConfig: Config.GlobalConfig) => {
      console.log(globalConfig.globals);
}

Pitch

This would be a change in Jest config. I think it should be in core.

[ahnpnl]

Hi @SimenB , if you think that is by design and cannot be changed, feel free to close this issue :) If you have other alternative ways, pls give me suggestions.

[SimenB]

Since globalSetup runs for each project, it makes sense to pass projectConfig, I think?

[ahnpnl]

Does it mean, if users have a repo with Jest projects for multiple projects like this

/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
module.exports = {
  globalSetup: 'jest-preset-angular/global-setup',
  projects: ['<rootDir>/projects/app1', '<rootDir>/projects/app2'],
};

Jest shouldn't run globalSetup at all at root but should run per project?

[SimenB]

I'd assume so, try it out? I've never used the global hooks at all, so I haven't really internalised how they work.

#6865 implemented it in projects, looking at it might provide clues?

[ahnpnl]

Thanks for the information. Reading the motivation from #6865, it means globalSetup can run:

• for each individual project which are defined via projects
• or run at root

Since globals config option is only available in ProjectConfig, can we pass 2nd argument to globalSetup function? An example is

// globalSetup.ts
export = async (globalConfig, projectConfig) => {
     // ....
}

I think passing projectConfig to globalSetup function would be an easier implementation and seem to be more flexible

[SimenB]

Yeah, that's what I meant in #12436 (comment)

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.