Skip to content

[ESLint] Support single-file linting in next lint (necessary for lint-staged) - #28042

Merged
timneutkens merged 7 commits into
vercel:canaryfrom
housseindjirdeh:bug/#27997
Sep 6, 2021
Merged

timneutkens merged 7 commits into
vercel:canaryfrom
housseindjirdeh:bug/#27997

Conversation

@housseindjirdeh

@housseindjirdeh housseindjirdeh commented Aug 12, 2021 •

Copy link
Copy Markdown
Contributor

Supports single-file linting in next lint with the --file flag. Also fixes #27997 by providing lint-staged support.

Note: This adds the same functionality that was added in #26777 but without introducing any breaking changes

@ijjk

This comment has been minimized.

@housseindjirdeh
housseindjirdeh marked this pull request as draft August 12, 2021 19:34
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@housseindjirdeh
housseindjirdeh marked this pull request as ready for review August 17, 2021 18:41
@housseindjirdeh housseindjirdeh changed the title Support single-file linting in next lint (necessary for lint-staged) [ESLint] Support single-file linting in next lint (necessary for lint-staged) Aug 17, 2021
Comment thread test/integration/eslint/test/index.test.js Outdated
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

timneutkens
timneutkens previously approved these changes Aug 19, 2021
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

timneutkens
timneutkens previously approved these changes Aug 19, 2021
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

ijjk commented Sep 6, 2021

Copy link
Copy Markdown
Member

Stats from current PR

