Skip to content

Conversation

stefanprobst
Copy link
Contributor

@stefanprobst stefanprobst commented Jul 21, 2021

this pr moves the "core-web-vitals" config from eslint-config-next to eslint-plugin-next.

Fixes: #27292

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

@ijjk

This comment has been minimized.

Copy link
Contributor

@housseindjirdeh housseindjirdeh left a comment

Choose a reason for hiding this comment

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

Could you add an integration test to show that errors or warnings will show with the new plugin config that can be extended?

Otherwise, this looks great. Thanks for doing this :)

@stefanprobst
Copy link
Contributor Author

added 2 integration tests for "recommended" and "core-web-vitals" plugin configs

@ijjk

This comment has been minimized.

Copy link
Contributor

@housseindjirdeh housseindjirdeh left a comment

Choose a reason for hiding this comment

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

LGTM ✅

Thanks for this!

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Jul 23, 2021

Stats from current PR

Default Build (Decrease detected ✓)
General
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
buildDuration 13.6s 13.5s -61ms
buildDurationCached 3.1s 3s -79ms
nodeModulesSize 49.5 MB 49.5 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
/ failed reqs 0 0
/ total time (seconds) 2.229 2.27 ⚠️ +0.04
/ avg req/sec 1121.59 1101.38 ⚠️ -20.21
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.264 1.26 0
/error-in-render avg req/sec 1977.84 1983.73 +5.89
Client Bundles (main, webpack, commons)
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config 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 21 kB 21 kB
webpack-HASH.js gzip 1.53 kB 1.53 kB
Overall change 67.9 kB 67.9 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config 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 stefanprobst/next.js eslint-plugin/webvitals-config 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.63 kB 5.63 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 stefanprobst/next.js eslint-plugin/webvitals-config Change
_buildManifest.js gzip 489 B 489 B
Overall change 489 B 489 B
Rendered Page Sizes
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
index.html gzip 530 B 530 B
link.html gzip 544 B 544 B
withRouter.html gzip 525 B 525 B
Overall change 1.6 kB 1.6 kB

Webpack 4 Mode
General
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
buildDuration 10.6s 10.7s ⚠️ +129ms
buildDurationCached 4.1s 4.1s -25ms
nodeModulesSize 49.5 MB 49.5 MB
Page Load Tests Overall increase ✓
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
/ failed reqs 0 0
/ total time (seconds) 2.256 2.246 -0.01
/ avg req/sec 1108.21 1113.16 +4.95
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.242 1.244 0
/error-in-render avg req/sec 2012.42 2009.11 ⚠️ -3.31
Client Bundles (main, webpack, commons)
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
17.HASH.js gzip 2.98 kB 2.98 kB
18.HASH.js gzip 185 B 185 B
677f882d2ed8..HASH.js gzip 13.8 kB 13.8 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.5 kB 68.5 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config 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 stefanprobst/next.js eslint-plugin/webvitals-config 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 stefanprobst/next.js eslint-plugin/webvitals-config Change
_buildManifest.js gzip 500 B 500 B
Overall change 500 B 500 B
Rendered Page Sizes
vercel/next.js canary stefanprobst/next.js eslint-plugin/webvitals-config Change
index.html gzip 577 B 577 B
link.html gzip 589 B 589 B
withRouter.html gzip 569 B 569 B
Overall change 1.74 kB 1.74 kB
Commit: 2ca6002

@kodiakhq kodiakhq bot merged commit daf54bb into vercel:canary Jul 23, 2021
@stefanprobst stefanprobst deleted the eslint-plugin/webvitals-config branch July 23, 2021 19:18
@quinnturner
Copy link
Contributor

quinnturner commented Jul 28, 2021

When using eslint-config-next, the instructions throughout the docs:

  "extends": [
    "next",
    "next/core-web-vitals"
  ],

Give me this error:

Cannot read config file: /project-name/node_modules/eslint-config-next/core-web-vitals.js
Error: Cannot find module 'plugin:@next/next/core-web-vitals'
Require stack:
- /project-name/node_modules/eslint-config-next/core-web-vitals.js
- /project-name/node_modules/@eslint/eslintrc/lib/config-array-factory.js
- /project-name/node_modules/@eslint/eslintrc/lib/index.js
- /project-name/node_modules/eslint/lib/cli-engine/cli-engine.js
- /project-name/node_modules/eslint/lib/cli-engine/index.js
- /project-name/node_modules/eslint/lib/api.js
- /project-name/node_modules/next/dist/lib/eslint/runLintCheck.js
- /project-name/node_modules/next/dist/cli/next-lint.js
- /project-name/node_modules/next/dist/bin/next
Referenced from: /project-name/.eslintrc

@stefanprobst
Copy link
Contributor Author

@quinnturner thanks for reporting! should be fixed with #27567 i hope

kodiakhq bot pushed a commit that referenced this pull request Jul 28, 2021
fixes what i messed up in #27363. cf. #27363 (comment)

also added an integration test for extending from `next/core-web-vitals` eslint config

## Bug

- [x] Related issues linked using `fixes #number`
- [x] 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
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
)

this pr moves the "core-web-vitals" config from `eslint-config-next` to `eslint-plugin-next`.

Fixes: vercel#27292

## 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.
- [x] 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
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
fixes what i messed up in vercel#27363. cf. vercel#27363 (comment)

also added an integration test for extending from `next/core-web-vitals` eslint config

## Bug

- [x] Related issues linked using `fixes #number`
- [x] 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
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[eslint] make "core-web-vitals" available as plugin config
4 participants