ESLint Plugin: Prevent bad imports of next/document and next/head #24832
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
housseindjirdeh
requested review from
divmain,
ijjk,
lfades,
shuding and
timneutkens
as code owners
housseindjirdeh
changed the title
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.
timneutkens
previously approved these changes
May 10, 2021
This comment has been minimized.
This comment has been minimized.
ijjk
approved these changes
May 10, 2021
Stats from current PRDefault Server Mode (Decrease detected ✓)General
Page Load Tests Overall decrease
|
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 2.663 | 2.682 | |
| / avg req/sec | 938.66 | 932.29 | |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.519 | 1.575 | |
| /error-in-render avg req/sec | 1646.2 | 1586.92 |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| framework-HASH.js gzip | 39.3 kB | 39.3 kB | ✓ |
| main-HASH.js gzip | 19.3 kB | 19.3 kB | ✓ |
| webpack-HASH.js gzip | 994 B | 994 B | ✓ |
| Overall change | 59.6 kB | 59.6 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.1 kB | 31.1 kB | ✓ |
| Overall change | 31.1 kB | 31.1 kB | ✓ |
Client Pages
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.02 kB | 1.02 kB | ✓ |
| _error-HASH.js gzip | 3.05 kB | 3.05 kB | ✓ |
| amp-HASH.js gzip | 526 B | 526 B | ✓ |
| css-HASH.js gzip | 334 B | 334 B | ✓ |
| hooks-HASH.js gzip | 890 B | 890 B | ✓ |
| index-HASH.js gzip | 262 B | 262 B | ✓ |
| link-HASH.js gzip | 1.65 kB | 1.65 kB | ✓ |
| routerDirect..HASH.js gzip | 331 B | 331 B | ✓ |
| withRouter-HASH.js gzip | 329 B | 329 B | ✓ |
| 99a142a5cfae..804.css gzip | 125 B | 125 B | ✓ |
| Overall change | 8.52 kB | 8.52 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 394 B | 394 B | ✓ |
| Overall change | 394 B | 394 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| index.html gzip | 561 B | 561 B | ✓ |
| link.html gzip | 569 B | 569 B | ✓ |
| withRouter.html gzip | 557 B | 557 B | ✓ |
| Overall change | 1.69 kB | 1.69 kB | ✓ |
Serverless Mode (Decrease detected ✓)
General
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| buildDuration | 18.7s | 19.1s | |
| buildDurationCached | 7.1s | 7s | -177ms |
| nodeModulesSize | 46.5 MB | 46.5 MB | ✓ |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| framework-HASH.js gzip | 39.3 kB | 39.3 kB | ✓ |
| main-HASH.js gzip | 19.3 kB | 19.3 kB | ✓ |
| webpack-HASH.js gzip | 994 B | 994 B | ✓ |
| Overall change | 59.6 kB | 59.6 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.1 kB | 31.1 kB | ✓ |
| Overall change | 31.1 kB | 31.1 kB | ✓ |
Client Pages
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.02 kB | 1.02 kB | ✓ |
| _error-HASH.js gzip | 3.05 kB | 3.05 kB | ✓ |
| amp-HASH.js gzip | 526 B | 526 B | ✓ |
| css-HASH.js gzip | 334 B | 334 B | ✓ |
| hooks-HASH.js gzip | 890 B | 890 B | ✓ |
| index-HASH.js gzip | 262 B | 262 B | ✓ |
| link-HASH.js gzip | 1.65 kB | 1.65 kB | ✓ |
| routerDirect..HASH.js gzip | 331 B | 331 B | ✓ |
| withRouter-HASH.js gzip | 329 B | 329 B | ✓ |
| 99a142a5cfae..804.css gzip | 125 B | 125 B | ✓ |
| Overall change | 8.52 kB | 8.52 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 394 B | 394 B | ✓ |
| Overall change | 394 B | 394 B | ✓ |
Serverless bundles Overall decrease ✓
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _error.js | 1.34 MB | 1.34 MB | ✓ |
| 404.html | 2.42 kB | 2.42 kB | ✓ |
| 500.html | 2.41 kB | 2.41 kB | ✓ |
| amp.amp.html | 10.8 kB | 10.8 kB | ✓ |
| amp.html | 1.61 kB | 1.61 kB | ✓ |
| css.html | 1.79 kB | 1.79 kB | ✓ |
| hooks.html | 1.67 kB | 1.67 kB | ✓ |
| index.js | 1.34 MB | 1.34 MB | ✓ |
| link.js | 1.4 MB | 1.4 MB | ✓ |
| routerDirect.js | 1.39 MB | 1.39 MB | -2 B |
| withRouter.js | 1.39 MB | 1.39 MB | ✓ |
| Overall change | 6.9 MB | 6.9 MB | -2 B |
Webpack 4 Mode (Increase detected ⚠️ )
General
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| buildDuration | 13.2s | 13.2s | |
| buildDurationCached | 5.4s | 5.4s | -36ms |
| nodeModulesSize | 46.5 MB | 46.5 MB | ✓ |
Page Load Tests Overall increase ✓
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| / failed reqs | 0 | 0 | ✓ |
| / total time (seconds) | 2.7 | 2.723 | |
| / avg req/sec | 925.77 | 918.02 | |
| /error-in-render failed reqs | 0 | 0 | ✓ |
| /error-in-render total time (seconds) | 1.553 | 1.513 | -0.04 |
| /error-in-render avg req/sec | 1610.05 | 1652.35 | +42.3 |
Client Bundles (main, webpack, commons)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| 677f882d2ed8..HASH.js gzip | 13.3 kB | 13.3 kB | ✓ |
| framework.HASH.js gzip | 39 kB | 39 kB | ✓ |
| main-HASH.js gzip | 7.19 kB | 7.19 kB | ✓ |
| webpack-HASH.js gzip | 751 B | 751 B | ✓ |
| Overall change | 60.2 kB | 60.2 kB | ✓ |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 31.3 kB | 31.3 kB | ✓ |
| Overall change | 31.3 kB | 31.3 kB | ✓ |
Client Pages
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 1.28 kB | 1.28 kB | ✓ |
| _error-HASH.js gzip | 3.72 kB | 3.72 kB | ✓ |
| amp-HASH.js gzip | 536 B | 536 B | ✓ |
| css-HASH.js gzip | 339 B | 339 B | ✓ |
| hooks-HASH.js gzip | 887 B | 887 B | ✓ |
| index-HASH.js gzip | 227 B | 227 B | ✓ |
| link-HASH.js gzip | 1.64 kB | 1.64 kB | ✓ |
| routerDirect..HASH.js gzip | 303 B | 303 B | ✓ |
| withRouter-HASH.js gzip | 302 B | 302 B | ✓ |
| 21c68fa65a48..217.css gzip | 125 B | 125 B | ✓ |
| Overall change | 9.37 kB | 9.37 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 420 B | 420 B | ✓ |
| Overall change | 420 B | 420 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | housseindjirdeh/next.js document-import-rules-eslint | Change | |
|---|---|---|---|
| index.html gzip | 614 B | 614 B | ✓ |
| link.html gzip | 619 B | 619 B | ✓ |
| withRouter.html gzip | 607 B | 607 B | ✓ |
| Overall change | 1.84 kB | 1.84 kB | ✓ |
flybayer
pushed a commit
to blitz-js/next.js
that referenced
this pull request
Jun 1, 2021
…rcel#24832) Adds lint rules to the Next.js ESLint plugin to: - Disallow importing `next/head` inside `pages/_document.js` - Disallow importing `next/document` outside of `pages/_document.js` Both rules will be surfaced as **errors** within the recommended config of the plugin. Fixes vercel#13712 vercel#13958
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds lint rules to the Next.js ESLint plugin to:
next/headinsidepages/_document.jsnext/documentoutside ofpages/_document.jsBoth rules will be surfaced as errors within the recommended config of the plugin.
Fixes #13712 #13958