Feature request: hide warnings/errors if they will be auto-fixed

[ryaninvents]

Proposal: Add a new config option eslint.hideAutoFixedIssues.

If eslint.hideAutoFixedIssues and eslint.autoFixOnSave are both true, then do not show the error/warning in the text editor if ESLint suggests a fix. This is helpful when scanning a file, as it makes real errors (such as a typo in a variable name) much more visible.

I've got a bit of time coming up and would love to implement this.

[dbaeumer]

Nice suggestion. A PR is welcome here. The file to look at is: https://github.com/Microsoft/vscode-eslint/blob/dbaeumer/multiroot/eslint-server\src\server.ts#L899

[ryaninvents]

Unfortunately it looks like if the error is reported, it must be displayed, and if the error is not reported, it will not be auto-fixed. Bit of a Catch-22.

However, I was able to successfully downgrade issues with available fixes to DiagnosticSeverity.Hint, which provides a nice user experience. If the cursor is within the range highlighted by the issue, it displays as an unobtrusive lightbulb in the gutter, and if the cursor is on a different line there's no visual indication of the issue.

Do you think hideAutoFixedIssues is still an accurate enough phrase to describe this behavior? It's not really totally "hidden" per se, but all the other wordings I came up with sounded engineer-y and bizarre (suppressAutoFixedIssues was the closest I could come up with).

[ryaninvents]

I've made the PR, but it's open to maintainers, so you can modify the name of the option if need be.

[dbaeumer]

@r24y thanks for looking into this. I think it should still be possible to hide the errors all together without downgrading them to a hint. The code flow should be something like this:

• recordCodeAction should return whether there was a fix or not

					if (problem) {
						let diagnostic = makeDiagnostic(problem);
						let hasFix = false;
						if (supportedAutoFixLanguages.has(document.languageId)) {
							hasFix = recordCodeAction(document, diagnostic, problem);
						}
						if (!(hasFix && hideAutofixableDiagnostics)) {
							diagnostics.push(diagnostic);
						}
					}

Have you tried this?

[ryaninvents]

@dbaeumer I haven't tried that. I might have time today to work on it

[ajerez]

@dbaeumer Any updates on this? Thanks

[dbaeumer]

No, not from my side. @ryaninvents any update.

[kasvtv]

edit: Just sent a PR!

I would like to emphasize how much of a difference this would make:

This option will allow ESLint to completely replace any formatting tooling like Prettier, Beautify etc for VScode! The only reason why it doesn't right now (at least for me) is that the mandatory warnings while typing are just too distracting.

One could even use "eslint.options": { "fixTypes": ["layout"] } such that it really behaves like just a formatter :).

Both Prettier and Beautify aren't very configurable, at least not anywhere near the granularity that ESLint has. Also when a team member happens to use ESLint, but not the formatter, they won't be warned about breaking project conventions. With this change, even if someone doesn't have/like autofixing enabled or uses ESLint with a different editor of their choice, it would still nicely warn them!

This could really make ESLint the one-stop-shop for both auto formatting and linting, with its configuration being a single source of truth, without having to deal with possibly conflicting extensions with and configurations for different features described with different nomenclature.