chore: Add Alex to lint documentation #26354

petermekhaeil · 2021-06-19T04:44:43Z

This Pull Request adds Alex to our documentation. It catches insensitive, inconsiderate writing.

The original PR (#25821) is too large so I have decided to break it down into smaller PRs. This PR is the first part. Then I will continue to add the rest of the documentation in smaller PRs.

More Information on Alex:

https://alexjs.com/
https://github.com/get-alex/alex

Documentation / Examples

Make sure the linting passes

timneutkens

Looks good to land, thanks for breaking up the PR in smaller pieces 👍

ijjk · 2021-06-22T09:42:10Z

Failing test suites

Commit: 6e3aa04

test/integration/basic/test/index.test.js

Basic Features > should polyfill Node.js modules

Expand output

● Basic Features › should polyfill Node.js modules

thrown: "Exceeded timeout of 300000 ms for a test.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

  35 |   afterAll(() => killApp(context.server))
  36 |
> 37 |   it('should polyfill Node.js modules', async () => {
     |   ^
  38 |     const browser = await webdriver(context.appPort, '/node-browser-polyfills')
  39 |
  40 |     console.error({

  at integration/basic/test/index.test.js:37:3
  at Object.<anonymous> (integration/basic/test/index.test.js:18:1)

ijjk · 2021-06-22T15:30:49Z

Stats from current PR

Default Server Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
buildDuration	11.4s	11.4s	⚠️ +24ms
buildDurationCached	2.8s	2.7s	-78ms
nodeModulesSize	49.2 MB	49.2 MB	⚠️ +1.5 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.018	2.053	⚠️ +0.04
/ avg req/sec	1238.6	1217.57	⚠️ -21.03
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.17	1.11	-0.06
/error-in-render avg req/sec	2135.89	2251.44	+115.55

Client Bundles (main, webpack, commons)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	20.2 kB	20.2 kB	✓
webpack-HASH.js gzip	810 B	810 B	✓
Overall change	63 kB	63 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	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	petermekhaeil/next.js alex-language-setup	Change
_app-HASH.js gzip	801 B	801 B	✓
_error-HASH.js gzip	3.17 kB	3.17 kB	✓
amp-HASH.js gzip	527 B	527 B	✓
css-HASH.js gzip	330 B	330 B	✓
hooks-HASH.js gzip	903 B	903 B	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	1.65 kB	1.65 kB	✓
routerDirect..HASH.js gzip	322 B	322 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	8.41 kB	8.41 kB	✓

Client Build Manifests

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
_buildManifest.js gzip	392 B	392 B	✓
Overall change	392 B	392 B	✓

Rendered Page Sizes

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
index.html gzip	522 B	522 B	✓
link.html gzip	533 B	533 B	✓
withRouter.html gzip	517 B	517 B	✓
Overall change	1.57 kB	1.57 kB	✓

Serverless Mode (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
buildDuration	12.9s	12.8s	-58ms
buildDurationCached	3.8s	3.8s	⚠️ +1ms
nodeModulesSize	49.2 MB	49.2 MB	⚠️ +1.5 kB

Client Bundles (main, webpack, commons)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	20.2 kB	20.2 kB	✓
webpack-HASH.js gzip	810 B	810 B	✓
Overall change	63 kB	63 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	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	petermekhaeil/next.js alex-language-setup	Change
_app-HASH.js gzip	801 B	801 B	✓
_error-HASH.js gzip	3.17 kB	3.17 kB	✓
amp-HASH.js gzip	527 B	527 B	✓
css-HASH.js gzip	330 B	330 B	✓
hooks-HASH.js gzip	903 B	903 B	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	1.65 kB	1.65 kB	✓
routerDirect..HASH.js gzip	322 B	322 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	8.41 kB	8.41 kB	✓

Client Build Manifests

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
_buildManifest.js gzip	392 B	392 B	✓
Overall change	392 B	392 B	✓

Serverless bundles Overall decrease ✓

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
_error.js	16.9 kB	16.9 kB	✓
404.html	1.98 kB	1.98 kB	✓
500.html	1.96 kB	1.96 kB	✓
amp.amp.html	10.8 kB	10.8 kB	✓
amp.html	1.17 kB	1.17 kB	✓
css.html	1.35 kB	1.35 kB	✓
hooks.html	1.23 kB	1.23 kB	✓
index.js	17.2 kB	17.2 kB	-2 B
link.js	17.5 kB	17.5 kB	✓
routerDirect.js	17.3 kB	17.3 kB	✓
withRouter.js	17.3 kB	17.3 kB	✓
Overall change	105 kB	105 kB	-2 B

Webpack 4 Mode (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
buildDuration	10.1s	10.3s	⚠️ +239ms
buildDurationCached	4.1s	4s	-56ms
nodeModulesSize	49.2 MB	49.2 MB	⚠️ +1.5 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.038	2.015	-0.02
/ avg req/sec	1226.49	1240.89	+14.4
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.153	1.169	⚠️ +0.02
/error-in-render avg req/sec	2167.84	2139.1	⚠️ -28.74

Client Bundles (main, webpack, commons)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
677f882d2ed8..HASH.js gzip	13.3 kB	13.3 kB	✓
framework.HASH.js gzip	41.8 kB	41.8 kB	✓
main-HASH.js gzip	7.99 kB	7.99 kB	✓
webpack-HASH.js gzip	757 B	757 B	✓
Overall change	63.8 kB	63.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	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	petermekhaeil/next.js alex-language-setup	Change
_app-HASH.js gzip	1.07 kB	1.07 kB	✓
_error-HASH.js gzip	3.84 kB	3.84 kB	✓
amp-HASH.js gzip	536 B	536 B	✓
css-HASH.js gzip	333 B	333 B	✓
hooks-HASH.js gzip	910 B	910 B	✓
index-HASH.js gzip	227 B	227 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	295 B	295 B	✓
withRouter-HASH.js gzip	292 B	292 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	9.28 kB	9.28 kB	✓

Client Build Manifests

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
_buildManifest.js gzip	420 B	420 B	✓
Overall change	420 B	420 B	✓

Rendered Page Sizes

	vercel/next.js canary	petermekhaeil/next.js alex-language-setup	Change
index.html gzip	568 B	568 B	✓
link.html gzip	581 B	581 B	✓
withRouter.html gzip	560 B	560 B	✓
Overall change	1.71 kB	1.71 kB	✓

Commit: 3c105e3

This Pull Request adds [Alex](https://alexjs.com/) to our documentation. It catches insensitive, inconsiderate writing. The original PR (vercel#25821) is too large so I have decided to break it down into smaller PRs. This PR is the first part. Then I will continue to add the rest of the documentation in smaller PRs. ## More Information on Alex: https://alexjs.com/ https://github.com/get-alex/alex ## Documentation / Examples - [x] Make sure the linting passes

v11.0.1 * tag 'v11.0.1': (374 commits) v11.0.1 v11.0.1-canary.8 Ensure image-types file is included (vercel#26495) Strongly type `Router.events.on` and `Router.events.off` (vercel#26456) v11.0.1-canary.7 Update i18n fields in docs (vercel#26492) Update to only add image import types when enabled (vercel#26485) Fix domain locales not available on client (vercel#26083) chore: Add Alex to lint documentation (vercel#26354) fix: ignore invalid accept-language header (vercel#26476) Add module.exports to security headers documentation (vercel#26466) (examples/with-webassembly) fixed for webpack 5 (vercel#26440) Add check for startLatency in fast refresh (vercel#26417) v11.0.1-canary.6 docs(router.md) Add note about page state and navigation (vercel#26320) Remove period for ESLint `passHref` docs link. (vercel#26402) Update with-eslint example. (vercel#25817) Docs: Add Prettier section on ESLint page (vercel#26347) add missing closing bracket (vercel#26375) Improve the `next/script` documentation. (vercel#26325) ...

chore: Add Alex to lint documentation

5403e9e

petermekhaeil requested review from divmain, ijjk, lfades, shuding and timneutkens as code owners June 19, 2021 04:44

ijjk added the create-next-app Related to our CLI tool for quickly starting a new Next.js application. label Jun 19, 2021

timneutkens previously approved these changes Jun 21, 2021

View reviewed changes

Merge branch 'canary' into alex-language-setup

779b4c6

This comment has been minimized.

Sign in to view

petermekhaeil and others added 2 commits June 21, 2021 21:02

Merge branch 'canary' into alex-language-setup

43d66be

Merge branch 'canary' into alex-language-setup

a500dbd

This comment has been minimized.

Sign in to view

petermekhaeil and others added 2 commits June 22, 2021 11:50

Merge branch 'canary' into alex-language-setup

2ac8c5c

Merge branch 'canary' into alex-language-setup

6e3aa04

This comment has been minimized.

Sign in to view

Update precompiled

37310d1

timneutkens dismissed their stale review via 37310d1 June 22, 2021 11:17

ijjk added the type: next label Jun 22, 2021

timneutkens approved these changes Jun 22, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

Merge branch 'canary' into alex-language-setup

3c105e3

kodiakhq bot merged commit 005a6e4 into vercel:canary Jun 22, 2021

petermekhaeil mentioned this pull request Jun 23, 2021

chore: Enable Alex documentation linting for error pages #26526

Merged

1 task

sync-by-unito bot mentioned this pull request Jun 23, 2021

chore(deps): bump next from 10.1.2 to 11.0.1 filecoin-project/slate#799

Closed

petermekhaeil mentioned this pull request Jun 25, 2021

Enable Alex documentation linting for docs #26598

Merged

1 task

snyk-bot mentioned this pull request Jul 30, 2021

[Snyk] Upgrade next from 9.4.1 to 11.0.1 Mement-Mori/next.js#7

Open

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Add Alex to lint documentation #26354

chore: Add Alex to lint documentation #26354

petermekhaeil commented Jun 19, 2021

timneutkens left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Jun 22, 2021

This comment has been minimized.

ijjk commented Jun 22, 2021

chore: Add Alex to lint documentation #26354

chore: Add Alex to lint documentation #26354

Conversation

petermekhaeil commented Jun 19, 2021

More Information on Alex:

Documentation / Examples

timneutkens left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Jun 22, 2021

Failing test suites

This comment has been minimized.

ijjk commented Jun 22, 2021

Stats from current PR