No description
Find a file
John Daly 725fbc29ce
[next/jest] Support path aliases from tsconfig/jsconfig (#45815)
<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
-->

# Description

fixes #31159
fixes #44553

Path aliases defined in `tsconfig.json` or `jsconfig.json` are not
automatically configured to work with Jest. This means that these
aliases have to be defined in multiple places.

This PR configures the SWC Jest transform to handle the `baseUrl` and
`paths`, so that users don't need to configure a `moduleNameMapper` for
Jest.

~This PR intends to make the experience more seamless by automatically
configuring Jest's `moduleNameMapper` and `moduleDirectories` based on
the settings in a project's `tsconfig`/`jsconfig`.~

~Users will be able to supply their own configuration for these fields,
if they have use-cases that require manual configuration.~

~The implementation is taken from the [`paths-to-module-name-mapper`
function in
`ts-jest`](5a0880add0/src/config/paths-to-module-name-mapper.ts).~

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [x] Related issues linked using `fixes #number`
- [ ]
[e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2023-03-01 10:52:32 +01:00
.devcontainer Remove devcontainer network host argument (#44157) 2022-12-19 16:38:20 -08:00
.github Update fetch cache internal handling (#46522) 2023-02-27 21:39:11 -08:00
.husky Replace pre-commit with husky (#38350) 2022-07-06 11:14:16 -05:00
.vscode Add tests for parallel routes / interception and handle router state patch merging client-side (#45615) 2023-02-13 16:12:44 +01:00
bench fix typo in comment and unused variable remove (#45307) 2023-02-02 14:55:23 -08:00
contributing Fix adding-exmaples.md doc (#46051) 2023-02-17 22:35:12 -08:00
docs [next/jest] Support path aliases from tsconfig/jsconfig (#45815) 2023-03-01 10:52:32 +01:00
errors Wrong function name (#46546) 2023-02-28 11:46:50 +00:00
examples Updates cms-sanity example to use Sanity v3 (#45662 2023-02-27 11:58:43 +01:00
packages [next/jest] Support path aliases from tsconfig/jsconfig (#45815) 2023-03-01 10:52:32 +01:00
scripts chore(ci): add job to test codemods (#46068) 2023-02-20 04:42:02 +00:00
test [next/jest] Support path aliases from tsconfig/jsconfig (#45815) 2023-03-01 10:52:32 +01:00
.alexignore Enable Alex documentation linting for docs (#26598) 2021-06-25 11:40:50 -05:00
.alexrc Add section to next/future/image docs about Known Browser Bugs (#39759) 2022-08-20 00:21:00 +00:00
.eslintignore refactor: Latest Tigris sdk and example using decorators (#44256) 2023-01-18 20:44:18 -08:00
.eslintrc.json Replace eslint rule for no-shadow with typescript-eslint/no-shadow (#44936) 2023-01-16 16:02:59 -08:00
.gitattributes the way towards webpack 5 typings (#29105) 2021-09-21 19:17:16 +02:00
.gitignore Include tsconfig.json in tests (#45879) 2023-02-14 18:37:09 -08:00
.npmrc declare pnpm7 as engine (#37303) 2022-05-30 13:13:36 +00:00
.prettierignore hmr error improvements (#30616) 2023-01-06 20:35:16 +01:00
.prettierignore_staged hmr error improvements (#30616) 2023-01-06 20:35:16 +01:00
.prettierrc.json Prettier trailingComma default value to es5 since 2.0 (#14391) 2020-06-22 13:25:24 +02:00
azure-pipelines.yml Update to latest version of pnpm (#44791) 2023-01-11 17:36:52 -08:00
CODE_OF_CONDUCT.md updated code of conduct to v2.1 (#34208) 2022-02-10 18:11:42 -06:00
contributing.md refactor: split up CONTRIBUTING.md (#40515) 2022-09-16 14:54:58 -07:00
jest.config.js Allow unit tests to be written in packages/next/src (#45222) 2023-01-24 14:32:09 +00:00
jest.replay.config.js Add Replay integration for dev e2e tests (#40955) 2022-09-29 14:45:10 -07:00
lerna.json v13.2.3 2023-03-01 00:46:27 -08:00
license.md Update license year (#44403) 2023-01-01 11:12:49 +01:00
lint-staged.config.js Run dev tests against default CNA templates (#45211) 2023-01-24 11:01:03 -08:00
package.json Upgrade precompiled react packages (#46365) 2023-02-28 10:13:02 +01:00
plopfile.js Revert "Fix new-error command" (#45221) 2023-01-24 16:47:48 -08:00
pnpm-lock.yaml v13.2.3 2023-03-01 00:46:27 -08:00
pnpm-workspace.yaml misc: add benchmarking script for edge rendering (#40716) 2022-09-27 17:57:16 +02:00
readme.md Monorepo (#5341) 2018-10-01 01:02:10 +02:00
release.js Fix labels for release sections 2021-11-21 13:11:54 +01:00
run-tests.js Cover 1st-party examples with tests (#45270)Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> Co-authored-by: Tim Neutkens <tim@timneutkens.nl> 2023-02-27 11:54:24 +01:00
test-file.txt Add additional file serving tests (#12479) 2020-05-04 11:58:19 -05:00
tsconfig-tsec.json Integrate tsec into the linting process (#33746) 2022-02-24 16:59:18 -08:00
tsconfig.json Adds tests to ensure eslint-plugin-next's available rules are properly exported and recommended rules are correctly defined. (#38183) 2022-06-30 11:31:33 -05:00
tsec-exemptions.json Move core files to src folder and move JS files to TypeScript (#44405) 2023-01-03 10:05:50 +01:00
turbo.json Fix turbo cache miss due to depending on gitignored files (#45166) 2023-01-24 11:53:07 +00:00
UPGRADING.md Move upgrading guide to /docs (#10727) 2020-02-28 23:46:18 +01:00
vercel.json Silence GH Comments for Preview URLs (#18766) 2020-11-03 21:59:47 +00:00

Next.js

Getting Started

Visit https://nextjs.org/learn to get started with Next.js.

Documentation

Visit https://nextjs.org/docs to view the full documentation.

Who is using Next.js?

Next.js is used by the world's leading companies. Check out the Next.js Showcase to learn more.

Community

The Next.js community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.

To chat with other community members you can join the Next.js Discord.

Our Code of Conduct applies to all Next.js community channels.

Contributing

Please see our contributing.md.

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Authors

Security

If you believe you have found a security vulnerability in Next.js, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email security@vercel.com to disclose any security vulnerabilities.

https://vercel.com/security