feat: allow setting custom tsconfig file #28104

casperiv0 · 2021-08-14T06:50:44Z

Ability to provide a custom tsconfig file.

Example Usage:

// next.config.js
module.exports = {
	typescript: {
		tsconfigPath: "myconfig.json"
	}
}

Bug

Related issues linked using fixes #number
Integration tests added
Errors have helpful link attached, see contributing.md

Feature

Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
Related issues linked using fixes #23972 (discussion)
Integration tests added
Documentation added
Telemetry added. In case of a feature if it's used or not.
Errors have helpful link attached, see contributing.md

Documentation / Examples

Make sure the linting passes

…custom-tsconfig

packages/next/lib/verifyTypeScriptSetup.ts

…next.js into feat/custom-tsconfig

test/integration/typescript-custom-tsconfig/test/index.test.js

packages/next/build/webpack-config.ts

packages/next/lib/typescript/getTypeScriptIntent.ts

packages/next/lib/verifyTypeScriptSetup.ts

packages/next/build/index.ts

styfle

Perfect, thanks! 🎉

ijjk · 2021-09-23T05:11:09Z

Failing test suites

Commit: 83a6efb

test/integration/app-document-remove-hmr/test/index.test.js

_app removal HMR > should HMR when _document is removed

Expand output

● _app removal HMR › should HMR when _document is removed

TIMED OUT: success

<head><meta charset="utf-8"><meta name="viewport" content="width=device-width"><meta name="next-head-count" content="2"><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills.js?ts=1632373829345"></script><script src="/_next/static/chunks/webpack.js?ts=1632373829345" defer=""></script><script src="/_next/static/chunks/main.js?ts=1632373829345" defer=""></script><script src="/_next/static/chunks/pages/_app.js?ts=1632373829345" defer=""></script><script src="/_next/static/chunks/pages/index.js?ts=1632373829345" defer=""></script><script src="/_next/static/development/_buildManifest.js?ts=1632373829345" defer=""></script><script src="/_next/static/development/_ssgManifest.js?ts=1632373829345" defer=""></script><noscript id="__next_css__DO_NOT_USE__"></noscript></head><body><p>custom _document</p><div id="__next"><p>custom _app</p><p>index page</p></div><script src="/_next/static/chunks/react-refresh.js?ts=1632373829345"></script><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/","query":{},"buildId":"development","nextExport":true,"autoExport":true,"isFallback":false,"scriptLoader":[]}</script><div id="__next-build-watcher" style="position: fixed; bottom: 10px; right: 20px; width: 0px; height: 0px; z-index: 99999;"></div><next-route-announcer><p aria-live="assertive" id="__next-route-announcer__" role="alert" style="border: 0px; clip: rect(0px, 0px, 0px, 0px); height: 1px; margin: -1px; overflow: hidden; padding: 0px; position: absolute; width: 1px; white-space: nowrap; overflow-wrap: normal;"></p></next-route-announcer></body>

  437 |
  438 |   if (hardError) {
> 439 |     throw new Error('TIMED OUT: ' + regex + '\n\n' + content)
      |           ^
  440 |   }
  441 |   return false
  442 | }

  at Object.check (lib/next-test-utils.js:439:11)
  at Object.<anonymous> (integration/app-document-remove-hmr/test/index.test.js:123:7)

ijjk · 2021-09-23T05:15:13Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
buildDuration	16s	16s	-16ms
buildDurationCached	4.1s	4s	-74ms
nodeModulesSize	182 MB	182 MB	⚠️ +986 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.701	3.594	-0.11
/ avg req/sec	675.49	695.7	+20.21
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.127	2.079	-0.05
/error-in-render avg req/sec	1175.22	1202.73	+27.51

Client Bundles (main, webpack, commons)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
779.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	26.8 kB	26.8 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	70.6 kB	70.6 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_app-HASH.js gzip	977 B	977 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	311 B	311 B	✓
css-HASH.js gzip	328 B	328 B	✓
dynamic-HASH.js gzip	2.67 kB	2.67 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	918 B	918 B	✓
image-HASH.js gzip	4.14 kB	4.14 kB	✓
index-HASH.js gzip	260 B	260 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	320 B	320 B	✓
script-HASH.js gzip	386 B	386 B	✓
withRouter-HASH.js gzip	319 B	319 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_buildManifest.js gzip	493 B	493 B	✓
Overall change	493 B	493 B	✓

