ESLint Updates #25895

housseindjirdeh · 2021-06-08T14:50:09Z

ESLint updates per review comments on #24900

Documentation updates
--no-lint command line flag has been "removed" in place of an next.config.js flag ({ eslint: ignoreDuringBuilds })
- --no-lint command is still present but has been removed from docs, etc... It's currently being used in the PnP test script to not fail on build because of missing ESLint deps
When checks successfully pass for next lint, a new success message is shown:
"Need to disable some rules?" message is added at the end of the ESLint output
pages, components, and lib directories are all now linted by default and an additional flag has been added to next.config.js to modify which directories to lint during production builds:
```
module.exports = {
  eslint: {
    dirs: ['pages', 'components'] // Only run ESLint on pages and components directories during builds
  }
}
```

docs/api-reference/next.config.js/ignoring-eslint.md

leerob · 2021-06-08T15:08:15Z

docs/basic-features/eslint.md


 ## Linting Custom Directories

-By default, Next.js will only run ESLint for all files in the `pages/` directory. However, you can specify other custom directories to run by using the `--dir` flag in `next lint`:
+By default, Next.js will run ESLint for all files in the `pages/`, `components/`, and `lib/` directories. However, you can specify other custom directories to run by using the `--dir` flag in `next lint`:


Is there a way to change these defaults? E.g. maybe I don't want lib. Could be follow up later 😄

Just added the option to configure this via next.config.js:

