feat(linter): add error and warning statistics

[SimeonC]

Outputs the error and warning count statistics including how many can be auto-fixed, something I found useful before - especially when changing eslint configs which can generate a lot of errors.

I have noticed that this is only useful in 2 cases;

• Sending the output to a file so eslint statistics aren't shown
• a lot of errors/warnings are being output and the output is truncated in the console

Current Behavior

Linter outputs only whether there are 1 or more errors or warnings.

Lint warnings found in the listed files.

Lint errors found in the listed files.

Expected Behavior

We should get the error/warning count and also the number of fixable error/warnings.

8 Lint warnings found in the listed files.

2306 Lint errors found in the listed files. (740 are fixable)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	⬜️ Ignored (Inspect)	Visit Preview	💬 Add feedback	Feb 1, 2024 1:23am

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit c9c813f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 8 targets

• linux nx affected --target=e2e --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e --parallel=1
• linux nx affected --target=test --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e --parallel=1
• linux nx affected --target=build --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e --parallel=3
• linux nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• linux nx affected --target=lint --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e --parallel=3
• nx-cloud record -- nx format:check --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e
• linux nx documentation --no-dte
• macos nx affected -t e2e-macos --parallel=1 --base=4c2f98ebf94382bd76baf08e7ad90e6d7f9cc49f --head=c9c813fc6d08b24a055016b76fa10bd8de83f78e

---

Sent with 💌 from NxCloud.

[JamesHenry]

I'm so sorry for the delay in you receiving a review here @SimeonC! This seems like a good change to me, would it be possible for you to fix up the conflicts please? I'll keep an eye on this one so we can get it merged straight away

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 19b4761. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 6 targets

• nx affected --target=e2e --base=8762c38bb9f1bfcd66987baca486b0a6cdb9fa45 --head=19b4761f405da2be4fbd9043fea4f438cd740c49 --parallel=1
• nx affected --targets=lint,test,build --base=8762c38bb9f1bfcd66987baca486b0a6cdb9fa45 --head=19b4761f405da2be4fbd9043fea4f438cd740c49 --parallel=3
• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=8762c38bb9f1bfcd66987baca486b0a6cdb9fa45 --head=19b4761f405da2be4fbd9043fea4f438cd740c49
• nx documentation --no-dte
• nx affected -t e2e-macos --parallel=1 --base=8762c38bb9f1bfcd66987baca486b0a6cdb9fa45 --head=19b4761f405da2be4fbd9043fea4f438cd740c49

---

Sent with 💌 from NxCloud.

[SimeonC]

@JamesHenry I admit I had kinda forgotten about this. Looks like I'm a bit fortunate this time and the "conflicts" are just that git has too many commits and a rebase worked.

[JamesHenry]

Thanks!

Sorry to be a pain, but can we align it a bit more with ESLint's own output and mention the --fix flag, as well as not have the . before the parens

Their logic looks like this:

 output += chalk[summaryColor].bold([
                "  ", fixableErrorCount, pluralize(" error", fixableErrorCount), " and ",
                fixableWarningCount, pluralize(" warning", fixableWarningCount),
                " potentially fixable with the `--fix` option.\n"
            ].join(""));

from https://github.com/eslint/eslint/blob/98b5ab406bac6279eadd84e8a5fd5a01fc586ff1/lib/cli-engine/formatters/stylish.js#L91

It doesn't have to be exactly that (e.g. we don't have the chalk dep in linter I don't think, but potentially fixable with the `--fix` option is preferable language please

[SimeonC]

@JamesHenry Thanks for the feedback, I went with updating to match the stylish formatted output as much as possible

[SimeonC]

Oh, I see that the success message is used in a lot of other tests. @JamesHenry would you prefer I revert the success message change or update the tests to use the stylish formatted success message?

[JamesHenry]

@SimeonC I think you can just do find an replace on toContain('All files pass linting.') with toContain('All files pass linting') (i.e. just remove the period at the end, I think that's the only difference)

[SimeonC]

@JamesHenry Thanks, did that.

[JamesHenry]

@SimeonC did you push with --no-verify? You have failed CI with a commit check that would have run automatically prepush

[SimeonC]

Yea I did. My git client was failing with something like “unexpected error” and no further information. I’ll fix it up tomorrow as I thought it’d probably be OK and was running out of time, my bad 😅 Haven’t used a push hook before, we’ve always used a precommit hook for that so was unexpected.

[JamesHenry]

It's your git commit message, you just need to do a commit --amend and add a valid scope to the commit

The check is way too expensive (it does a lot of things) to apply to a precommit hook, that is why it is done prepush

[SimeonC]

Thanks, my git client just shows "Some refs failed to push", when running git push from the command line I get the correct errors and could fix it.

[JamesHenry]

Thanks again @SimeonC!

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.