Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

unlock eslint-config-next dependencies #35781

Merged
merged 7 commits into from Apr 28, 2022
Merged

unlock eslint-config-next dependencies #35781

merged 7 commits into from Apr 28, 2022

Conversation

balazsorban44
Copy link
Member

@balazsorban44 balazsorban44 commented Mar 31, 2022 •
edited by ijjk

Fixes #35753
x-ref: #35606
x-ref: #35865
x-ref: #36212
x-ref: #35977
x-ref: #35806

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running yarn lint

@balazsorban44 balazsorban44 changed the title chore: bump eslint-plugin-react-hooks chore(deps): bump eslint-plugin-react-hooks Mar 31, 2022
@ijjk
Copy link
Member

ijjk commented Mar 31, 2022 •
edited

Stats from current PR

Default Build (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
buildDuration 18.1s 18.6s ⚠️ +485ms
buildDurationCached 7.2s 7.1s -61ms
nodeModulesSize 463 MB 463 MB ⚠️ +552 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.72 3.809 ⚠️ +0.09
/ avg req/sec 672.02 656.42 ⚠️ -15.6
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.592 1.607 ⚠️ +0.01
/error-in-render avg req/sec 1569.96 1555.5 ⚠️ -14.46
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
925.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42 kB 42 kB ✓
main-HASH.js gzip 28.6 kB 28.6 kB ✓
webpack-HASH.js gzip 1.44 kB 1.44 kB ✓
Overall change 72.3 kB 72.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
_app-HASH.js gzip 1.36 kB 1.36 kB ✓
_error-HASH.js gzip 193 B 193 B ✓
amp-HASH.js gzip 308 B 308 B ✓
css-HASH.js gzip 327 B 327 B ✓
dynamic-HASH.js gzip 3.08 kB 3.08 kB ✓
head-HASH.js gzip 359 B 359 B ✓
hooks-HASH.js gzip 920 B 920 B ✓
image-HASH.js gzip 5.71 kB 5.71 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 2.64 kB 2.64 kB ✓
routerDirect..HASH.js gzip 320 B 320 B ✓
script-HASH.js gzip 391 B 391 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16.3 kB 16.3 kB ✓
Client Build Manifests
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
_buildManifest.js gzip 459 B 459 B ✓
Overall change 459 B 459 B ✓
Rendered Page Sizes
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
index.html gzip 532 B 532 B ✓
link.html gzip 546 B 546 B ✓
withRouter.html gzip 528 B 528 B ✓
Overall change 1.61 kB 1.61 kB ✓
Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
buildDuration 20s 20.4s ⚠️ +410ms
buildDurationCached 7.2s 7.1s -60ms
nodeModulesSize 463 MB 463 MB ⚠️ +552 B
Page Load Tests Overall increase ✓
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.804 3.766 -0.04
/ avg req/sec 657.26 663.8 +6.54
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.594 1.589 -0.01
/error-in-render avg req/sec 1568.43 1573.33 +4.9
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
925.HASH.js gzip 178 B 178 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 29.1 kB 29.1 kB ✓
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 72.9 kB 72.9 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
_app-HASH.js gzip 1.35 kB 1.35 kB ✓
_error-HASH.js gzip 179 B 179 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 324 B 324 B ✓
dynamic-HASH.js gzip 3.08 kB 3.08 kB ✓
head-HASH.js gzip 357 B 357 B ✓
hooks-HASH.js gzip 921 B 921 B ✓
image-HASH.js gzip 5.76 kB 5.76 kB ✓
index-HASH.js gzip 261 B 261 B ✓
link-HASH.js gzip 2.76 kB 2.76 kB ✓
routerDirect..HASH.js gzip 322 B 322 B ✓
script-HASH.js gzip 392 B 392 B ✓
withRouter-HASH.js gzip 317 B 317 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 16.5 kB 16.5 kB ✓
Client Build Manifests
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
_buildManifest.js gzip 458 B 458 B ✓
Overall change 458 B 458 B ✓
Rendered Page Sizes
vercel/next.js canary vercel/next.js feat/bump-eslint-plugin-react-hooks Change
index.html gzip 530 B 530 B ✓
link.html gzip 543 B 543 B ✓
withRouter.html gzip 527 B 527 B ✓
Overall change 1.6 kB 1.6 kB ✓
Commit: 6041fc9

styfle
styfle previously approved these changes Mar 31, 2022
View reviewed changes
ijjk
ijjk reviewed Mar 31, 2022
View reviewed changes
docs/basic-features/eslint.md Outdated
@@ -261,3 +261,5 @@ If you already use a separate ESLint configuration and want to include `eslint-c
```

The `next` configuration already handles setting default values for the `parser`, `plugins` and `settings` properties. There is no need to manually re-declare any of these properties unless you need a different configuration for your use case. If you include any other shareable configurations, **you will need to make sure that these properties are not overwritten or modified**. Otherwise, we recommend removing any configurations that share behavior with the `next` configuration or extending directly from the Next.js ESLint plugin as mentioned above.

If ESLint shows a conflicting plugin error, it is because you have installed a different version than what Next.js already includes. You should remove the conflicting plugins from your `package.json`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at other eslint configs it seems like we might be handling this wrong and we should be using peerDependencies for the eslint plugins to prevent this although not sure we can change that without a major bump cc @housseindjirdeh for thoughts

eslint-config-airbnb https://unpkg.com/eslint-config-airbnb@19.0.4/package.json
eslint-config-standard https://unpkg.com/eslint-config-standard@16.0.3/package.json

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think our usage of @rushstack/eslint-patch prevents us from using a typical peerDependencies setup in favor of simplifying the workflow for developers (they only need to install a single package (eslint-config-next) instead of all the plugins separately).

I'd be happy to consider changing this if there are issues with this approach, but I agree it would have to be in a major version change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Our current approach seems to cause issues (see #35806 also) and I can see it being the ground for more in the future.

https://www.npmjs.com/package/eslint-config-airbnb recommends npx install-peerdeps --dev eslint-config-airbnb which will auto-install all the necessary peerDependencies. Could that be an option that we could bake in?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Our current approach seems to cause issues (see #35806 also) and I can see it being the ground for more the future.

In that case, then let's aim to switch it to a normal peerDep setup. :)

Could that be an option that we could bake in?

Yep that looks like the best possible path forward. If possible, I would like to bake this option in first and then show a warning for folks who don't have peerDeps installed. That will give them enough time to switch before we introduce the breaking change of removing @rushstack/eslint-patch completely.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So to resolve #35606 and #35977 for now do we want to unpin the plugin deps in this PR and work towards moving these to peerDeps?

@balazsorban44 balazsorban44 changed the title chore(deps): bump eslint-plugin-react-hooks unlock eslint-config-next dependencies Apr 28, 2022
balazsorban44 and others added 2 commits April 28, 2022 15:01
@balazsorban44
remove docs change
7cfeab8
@ijjk
Merge branch 'canary' into feat/bump-eslint-plugin-react-hooks
7ee9f65 
# Conflicts:
#	packages/eslint-config-next/package.json
#	yarn.lock
ijjk
ijjk previously approved these changes Apr 28, 2022
View reviewed changes
@github-actions github-actions bot dismissed stale reviews from housseindjirdeh and ijjk via a52788a April 28, 2022 16:53
@kodiakhq kodiakhq bot merged commit f000503 into canary Apr 28, 2022
@kodiakhq kodiakhq bot deleted the feat/bump-eslint-plugin-react-hooks branch April 28, 2022 17:16
@ijjk ijjk mentioned this pull request Apr 28, 2022
Closed
1 task
@ijjk ijjk mentioned this pull request Apr 28, 2022
Closed
1 task
@balazsorban44 balazsorban44 mentioned this pull request May 9, 2022
Closed
10 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ijjk ijjk ijjk approved these changes

@styfle styfle styfle left review comments

@housseindjirdeh housseindjirdeh housseindjirdeh left review comments

@timneutkens timneutkens Awaiting requested review from timneutkens timneutkens is a code owner

@shuding shuding Awaiting requested review from shuding shuding is a code owner

@huozhi huozhi Awaiting requested review from huozhi huozhi is a code owner

@padmaia padmaia Awaiting requested review from padmaia

@leerob leerob Awaiting requested review from leerob

Assignees
No one assigned
Labels
type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: a potential dependency version issue by locking the version
4 participants
@balazsorban44 @ijjk @styfle @housseindjirdeh