module.exports = { eslint: { dirs: ['pages', 'components'] // Only run ESLint on pages and components directories during builds } }

f57a046#diff-ea22ff5b8d78b521a09affbcc239809dc95143cda0370d9992420ab86172ea58

timneutkens · 2021-06-08T15:41:13Z

docs/basic-features/eslint.md

@@ -7,13 +7,13 @@ description: Next.js provides an integrated ESLint experience by default. These
 Since version **11.0.0**, Next.js provides an integrated [ESLint](https://eslint.org/) experience out of the box. To get started, run `next lint`:

 ```bash
-next lint
+npx next lint


Ideally I'd want to recommend npm run lint or yarn run lint to ensure it's always using the Next.js version that is installed in the project. This would mean we'd create a project with "lint": "next lint" in scripts as well

Ah good point, updated!

docs/basic-features/eslint.md

ijjk · 2021-06-08T19:31:59Z

packages/next/lib/has-necessary-dependencies.ts

-          : '')
+          ? `remove the ${chalk.bold('eslintConfig')} field from package.json`
+          : '') +
+        ' or disable it in next.config.js.\n\nSee https://nextjs.org/docs/api-reference/next.config.js/ignoring-eslint.'


Should we only recommend this config option instead of recommending deleting the configuration? Would make it easier to toggle removing a bad config from editing right away.

Yeah that probably makes sense (I only recently added that config option)

Fixed here: #25917

# Conflicts: # packages/next/lib/eslint/runLintCheck.ts

ijjk · 2021-06-08T22:19:42Z

Stats from current PR

Default Server Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
buildDuration	14.8s	14.6s	-136ms
buildDurationCached	3.6s	3.6s	⚠️ +51ms
nodeModulesSize	46.5 MB	46.5 MB	⚠️ +2.39 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.143	3.009	-0.13
/ avg req/sec	795.48	830.75	+35.27
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.918	1.92	0
/error-in-render avg req/sec	1303.46	1302.02	⚠️ -1.44

Client Bundles (main, webpack, commons)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	20.2 kB	20.2 kB	✓
webpack-HASH.js gzip	804 B	804 B	✓
Overall change	60.3 kB	60.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	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 eslint-updates	Change
_app-HASH.js gzip	801 B	801 B	✓
_error-HASH.js gzip	3.07 kB	3.07 kB	✓
amp-HASH.js gzip	527 B	527 B	✓
css-HASH.js gzip	334 B	334 B	✓
hooks-HASH.js gzip	890 B	890 B	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	333 B	333 B	✓
withRouter-HASH.js gzip	330 B	330 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	8.31 kB	8.31 kB	✓

Client Build Manifests

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
_buildManifest.js gzip	392 B	392 B	✓
Overall change	392 B	392 B	✓

Rendered Page Sizes

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
index.html gzip	573 B	573 B	✓
link.html gzip	580 B	580 B	✓
withRouter.html gzip	567 B	567 B	✓
Overall change	1.72 kB	1.72 kB	✓

Serverless Mode

General Overall increase ⚠️

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
buildDuration	16.6s	16.6s	-19ms
buildDurationCached	4.8s	4.8s	-17ms
nodeModulesSize	46.5 MB	46.5 MB	⚠️ +2.39 kB

Client Bundles (main, webpack, commons)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	20.2 kB	20.2 kB	✓
webpack-HASH.js gzip	804 B	804 B	✓
Overall change	60.3 kB	60.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	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 eslint-updates	Change
_app-HASH.js gzip	801 B	801 B	✓
_error-HASH.js gzip	3.07 kB	3.07 kB	✓
amp-HASH.js gzip	527 B	527 B	✓
css-HASH.js gzip	334 B	334 B	✓
hooks-HASH.js gzip	890 B	890 B	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	333 B	333 B	✓
withRouter-HASH.js gzip	330 B	330 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	8.31 kB	8.31 kB	✓

Client Build Manifests

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
_buildManifest.js gzip	392 B	392 B	✓
Overall change	392 B	392 B	✓

Serverless bundles

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
_error.js	16.9 kB	16.9 kB	✓
404.html	2.44 kB	2.44 kB	✓
500.html	2.43 kB	2.43 kB	✓
amp.amp.html	10.8 kB	10.8 kB	✓
amp.html	1.63 kB	1.63 kB	✓
css.html	1.81 kB	1.81 kB	✓
hooks.html	1.69 kB	1.69 kB	✓
index.js	17.2 kB	17.2 kB	✓
link.js	17.4 kB	17.4 kB	✓
routerDirect.js	17.4 kB	17.4 kB	✓
withRouter.js	17.4 kB	17.4 kB	✓
Overall change	107 kB	107 kB	✓

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
buildDuration	12.6s	12.8s	⚠️ +144ms
buildDurationCached	5.3s	5.3s	⚠️ +7ms
nodeModulesSize	46.5 MB	46.5 MB	⚠️ +2.39 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.046	3.099	⚠️ +0.05
/ avg req/sec	820.74	806.79	⚠️ -13.95
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.909	1.842	-0.07
/error-in-render avg req/sec	1309.82	1357.16	+47.34

Client Bundles (main, webpack, commons)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
677f882d2ed8..HASH.js gzip	13.4 kB	13.4 kB	✓
framework.HASH.js gzip	39 kB	39 kB	✓
main-HASH.js gzip	7.99 kB	7.99 kB	✓
webpack-HASH.js gzip	751 B	751 B	✓
Overall change	61.1 kB	61.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	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 eslint-updates	Change
_app-HASH.js gzip	1.07 kB	1.07 kB	✓
_error-HASH.js gzip	3.74 kB	3.74 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.63 kB	1.63 kB	✓
routerDirect..HASH.js gzip	303 B	303 B	✓
withRouter-HASH.js gzip	302 B	302 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	9.17 kB	9.17 kB	✓

Client Build Manifests

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
_buildManifest.js gzip	420 B	420 B	✓
Overall change	420 B	420 B	✓

Rendered Page Sizes

	vercel/next.js canary	housseindjirdeh/next.js eslint-updates	Change
index.html gzip	625 B	625 B	✓
link.html gzip	632 B	632 B	✓
withRouter.html gzip	620 B	620 B	✓
Overall change	1.88 kB	1.88 kB	✓

Commit: 4ec4712

Fix per review comment on [#25895](#25895 (comment))

leodr · 2021-06-09T06:39:26Z

Since src/pages is also a valid location for pages, should the src directory also be linted by default?

* lots of eslint updates * adds eslint: dirs flag to next.config.js * update lint command in docs * update per review comments * re-add --no-lint command for build * Apply suggestions from code review Co-authored-by: JJ Kasper <jj@jjsweb.site>

Fix per review comment on [vercel#25895](vercel#25895 (comment))

lots of eslint updates

fe51e9a

housseindjirdeh requested review from divmain, ijjk, leerob, lfades, shuding and timneutkens as code owners June 8, 2021 14:50

ijjk added type: documentation type: next labels Jun 8, 2021

leerob reviewed Jun 8, 2021

View reviewed changes

timneutkens reviewed Jun 8, 2021

View reviewed changes

housseindjirdeh and others added 5 commits June 8, 2021 12:29

adds eslint: dirs flag to next.config.js

f57a046

update lint command in docs

cac5e34

update per review comments

99a5d98

re-add --no-lint command for build

5ba73c4

Merge branch 'canary' into eslint-updates

7a44eba

This comment has been minimized.

Sign in to view

ijjk reviewed Jun 8, 2021

View reviewed changes

docs/basic-features/eslint.md Outdated Show resolved Hide resolved

ijjk reviewed Jun 8, 2021

View reviewed changes

ijjk requested a review from leerob June 8, 2021 20:33

ijjk added 2 commits June 8, 2021 17:05

Apply suggestions from code review

5087997

Merge remote-tracking branch 'upstream/canary' into eslint-updates

4ec4712

# Conflicts: # packages/next/lib/eslint/runLintCheck.ts

ijjk approved these changes Jun 8, 2021

View reviewed changes

ijjk merged commit 50a36ee into vercel:canary Jun 8, 2021

housseindjirdeh mentioned this pull request Jun 9, 2021

ESLint: Updates disable ESLint message during builds #25917

Merged

kodiakhq bot pushed a commit that referenced this pull request Jun 9, 2021

ESLint: Updates disable ESLint message during builds (#25917)

90c6443

Fix per review comment on [#25895](#25895 (comment))

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

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

Closed

flybayer pushed a commit to blitz-js/next.js that referenced this pull request Jun 16, 2021

ESLint: Updates disable ESLint message during builds (vercel#25917)

c55fc9a

Fix per review comment on [vercel#25895](vercel#25895 (comment))

michalbundyra mentioned this pull request Jun 20, 2021

ESLint does not use custom directories from next.config.js #26393

Closed

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

ESLint Updates #25895

ESLint Updates #25895

housseindjirdeh commented Jun 8, 2021 •

edited

leerob Jun 8, 2021

housseindjirdeh Jun 8, 2021

timneutkens Jun 8, 2021

housseindjirdeh Jun 8, 2021

This comment has been minimized.

ijjk Jun 8, 2021

housseindjirdeh Jun 9, 2021

ijjk commented Jun 8, 2021

leodr commented Jun 9, 2021

ESLint Updates #25895

ESLint Updates #25895

Conversation

housseindjirdeh commented Jun 8, 2021 • edited

leerob Jun 8, 2021

Choose a reason for hiding this comment

housseindjirdeh Jun 8, 2021

Choose a reason for hiding this comment

timneutkens Jun 8, 2021

Choose a reason for hiding this comment

housseindjirdeh Jun 8, 2021

Choose a reason for hiding this comment

This comment has been minimized.

ijjk Jun 8, 2021

Choose a reason for hiding this comment

housseindjirdeh Jun 9, 2021

Choose a reason for hiding this comment

ijjk commented Jun 8, 2021

Stats from current PR

leodr commented Jun 9, 2021

housseindjirdeh commented Jun 8, 2021 •

edited