Rendered Page Sizes

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
index.html gzip	538 B	538 B	✓
link.html gzip	550 B	550 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
buildDuration	8.2s	8.2s	-34ms
buildDurationCached	3.9s	3.9s	-37ms
nodeModulesSize	182 MB	182 MB	⚠️ +986 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.555	3.522	-0.03
/ avg req/sec	703.2	709.85	+6.65
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.068	2.051	-0.02
/error-in-render avg req/sec	1208.8	1219.16	+10.36

Client Bundles (main, webpack, commons)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
675-HASH.js gzip	13.8 kB	13.8 kB	✓
770.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	50.7 kB	50.7 kB	✓
main-HASH.js gzip	34.7 kB	34.7 kB	✓
webpack-HASH.js gzip	1.65 kB	1.65 kB	✓
Overall change	101 kB	101 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_app-HASH.js gzip	1.32 kB	1.32 kB	✓
_error-HASH.js gzip	180 B	180 B	✓
amp-HASH.js gzip	315 B	315 B	✓
css-HASH.js gzip	331 B	331 B	✓
dynamic-HASH.js gzip	2.8 kB	2.8 kB	✓
head-HASH.js gzip	356 B	356 B	✓
hooks-HASH.js gzip	637 B	637 B	✓
image-HASH.js gzip	573 B	573 B	✓
index-HASH.js gzip	262 B	262 B	✓
link-HASH.js gzip	2.2 kB	2.2 kB	✓
routerDirect..HASH.js gzip	326 B	326 B	✓
script-HASH.js gzip	393 B	393 B	✓
withRouter-HASH.js gzip	322 B	322 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	10.1 kB	10.1 kB	✓

Client Build Manifests

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_buildManifest.js gzip	511 B	511 B	✓
Overall change	511 B	511 B	✓

Rendered Page Sizes

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
index.html gzip	538 B	538 B	✓
link.html gzip	552 B	552 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Commit: 83a6efb

ijjk · 2021-09-23T22:27:32Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
buildDuration	15.5s	15.6s	⚠️ +75ms
buildDurationCached	4s	3.9s	-98ms
nodeModulesSize	182 MB	182 MB	⚠️ +987 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.552	3.511	-0.04
/ avg req/sec	703.88	711.96	+8.08
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.07	2	-0.07
/error-in-render avg req/sec	1207.56	1249.88	+42.32

Client Bundles (main, webpack, commons)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
779.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	26.8 kB	26.8 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	70.6 kB	70.6 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_app-HASH.js gzip	977 B	977 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	311 B	311 B	✓
css-HASH.js gzip	328 B	328 B	✓
dynamic-HASH.js gzip	2.67 kB	2.67 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	918 B	918 B	✓
image-HASH.js gzip	4.14 kB	4.14 kB	✓
index-HASH.js gzip	260 B	260 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	320 B	320 B	✓
script-HASH.js gzip	386 B	386 B	✓
withRouter-HASH.js gzip	319 B	319 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_buildManifest.js gzip	493 B	493 B	✓
Overall change	493 B	493 B	✓

Rendered Page Sizes

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
index.html gzip	538 B	538 B	✓
link.html gzip	550 B	550 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
buildDuration	8s	8s	⚠️ +59ms
buildDurationCached	3.9s	3.9s	⚠️ +6ms
nodeModulesSize	182 MB	182 MB	⚠️ +987 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.498	3.451	-0.05
/ avg req/sec	714.64	724.35	+9.71
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.023	1.976	-0.05
/error-in-render avg req/sec	1235.84	1265.33	+29.49

Client Bundles (main, webpack, commons)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
675-HASH.js gzip	13.8 kB	13.8 kB	✓
770.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	50.7 kB	50.7 kB	✓
main-HASH.js gzip	34.7 kB	34.7 kB	✓
webpack-HASH.js gzip	1.65 kB	1.65 kB	✓
Overall change	101 kB	101 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_app-HASH.js gzip	1.32 kB	1.32 kB	✓
_error-HASH.js gzip	180 B	180 B	✓
amp-HASH.js gzip	315 B	315 B	✓
css-HASH.js gzip	331 B	331 B	✓
dynamic-HASH.js gzip	2.8 kB	2.8 kB	✓
head-HASH.js gzip	356 B	356 B	✓
hooks-HASH.js gzip	637 B	637 B	✓
image-HASH.js gzip	573 B	573 B	✓
index-HASH.js gzip	262 B	262 B	✓
link-HASH.js gzip	2.2 kB	2.2 kB	✓
routerDirect..HASH.js gzip	326 B	326 B	✓
script-HASH.js gzip	393 B	393 B	✓
withRouter-HASH.js gzip	322 B	322 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	10.1 kB	10.1 kB	✓

