Next.js: Document how Next and ts-jest coexist

[jyasskin]

Feature request

Is your feature request related to a problem? Please describe.

From https://github.com/zeit/next.js/issues/3663#issuecomment-385361537 and https://github.com/zeit/next.js/issues/8663, it looks like no single value for the tsconfig's compilerOptions.jsx works for both Next.js (which requires "preserve") and Jest (which requires "react"). Those issues suggest configuring ts-jest to use a separate tsconfig.jest.json, but their guidance hasn't made it into any actual documentation that I can find.

Describe the solution you'd like

Write a page in https://nextjs.org/docs/ saying how to get started testing.

Describe alternatives you've considered

• The documentation could also go in https://kulshekhar.github.io/ts-jest/user/config/.
• The solution in https://github.com/zeit/next.js/tree/canary/examples/with-jest (1) doesn't use typescript and (2) according to https://kulshekhar.github.io/ts-jest/user/babel7-or-ts would fail to typecheck the tests.
• An even better alternative would be to improve ts-jest somehow to cope with JSX tags in its source, but that seems more work than just documenting the workaround.

[Timer]

You should be using the with-jest example, which supports TypeScript files, and be relying on next build to run the type checking (which it does)!

[jyasskin]

I tried the with-jest example, introduced a type error, and neither npm test nor npm run build failed. A type error did cause npm test to fail when I followed the linked issues' advice.

Even if with-jest did work for typescript, an example isn't a complete substitute for a documentation page that describes how you intend folks to test their projects.

[timneutkens]

Feel free to send a PR.

[meoyawn]

does anybody know any workarounds?

[bobstrange]

@meoyawn
There is already an example with-typescript-eslint-jest.

So, I think this issue should have closed :thinking:

[Timer]

Closing per above and that we allow module: 'commonjs' on next@canary!

[bobstrange]

@Timer
Thank you for closing this issue :bow:
Do you think if we should put a the with-typescript-eslint-jest example link on with-jest's README ?

[Timer]

I don't think it's necessary, the with-jest example covers TypeScript usage already.

[meoyawn]

thanks @bobstrange @Timer