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.

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

Add ESLint docs URLs #29645

Merged
merged 3 commits into from
Oct 16, 2021
Merged

Conversation

christianvuerings
Copy link
Contributor

Adds URLs for every ESLint rules which has documentation on https://nextjs.org. E.g. https://nextjs.org/docs/messages/no-unwanted-polyfillio

Benefit

In VSCode, the rule becomes clickable and redirect you do the docs

Before

Screen Shot 2021-10-04 at 6 26 21 AM

After

Screen Shot 2021-10-04 at 6 27 00 AM

References

https://eslint.org/docs/developer-guide/working-with-rules#rule-basics

url (string) specifies the URL at which the full documentation can be accessed (enabling code editors to provide a helpful link on highlighted rule violations)

Copy link
Collaborator

@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.

This is great, thank you!

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Oct 16, 2021

Stats from current PR

Default Build (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
buildDuration 15.2s 14.9s -320ms
buildDurationCached 3.5s 3.5s ⚠️ +31ms
nodeModulesSize 199 MB 199 MB ⚠️ +5 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
/ failed reqs 0 0
/ total time (seconds) 3.652 3.587 -0.06
/ avg req/sec 684.46 696.99 +12.53
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.831 1.973 ⚠️ +0.14
/error-in-render avg req/sec 1365.19 1267.05 ⚠️ -98.14
Client Bundles (main, webpack, commons)
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
779.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 27 kB 27 kB
webpack-HASH.js gzip 1.45 kB 1.45 kB
Overall change 70.9 kB 70.9 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
_app-HASH.js gzip 977 B 977 B
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 311 B 311 B
css-HASH.js gzip 328 B 328 B
dynamic-HASH.js gzip 2.67 kB 2.67 kB
head-HASH.js gzip 351 B 351 B
hooks-HASH.js gzip 918 B 918 B
image-HASH.js gzip 4.14 kB 4.14 kB
index-HASH.js gzip 260 B 260 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 320 B 320 B
script-HASH.js gzip 386 B 386 B
withRouter-HASH.js gzip 319 B 319 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 13 kB 13 kB
Client Build Manifests
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
_buildManifest.js gzip 493 B 493 B
Overall change 493 B 493 B
Rendered Page Sizes
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
index.html gzip 540 B 540 B
link.html gzip 551 B 551 B
withRouter.html gzip 533 B 533 B
Overall change 1.62 kB 1.62 kB

Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
buildDuration 7.4s 7.7s ⚠️ +284ms
buildDurationCached 3.3s 3.6s ⚠️ +292ms
nodeModulesSize 199 MB 199 MB ⚠️ +5 B
Page Load Tests Overall increase ✓
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
/ failed reqs 0 0
/ total time (seconds) 3.591 3.577 -0.01
/ avg req/sec 696.18 698.82 +2.64
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.852 1.847 -0.01
/error-in-render avg req/sec 1349.62 1353.19 +3.57
Client Bundles (main, webpack, commons)
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
675-HASH.js gzip 13.8 kB 13.8 kB
770.HASH.js gzip 178 B 178 B
framework-HASH.js gzip 50.8 kB 50.8 kB
main-HASH.js gzip 35.1 kB 35.1 kB
webpack-HASH.js gzip 1.64 kB 1.64 kB
Overall change 101 kB 101 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
_app-HASH.js gzip 1.33 kB 1.33 kB
_error-HASH.js gzip 180 B 180 B
amp-HASH.js gzip 315 B 315 B
css-HASH.js gzip 331 B 331 B
dynamic-HASH.js gzip 2.79 kB 2.79 kB
head-HASH.js gzip 355 B 355 B
hooks-HASH.js gzip 637 B 637 B
image-HASH.js gzip 555 B 555 B
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 2.22 kB 2.22 kB
routerDirect..HASH.js gzip 326 B 326 B
script-HASH.js gzip 393 B 393 B
withRouter-HASH.js gzip 322 B 322 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 10.1 kB 10.1 kB
Client Build Manifests
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
_buildManifest.js gzip 510 B 510 B
Overall change 510 B 510 B
Rendered Page Sizes
vercel/next.js canary christianvuerings/next.js add-eslint-docs-urls Change
index.html gzip 536 B 536 B
link.html gzip 549 B 549 B
withRouter.html gzip 530 B 530 B
Overall change 1.61 kB 1.61 kB
Commit: 218f469

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@ijjk ijjk merged commit 2b7c910 into vercel:canary Oct 16, 2021
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants