feat(jest): allow enabling Jest global types through `"types": ["jest"]` in `tsconfig.json` #12856

mrazauskas · 2022-05-17T11:40:57Z

Summary

Based on the idea from #12853 (comment) by @ahnpnl

It was suggested to employ declaration merging of global scope and allow enabling Jest global types through tsconfig.json:

"types": ["jest/globals"]

That’s really nice. After playing a bit, I figured out that it is possible to have declare global directly in index.ts of 'jest' package. Simply install 'jest', add global types through to tsconfig.json:

"types": ["jest"]

Javascript project? Install 'jest', have your JS typed. Not sure I get how this works. Hm.. Seems like in this case globals become available in all files. No control. Not sure if that is fine? In the other hand, installing 'jest' and '@types/jest' in a JS project gives the same effect.

Ah.. It is possible to opt-out through tsconfig.json. So the difference: '@types/jest' is opt-in, but adding this feature would force some JS users to opt-out. Feels breaking. Or at least annoying for sensitive people ;D

Todo

update documentation.

Test plan

Type test is added.

ahnpnl · 2022-05-17T11:52:16Z

thanks!

mrazauskas · 2022-05-17T12:00:01Z

packages/babel-jest/src/__tests__/tsconfig.json

@@ -0,0 +1,8 @@
+{


__tests__ and e2e directories needs additional tsconfig.json with "types": ["jest"]. That’s a lot of new files. For now I keep them all the same hoping this would help to review the PR. In few test suites some type fixing here and there is needed. Not touching these now. I will come back with fix PRs case-by-case.

Also here I have to extend the root tsconfig.json, because tsconfig.json in the enclosing directory is excluding __tests__. Seems like excludes can not be overridden.

mrazauskas · 2022-05-17T12:01:42Z

scripts/bundleTs.mjs

@@ -38,7 +38,7 @@ const copyrightSnippet = `

 const typesNodeReferenceDirective = '/// <reference types="node" />';

-const excludedPackages = new Set(['@jest/globals']);
+const excludedPackages = new Set(['@jest/globals', 'jest']);


Bundling removes declare. In any case, that is just one .d.ts.

mrazauskas · 2022-05-17T12:02:19Z

yarn.lock

@@ -5076,16 +5075,6 @@ __metadata:
  languageName: node
  linkType: hard

-"@types/jest@npm:^27.4.0":


And... This is gone! ;D

mrazauskas · 2022-05-17T13:16:31Z

docs/ExpectAPI.md

  expect({apples: 6, bananas: 3}).toEqual({
    apples: expect.toBeWithinRange(1, 10),
    bananas: expect.not.toBeWithinRange(11, 20),
  });
 });
 ```

-:::note
-
-In TypeScript, when using `@types/jest` for example, you can declare the new `toBeWithinRange` matcher in the imported module like this:


This page can have more TS examples, of course. I just wanted to remove this old pain.

mrazauskas · 2022-05-18T04:32:40Z

packages/jest/src/index.ts

@@ -13,3 +13,26 @@ export {
 } from '@jest/core';

 export {run} from 'jest-cli';
+
+declare global {
+  export const beforeEach: typeof import('@jest/globals')['beforeEach'];


export is not needed, because global namespace is always public. I added export just as a hint for future reader that these are being exposed here.

SimenB

exciting! We should try to add a bunch of the helpers onto the jest namespace as well

e2e/tsconfig.json

docs/UpgradingToJest29.md

SimenB · 2022-08-13T11:14:25Z

packages/babel-jest/src/__tests__/tsconfig.json

+  "extends": "../../../../tsconfig.json",
+  "compilerOptions": {
+    "composite": false,
+    "esModuleInterop": true,


do we need this? (applies to all)

Some tests needs it. For example, commenting out "esModuleInterop": true give type error here:

https://github.com/facebook/jest/blob/ae8cf9a78cb0cd2f54d3bacbc1c8837e540e21dc/packages/pretty-format/src/__tests__/react.test.tsx#L8

My idea was to use the same tsconfig.json file for all packages to simplify review. But I can go through and enable it case by case. This option applies only for files inside __tests__ directories. Perhaps it is fine to keep it?

A separate PR making it unneeded would be awesome, but shouldn't clutter up this pr

SimenB · 2022-08-13T11:15:24Z

packages/test-utils/src/ConditionalTest.ts

+declare const describe: Global.TestFrameworkGlobals['describe'];
+declare const test: Global.TestFrameworkGlobals['test'];


why are these needed? shouldn't they just import from @jest/globals?

Ah.. I reworked these into imports, but seems like these create circular references somehow – https://github.com/facebook/jest/runs/7819204971

Edit: @jest/globals depend on expect which depends on test-utils. Unfortunately that’s circular. In contrary @jest/types depends only on @jest/schemas. Fingers crossed we will not need test-utils for schemas ;D

SimenB · 2022-08-13T11:15:45Z

packages/pretty-format/src/__tests__/setPrettyPrint.ts

-    interface Matchers<R> {
-      toPrettyPrintTo(expected: unknown, options?: OptionsReceived): R;
-    }
+declare module 'expect' {


mrazauskas · 2022-08-13T12:19:24Z

e2e/tsconfig.json

@@ -1,22 +1,8 @@
 {
+  "extends": "../tsconfig.json",


Let’s extend this one too? Why not?

Hm.. Just noticed that "noEmit": true went missing. Shall I bring it back? And perhaps shall I use it for all __tests__?

mrazauskas · 2022-08-13T12:39:51Z

We should try to add a bunch of the helpers onto the jest namespace as well

Just looked through the jest namespace again. Hm.. Not sure which ones could be useful? Perhaps the ones currently exported from jest-mock as ClassLike, FunctionLike, ConstructorLikeKeys, MethodLikeKeys, PropertyLikeKeys? Can these be useful? Anything else?

SimenB · 2022-08-13T12:44:23Z

I'm thinking of stuff like DoneCallback, MatcherUtils etc. (and mock stuff like you mention), i.e. things you might use as arguments in helpers and whatnot. Yes, these can be imported explicitly from the different modules, but having them on jest. is useful, I think. Although, we shouldn't add too many - it's easier to add when people have use cases later than adding a bunch that are never used and maintain them

mrazauskas · 2022-08-13T12:54:46Z

Right! Actual I can search on GitHub and see which ones are used:

https://github.com/araujo21x/API_adocao_animais/blob/05d9706be29ad002b4c14813bbf66982ec3fde3d/tests/user/registerONG.test.ts#L36

Edit: very exciting to look around. Even jest.TestFn type is used in helpers. Makes sense indeed. I will think about these.

SimenB · 2022-08-13T14:38:19Z

There is also https://github.com/facebook/jest/blob/ae8cf9a78cb0cd2f54d3bacbc1c8837e540e21dc/packages/jest-util/src/__tests__/installCommonGlobals.test.ts#L11 btw.

I'm getting an error, is the namespace thing not working?

jest.fn() is typed correctly, fwiw

mrazauskas · 2022-08-13T18:59:05Z

Good catch. The issue is with this PR. All works with import {jest} from '@jest/globals', so it seems like I simply did not add jest namespace to global. Found a solution. Will double check I the morning.

mrazauskas · 2022-08-14T07:35:32Z

packages/jest/src/index.ts

+  export const jest: typeof import('@jest/globals')['jest'];
+
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace jest {


Not happy about the duplication with declarations in @jest/globals.

Another problem – it was not a good idea to put everything into index file. Now import {Config} from 'jest' is also augmenting global and pulling in Jest’s globals. That’s not good. So "types": ["jest"] should be reworked into something like "types": ["jest/globals"]. This means that "exports" needs additional entry.

In a way all is fine, but at the same time the implementation becomes more and more hairy. In contrary import {expect, test} from '@jest/globals' is simple and declarative. Does not need all the hairy stuff I mentioned. The more I work on this PR, the more I am a fan of that straight forward import ;D

I think requiring types: ['jest/global-api'] or something very explicit is perfectly fine 👍

phawxby · 2022-08-18T08:05:43Z

@mrazauskas just wondering what the progress of this ticket is? I believe @SimenB is hoping to get this in V29. What are the remaining items to look into, would you like me to see if I can carve out some time to help?

mrazauskas · 2022-08-18T08:09:38Z

Brief answer: I am uncertain if this is a good idea. Have to think about it more and to do some testing.

Perhaps it is not worth to postpone the release? This PR is a feature anyways, so it could land any time later.

SimenB · 2022-08-18T08:33:16Z

Yeah, currently leaning towards not having it in 29 - doing import type {Config} from 'jest' or import {runCLI} from 'jest' shouldn't pollute the global (TS) namespace

mrazauskas · 2022-09-30T17:52:36Z

Closing in favour of #13344 and DefinitelyTyped/DefinitelyTyped#62037

github-actions · 2022-11-01T00:11:44Z

This pull request 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.

feat: jest global types

ed0b797

facebook-github-bot added the cla signed label May 17, 2022

mrazauskas commented May 17, 2022

View reviewed changes

mrazauskas added 2 commits May 17, 2022 15:56

add docs

ed47a17

more docs

075268f

mrazauskas commented May 17, 2022

View reviewed changes

mrazauskas added 2 commits May 17, 2022 16:18

add change log

fc87c17

clean up

a37c2cd

mrazauskas marked this pull request as ready for review May 17, 2022 13:40

add missing references

c642ac6

mrazauskas mentioned this pull request May 18, 2022

refactor: use typed jest globals jest-community/jest-runner-tsd#79

Closed

mrazauskas added 3 commits May 18, 2022 07:01

add export

00c2452

tweak tsconfigs

973955c

fix lock

a0fa6ed

mrazauskas commented May 18, 2022

View reviewed changes

mrazauskas added 2 commits June 3, 2022 07:35

rebase

ef6d981

tabs

048c18c

mrazauskas mentioned this pull request Jun 3, 2022

[wip]: remove @types/jest everywhere #12415

Closed

1 task

rebase

cb3ef9f

SimenB reviewed Aug 13, 2022

View reviewed changes

mrazauskas added 3 commits August 13, 2022 15:01

import from @jest/globals

ea84f93

fix upgrading docs

998e02a

tweak e2e tsconfig.json

dd87ffc

mrazauskas commented Aug 13, 2022

View reviewed changes

mrazauskas added 2 commits August 13, 2022 15:26

revert imports

c734ec5

fix lock

7a9c054

mrazauskas mentioned this pull request Aug 13, 2022

[Feature]: Export MockedObject & similar utility types? #12784

Closed

mrazauskas marked this pull request as draft August 14, 2022 05:27

fix namespace

8475aef

mrazauskas commented Aug 14, 2022

View reviewed changes

mrazauskas added 2 commits August 14, 2022 11:53

include deps

a8d883d

test namespace

a65cfee

mrazauskas mentioned this pull request Aug 14, 2022

chore: remove unused jest-environment-jsdom mock #13132

Merged

SimenB mentioned this pull request Aug 15, 2022

fix: worker being killed after being spawned and other worker bugs #13107

Merged

mrazauskas mentioned this pull request Aug 31, 2022

[Feature]: Please export @jest/globals into global namespace #13196

Closed

mrazauskas mentioned this pull request Sep 20, 2022

fix(@jest/test-utils): use build-in Jest types instead of @types/jest #13283

Merged

mrazauskas mentioned this pull request Sep 30, 2022

chore: replace @types/jest with a new private @jest/test-globals package #13344

Merged

1 task

mrazauskas closed this Sep 30, 2022

mrazauskas deleted the feat-global-types branch October 1, 2022 16:24

github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(jest): allow enabling Jest global types through `"types": ["jest"]` in `tsconfig.json` #12856

feat(jest): allow enabling Jest global types through `"types": ["jest"]` in `tsconfig.json` #12856

mrazauskas commented May 17, 2022 •

edited

ahnpnl commented May 17, 2022

mrazauskas May 17, 2022 •

edited

mrazauskas May 17, 2022

mrazauskas May 17, 2022

mrazauskas May 17, 2022

mrazauskas May 18, 2022 •

edited

SimenB left a comment

SimenB Aug 13, 2022

mrazauskas Aug 13, 2022

SimenB Aug 14, 2022

SimenB Aug 13, 2022

mrazauskas Aug 13, 2022 •

edited

SimenB Aug 13, 2022

mrazauskas Aug 13, 2022

mrazauskas commented Aug 13, 2022 •

edited

SimenB commented Aug 13, 2022

mrazauskas commented Aug 13, 2022 •

edited

SimenB commented Aug 13, 2022 •

edited

mrazauskas commented Aug 13, 2022

mrazauskas Aug 14, 2022

SimenB Aug 14, 2022

phawxby commented Aug 18, 2022

mrazauskas commented Aug 18, 2022

SimenB commented Aug 18, 2022

mrazauskas commented Sep 30, 2022

github-actions bot commented Nov 1, 2022

		declare const describe: Global.TestFrameworkGlobals['describe'];
		declare const test: Global.TestFrameworkGlobals['test'];

feat(jest): allow enabling Jest global types through "types": ["jest"] in tsconfig.json #12856

feat(jest): allow enabling Jest global types through "types": ["jest"] in tsconfig.json #12856

Conversation

mrazauskas commented May 17, 2022 • edited

Summary

Todo

Test plan

ahnpnl commented May 17, 2022

mrazauskas May 17, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas May 18, 2022 • edited

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas Aug 13, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas commented Aug 13, 2022 • edited

SimenB commented Aug 13, 2022

mrazauskas commented Aug 13, 2022 • edited

SimenB commented Aug 13, 2022 • edited

mrazauskas commented Aug 13, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phawxby commented Aug 18, 2022

mrazauskas commented Aug 18, 2022

SimenB commented Aug 18, 2022

mrazauskas commented Sep 30, 2022

github-actions bot commented Nov 1, 2022

feat(jest): allow enabling Jest global types through `"types": ["jest"]` in `tsconfig.json` #12856

feat(jest): allow enabling Jest global types through `"types": ["jest"]` in `tsconfig.json` #12856

mrazauskas commented May 17, 2022 •

edited

mrazauskas May 17, 2022 •

edited

mrazauskas May 18, 2022 •

edited

mrazauskas Aug 13, 2022 •

edited

mrazauskas commented Aug 13, 2022 •

edited

mrazauskas commented Aug 13, 2022 •

edited

SimenB commented Aug 13, 2022 •

edited