Add JSDoc to config options

[mohsen1]

Since the config file is now typed with TypeScript types we can add JSDoc to the config to make it a better DX.

I'm not sure how this is the right approach. There is a lot of copy-pasting from the documentation files. I wonder if it's worth building an automation pipeline for printing those documentations into the JSDoc.

Before completing this work I would like to see what everyone thinks about this?

[mohsen1]

@timneutkens thoughts?

[ijjk]

Hi, it sounds good to add JSDoc comments to the config here although these snippets are a bit verbose. Could we shorten these to keep them more minimal?

[mohsen1]

Address typo and accept suggestions

[ijjk]

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
buildDuration	14.8s	15.4s	⚠️ +585ms
buildDurationCached	5.7s	6s	⚠️ +301ms
nodeModulesSize	359 MB	359 MB	⚠️ +9.07 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.018	2.915	-0.1
/ avg req/sec	828.3	857.54	+29.24
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.256	1.374	⚠️ +0.12
/error-in-render avg req/sec	1990.91	1819.11	⚠️ -171.8

Client Bundles (main, webpack, commons)

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	27.4 kB	27.4 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.2 kB	71.2 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	326 B	326 B	✓
dynamic-HASH.js gzip	2.37 kB	2.37 kB	✓
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	919 B	919 B	✓
image-HASH.js gzip	4.94 kB	4.94 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.19 kB	2.19 kB	✓
routerDirect..HASH.js gzip	321 B	321 B	✓
script-HASH.js gzip	383 B	383 B	✓
withRouter-HASH.js gzip	318 B	318 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.3 kB	14.3 kB	✓

Client Build Manifests

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
index.html gzip	532 B	532 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

---

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
buildDuration	17.9s	18.3s	⚠️ +315ms
buildDurationCached	5.7s	5.7s	⚠️ +53ms
nodeModulesSize	359 MB	359 MB	⚠️ +9.07 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.197	3.138	-0.06
/ avg req/sec	782.04	796.56	+14.52
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.337	1.263	-0.07
/error-in-render avg req/sec	1869.39	1979.09	+109.7

Client Bundles (main, webpack, commons)

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	27.4 kB	27.4 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.3 kB	71.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	180 B	180 B	✓
amp-HASH.js gzip	305 B	305 B	✓
css-HASH.js gzip	321 B	321 B	✓
dynamic-HASH.js gzip	2.36 kB	2.36 kB	✓
head-HASH.js gzip	342 B	342 B	✓
hooks-HASH.js gzip	911 B	911 B	✓
image-HASH.js gzip	4.97 kB	4.97 kB	✓
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	2.21 kB	2.21 kB	✓
routerDirect..HASH.js gzip	314 B	314 B	✓
script-HASH.js gzip	375 B	375 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.3 kB	14.3 kB	✓

Client Build Manifests

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	mohsen1/next.js add-jsdoc-to-config	Change
index.html gzip	533 B	533 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	528 B	528 B	✓
Overall change	1.61 kB	1.61 kB	✓

Commit: 9d8fbbf

[ijjk]

Thanks for the PR!