Default Build (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
buildDuration 15.9s 16.9s ⚠️ +960ms
buildDurationCached 4.1s 4.1s -53ms
nodeModulesSize 49.2 MB 49.2 MB ⚠️ +730 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.182 3.143 -0.04
/ avg req/sec 785.74 795.31 +9.57
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.874 1.972 ⚠️ +0.1
/error-in-render avg req/sec 1333.8 1267.43 ⚠️ -66.37
Client Bundles (main, webpack, commons)
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
745.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 23.3 kB 23.3 kB ✓
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 67.2 kB 67.2 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
polyfills-a4..dd70.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
_app-HASH.js gzip 979 B 979 B ✓
_error-HASH.js gzip 194 B 194 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 329 B 329 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 261 B 261 B ✓
link-HASH.js gzip 1.66 kB 1.66 kB ✓
routerDirect..HASH.js gzip 318 B 318 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 13 kB 13 kB ✓
Client Build Manifests
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
_buildManifest.js gzip 492 B 492 B ✓
Overall change 492 B 492 B ✓
Rendered Page Sizes
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
index.html gzip 539 B 539 B ✓
link.html gzip 553 B 553 B ✓
withRouter.html gzip 533 B 533 B ✓
Overall change 1.63 kB 1.63 kB ✓

Webpack 4 Mode (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
buildDuration 12.8s 12.8s -74ms
buildDurationCached 5.3s 5.3s -28ms
nodeModulesSize 49.2 MB 49.2 MB ⚠️ +730 B
Page Load Tests Overall increase ✓
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.121 3.166 ⚠️ +0.04
/ avg req/sec 801.14 789.74 ⚠️ -11.4
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.917 1.873 -0.04
/error-in-render avg req/sec 1303.93 1334.8 +30.87
Client Bundles (main, webpack, commons)
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
16.HASH.js gzip 186 B 186 B ✓
677f882d2ed8..HASH.js gzip 14.1 kB 14.1 kB ✓
framework.HASH.js gzip 41.9 kB 41.9 kB ✓
main-HASH.js gzip 10.7 kB 10.7 kB ✓
webpack-HASH.js gzip 1.19 kB 1.19 kB ✓
Overall change 68.1 kB 68.1 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
polyfills-a4..dd70.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
_app-HASH.js gzip 964 B 964 B ✓
_error-HASH.js gzip 3.8 kB 3.8 kB ✓
amp-HASH.js gzip 552 B 552 B ✓
css-HASH.js gzip 333 B 333 B ✓
dynamic-HASH.js gzip 2.87 kB 2.87 kB ✓
head-HASH.js gzip 3.06 kB 3.06 kB ✓
hooks-HASH.js gzip 924 B 924 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.03 kB 3.03 kB ✓
withRouter-HASH.js gzip 295 B 295 B ✓
30809af5c834..565.css gzip 125 B 125 B ✓
Overall change 18.1 kB 18.1 kB ✓
Client Build Manifests
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
_buildManifest.js gzip 500 B 500 B ✓
Overall change 500 B 500 B ✓
Rendered Page Sizes
vercel/next.js canary housseindjirdeh/next.js bug/#27997 Change
index.html gzip 584 B 584 B ✓
link.html gzip 597 B 597 B ✓
withRouter.html gzip 577 B 577 B ✓
Overall change 1.76 kB 1.76 kB ✓
Commit: 99c69fc

@ijjk

ijjk commented Sep 6, 2021

Copy link
Copy Markdown
Member

Failing test suites

Commit: 99c69fc

test/integration/required-server-files/test/index.test.js

  • Required Server Files > should output required-server-files manifest correctly
  • Required Server Files > should render SSR page correctly
  • Required Server Files > should render dynamic SSR page correctly
  • Required Server Files > should render fallback page correctly
  • Required Server Files > should render SSR page correctly with x-matched-path
  • Required Server Files > should render dynamic SSR page correctly with x-matched-path
  • Required Server Files > should render fallback page correctly with x-matched-path and routes-matches
  • Required Server Files > should return data correctly with x-matched-path
  • Required Server Files > should render fallback optional catch-all route correctly with x-matched-path and routes-matches
  • Required Server Files > should return data correctly with x-matched-path for optional catch-all route
  • Required Server Files > should not apply trailingSlash redirect
  • Required Server Files > should normalize catch-all rewrite query values correctly
  • Required Server Files > should bubble error correctly for gip page
  • Required Server Files > should bubble error correctly for gssp page
  • Required Server Files > should bubble error correctly for gsp page
  • Required Server Files > should bubble error correctly for API page
  • Required Server Files > should normalize optional values correctly for SSP page
  • Required Server Files > should normalize optional values correctly for SSG page
  • Required Server Files > should normalize optional values correctly for SSG page with encoded slash
  • Required Server Files > should normalize optional values correctly for API page
  • Required Server Files > should match the index page correctly
  • Required Server Files > should match the root dyanmic page correctly
Expand output

● Required Server Files › should output required-server-files manifest correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render SSR page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render dynamic SSR page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render SSR page correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render dynamic SSR page correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback page correctly with x-matched-path and routes-matches

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should return data correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback optional catch-all route correctly with x-matched-path and routes-matches

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should return data correctly with x-matched-path for optional catch-all route

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should not apply trailingSlash redirect

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize catch-all rewrite query values correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gip page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gssp page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gsp page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for API page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSP page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSG page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSG page with encoded slash

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for API page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should match the index page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should match the root dyanmic page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

@kachkaev

kachkaev commented Sep 6, 2021 •

Copy link
Copy Markdown
Contributor

Great new feature @housseindjirdeh – I was just looking for it 😍

In your markdown example you suggest to lint-staged only for **/*.js?(x), which makes sense at this point. I wonder if it possible to allow for **/* though and let Next.js filter the unrelated file. This is generally simpler and can be especially useful in two scenarios:

  • We initially configured the glob for js/jsx, but then started using TypeScript at some point. It's easy to forget to upgrade the glob.
  • Next.js integrated other Linters into next lint so the variety of lintable files increased.

In my ‘classic’ ESLint projects I configure .eslintignore like that:

## extensions
# 1. ignore all files
# 2. un-ignore files with ceratin extensions

## same as in .gitignore
...

See example. This allows me to call eslint for **/* both in lint-staged config and package.json → scripts. Thus, I don’t have to worry about the globs that are incomplete or go out of sync with the reality.

With next lint there is no need for .eslintignore which is very convenient. Now that we have ---file option, I wonder if we can ignore provided files automatically, thus enabling **/* in the lint-staged config. WDYT?

@housseindjirdeh

Copy link
Copy Markdown
Contributor Author

Thanks @kachkaev, and appreciate the feedback :)

Now that we have ---file option, I wonder if we can ignore provided files automatically, thus enabling */ in the lint-staged config. WDYT?

Hmm do you have an idea of were you would like to provide a list of ignored files? Because an option could be to leverage .eslintignore as the source of truth for all ignored files and then just use **/* in the config as long as your lint-staged conifg knows where to look.

One note: it seems that lint-staged ignores .eslintignore which is interesting (lint-staged/lint-staged#584), but a solution like this should allow you to do what your asking.

Let me know what you think, or if there's something that we can/should be doing!

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

ESLint not working with lint-staged

4 participants