Client Build Manifests

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
_buildManifest.js gzip	511 B	511 B	✓
Overall change	511 B	511 B	✓

Rendered Page Sizes

	vercel/next.js canary	Dev-CasperTheGhost/next.js feat/custom-tsconfig	Change
index.html gzip	538 B	538 B	✓
link.html gzip	552 B	552 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Commit: 5d2e30f

casperiv0 added 4 commits August 13, 2021 11:38

feat: allow setting custom tsconfig file

c336faf

fix: only warn once

dd6490c

Merge branch 'canary' of https://github.com/vercel/next.js into feat/…

451964e

…custom-tsconfig

docs: add docs for custom tsconfig file

736287c

casperiv0 requested review from huozhi, ijjk, leerob, lfades, padmaia, shuding, styfle and timneutkens as code owners August 14, 2021 06:50

ijjk added type: documentation type: next labels Aug 14, 2021

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

06aebc9

This comment has been minimized.

Sign in to view

Merge branch 'vercel:canary' into feat/custom-tsconfig

27eead4

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

f5c152c

This comment has been minimized.

Sign in to view

Merge branch 'vercel:canary' into feat/custom-tsconfig

67d6072

This comment has been minimized.

Sign in to view

Merge branch 'vercel:canary' into feat/custom-tsconfig

2227f70

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

aa267d0

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

b46a7e4

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/lib/verifyTypeScriptSetup.ts Outdated Show resolved Hide resolved

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/lib/verifyTypeScriptSetup.ts Outdated Show resolved Hide resolved

casperiv0 added 2 commits September 22, 2021 15:55

pass config as param

6c789b6

Merge branch 'feat/custom-tsconfig' of github.com:Dev-CasperTheGhost/…

d256ad7

…next.js into feat/custom-tsconfig

This comment has been minimized.

Sign in to view

styfle reviewed Sep 22, 2021

View reviewed changes

test/integration/typescript-custom-tsconfig/test/index.test.js Show resolved Hide resolved

casperiv0 added 2 commits September 22, 2021 17:40

fix optional typescript config

db196fb

test: add more tests

3502196

casperiv0 requested a review from styfle September 22, 2021 15:56

This comment has been minimized.

Sign in to view

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/build/webpack-config.ts Outdated Show resolved Hide resolved

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/lib/typescript/getTypeScriptIntent.ts Outdated Show resolved Hide resolved

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/lib/verifyTypeScriptSetup.ts Outdated Show resolved Hide resolved

styfle reviewed Sep 22, 2021

View reviewed changes

packages/next/build/index.ts Outdated Show resolved Hide resolved

apply suggestions from code review

47efadb

casperiv0 requested a review from styfle September 22, 2021 16:55

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

a5994e8

styfle approved these changes Sep 22, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

Merge branch 'canary' into feat/custom-tsconfig

83a6efb

Merge branch 'canary' into feat/custom-tsconfig

5d2e30f

kodiakhq bot merged commit 9343b67 into vercel:canary Sep 23, 2021

casperiv0 deleted the feat/custom-tsconfig branch September 24, 2021 03:56

casperiv0 restored the feat/custom-tsconfig branch September 24, 2021 03:57

styfle mentioned this pull request Nov 3, 2021

Allow custom tsconfig path in next.config.js #13747

Closed

vercel locked as resolved and limited conversation to collaborators Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow setting custom tsconfig file #28104

feat: allow setting custom tsconfig file #28104

casperiv0 commented Aug 14, 2021 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

styfle left a comment

This comment has been minimized.

ijjk commented Sep 23, 2021

ijjk commented Sep 23, 2021

ijjk commented Sep 23, 2021

feat: allow setting custom tsconfig file #28104

feat: allow setting custom tsconfig file #28104

Conversation

casperiv0 commented Aug 14, 2021 • edited

Bug

Feature

Documentation / Examples

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

styfle left a comment

Choose a reason for hiding this comment

This comment has been minimized.

ijjk commented Sep 23, 2021

Failing test suites

ijjk commented Sep 23, 2021

Stats from current PR

ijjk commented Sep 23, 2021

Stats from current PR

casperiv0 commented Aug 14, 2021 •

edited