[eslint-plugin-next] [no-html-link-for-pages]: Allow multiple page directories

[tobilen]

In the current implementation of no-html-link-for-pages, when specifying a custom pages directory, we are restricted to a single file path. This is problematic when working in monorepos.

This PR adds a backwards compatible check to either pass a string (current behavior) or an array (new behavior) to the no-html-link-for-pages rule.

Example:

{
  rules: {
    "@next/next/no-html-link-for-pages": [
      "error",
      [
        path.join(__dirname, "packages", "app1", "pages"),
        path.join(__dirname, "packages", "app2", "pages"),
      ],
    ],
  }
}

The base branch was changed.

[ijjk]

Stats from current PR

Default Build (Increase detected ⚠️)

General

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
buildDuration	16s	16.3s	⚠️ +325ms
buildDurationCached	3.9s	3.6s	-253ms
nodeModulesSize	49.5 MB	49.5 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.716	2.686	-0.03
/ avg req/sec	920.47	930.65	+10.18
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.664	1.626	-0.04
/error-in-render avg req/sec	1502.73	1537.78	+35.05

Client Bundles (main, webpack, commons)

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
359.HASH.js gzip	2.96 kB	2.96 kB	✓
745.HASH.js gzip	180 B	180 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	20.9 kB	20.9 kB	✓
webpack-HASH.js gzip	1.53 kB	1.53 kB	✓
Overall change	67.8 kB	67.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	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	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
_app-HASH.js gzip	803 B	803 B	✓
_error-HASH.js gzip	3.06 kB	3.06 kB	✓
amp-HASH.js gzip	554 B	554 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.52 kB	2.52 kB	✓
head-HASH.js gzip	2.28 kB	2.28 kB	✓
hooks-HASH.js gzip	903 B	903 B	✓
image-HASH.js gzip	5.6 kB	5.6 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	319 B	319 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	19.1 kB	19.1 kB	✓

Client Build Manifests

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
_buildManifest.js gzip	489 B	489 B	✓
Overall change	489 B	489 B	✓

Rendered Page Sizes

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
index.html gzip	530 B	530 B	✓
link.html gzip	544 B	544 B	✓
withRouter.html gzip	524 B	524 B	✓
Overall change	1.6 kB	1.6 kB	✓

---

Webpack 4 Mode (Increase detected ⚠️)

General

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
buildDuration	13.2s	12.8s	-441ms
buildDurationCached	5s	4.9s	-91ms
nodeModulesSize	49.5 MB	49.5 MB	✓

Page Load Tests Overall increase ✓

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.634	2.823	⚠️ +0.19
/ avg req/sec	949.1	885.46	⚠️ -63.64
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.628	1.542	-0.09
/error-in-render avg req/sec	1535.61	1621.24	+85.63

Client Bundles (main, webpack, commons)

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
17.HASH.js gzip	2.98 kB	2.98 kB	✓
18.HASH.js gzip	185 B	185 B	✓
677f882d2ed8..HASH.js gzip	13.7 kB	13.7 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	8.4 kB	8.4 kB	✓
webpack-HASH.js gzip	1.22 kB	1.22 kB	✓
Overall change	68.4 kB	68.4 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	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	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
_app-HASH.js gzip	791 B	791 B	✓
_error-HASH.js gzip	3.76 kB	3.76 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.71 kB	2.71 kB	✓
head-HASH.js gzip	2.97 kB	2.97 kB	✓
hooks-HASH.js gzip	911 B	911 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.02 kB	3.02 kB	✓
withRouter-HASH.js gzip	294 B	294 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	17.6 kB	17.6 kB	✓

Client Build Manifests

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes

	vercel/next.js canary	tobilen/next.js feat/eslint-plugin-next-allow-multiple-page-dirs	Change
index.html gzip	577 B	577 B	✓
link.html gzip	588 B	588 B	✓
withRouter.html gzip	569 B	569 B	✓
Overall change	1.73 kB	1.73 kB	✓

Commit: eba89f6