Fix `next lint` no-document-import-in-page on Windows #28745

styfle · 2021-09-02T20:13:12Z

ijjk · 2021-09-02T20:24:47Z

Stats from current PR

Default Build (Decrease detected ✓)

General

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
buildDuration	13.6s	13.5s	-141ms
buildDurationCached	3.5s	3.5s	-30ms
nodeModulesSize	49.1 MB	49.1 MB	✓

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.602	2.679	⚠️ +0.08
/ avg req/sec	960.77	933.3	⚠️ -27.47
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.439	1.46	⚠️ +0.02
/error-in-render avg req/sec	1737.14	1711.93	⚠️ -25.21

Client Bundles (main, webpack, commons)

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.3 kB	23.3 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	67.2 kB	67.2 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
_app-HASH.js gzip	979 B	979 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	329 B	329 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	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	318 B	318 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
_buildManifest.js gzip	492 B	492 B	✓
Overall change	492 B	492 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
index.html gzip	539 B	539 B	✓
link.html gzip	552 B	552 B	✓
withRouter.html gzip	532 B	532 B	✓
Overall change	1.62 kB	1.62 kB	✓

Webpack 4 Mode (Increase detected ⚠️)

General

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
buildDuration	11s	11.2s	⚠️ +223ms
buildDurationCached	4.7s	4.6s	-10ms
nodeModulesSize	49.1 MB	49.1 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.659	2.606	-0.05
/ avg req/sec	940.27	959.18	+18.91
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.446	1.425	-0.02
/error-in-render avg req/sec	1728.99	1754.74	+25.75

Client Bundles (main, webpack, commons)

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
16.HASH.js gzip	186 B	186 B	✓
677f882d2ed8..HASH.js gzip	14.1 kB	14.1 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.7 kB	10.7 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	68.1 kB	68.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
_app-HASH.js gzip	964 B	964 B	✓
_error-HASH.js gzip	3.8 kB	3.8 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.87 kB	2.87 kB	✓
head-HASH.js gzip	3.06 kB	3.06 kB	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	3.03 kB	3.03 kB	✓
withRouter-HASH.js gzip	295 B	295 B	✓
30809af5c834..565.css gzip	125 B	125 B	✓
Overall change	18.1 kB	18.1 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js fix-windows-next-lint-no-document	Change
index.html gzip	584 B	584 B	✓
link.html gzip	597 B	597 B	✓
withRouter.html gzip	579 B	579 B	✓
Overall change	1.76 kB	1.76 kB	✓

Commit: 004d8e7

kimbaudi · 2021-09-02T20:59:47Z

packages/eslint-plugin-next/lib/rules/no-document-import-in-page.js

+        if (
+          !page ||
+          page.startsWith('/_document') ||
+          page.startsWith('\\_document')


can we use path.sep and path.posix.sep instead of literal slashes?

page.startsWith(`${path.sep}_document`) || page.startsWith(`${path.posix.sep}_document`)

Ah good call! Submitted #28768 for this

fullstacksk · 2021-10-06T10:04:15Z

"rules": { "@next/next/no-document-import-in-page": "off" }
Include it in your .eslintrc.json file, if u don't want wanna update anything.
It worked for me.

- Add the prettier extends so it runs as part of the linting - Bump eslint-plugin-next for a Windows only issue vercel/next.js#28745

- Upgrade to Next.js 12 - Add the prettier extends so it runs as part of the linting - Bump eslint-plugin-next for a Windows only issue vercel/next.js#28745

Fix windows no-document-import-in-page

004d8e7

styfle requested review from housseindjirdeh and samcx September 2, 2021 20:13

styfle requested review from huozhi, ijjk, padmaia, shuding and timneutkens as code owners September 2, 2021 20:13

ijjk added the created-by: Next.js team PRs by the Next.js team label Sep 2, 2021

styfle changed the title ~~Fix windows no-document-import-in-page~~ Fix next lint no-document-import-in-page on Windows Sep 2, 2021

styfle requested a review from CatsAreMLG September 2, 2021 20:15

ijjk approved these changes Sep 2, 2021

View reviewed changes

housseindjirdeh approved these changes Sep 2, 2021

View reviewed changes

kodiakhq bot merged commit 9bbba98 into canary Sep 2, 2021

kodiakhq bot deleted the fix-windows-next-lint-no-document branch September 2, 2021 20:51

kimbaudi reviewed Sep 2, 2021

View reviewed changes

akd-io mentioned this pull request Sep 3, 2021

False positive for no-document-import-in-page #28596

Closed

ristomatti mentioned this pull request Sep 10, 2021

pages/_document.js throwing no-document-import-in-page #28971

Closed

HarunOr mentioned this pull request Oct 20, 2021

Added support for 'next export' styxlab/next-cms-ghost#131

Merged

nschonni added a commit to nschonni/giscus that referenced this pull request Nov 6, 2021

chore: Update ESLint Prettier and Next

a82eff7

- Add the prettier extends so it runs as part of the linting - Bump eslint-plugin-next for a Windows only issue vercel/next.js#28745

nschonni mentioned this pull request Nov 6, 2021

chore: Update dependencies giscus/giscus#217

Merged

laymonage pushed a commit to nschonni/giscus that referenced this pull request Nov 6, 2021

chore: Update dependencies

815b685

- Upgrade to Next.js 12 - Add the prettier extends so it runs as part of the linting - Bump eslint-plugin-next for a Windows only issue vercel/next.js#28745

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

Fix `next lint` no-document-import-in-page on Windows #28745

Fix `next lint` no-document-import-in-page on Windows #28745

styfle commented Sep 2, 2021

ijjk commented Sep 2, 2021

kimbaudi Sep 2, 2021

housseindjirdeh Sep 3, 2021

fullstacksk commented Oct 6, 2021

Fix next lint no-document-import-in-page on Windows #28745

Fix next lint no-document-import-in-page on Windows #28745

Conversation

styfle commented Sep 2, 2021

ijjk commented Sep 2, 2021

Stats from current PR

kimbaudi Sep 2, 2021

Choose a reason for hiding this comment

housseindjirdeh Sep 3, 2021

Choose a reason for hiding this comment

fullstacksk commented Oct 6, 2021

Fix `next lint` no-document-import-in-page on Windows #28745

Fix `next lint` no-document-import-in-page on Windows #28745