fix(formatters): render warnings in markdown output#2966
Open
slegarraga wants to merge 1 commit into
Open
Conversation
The markdown formatter filtered results by `failSeverity`, so with the default `failSeverity` of `error` it never rendered warnings, ignoring the absence of `--display-only-failures`. Result filtering for that flag already happens in the CLI before formatting, and the other formatters render every result they receive. Drop the redundant filter. Closes stoplightio#2928
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
markdownformatter never rendered warnings, even when--display-only-failureswas not passed. Fixes #2928.Root cause
markdown.tsfiltered results withresult.severity <= failSeverity.failSeveritydefaults toerror(DiagnosticSeverity.Error === 0), so only errors survived and warnings (severity1) were dropped regardless of--display-only-failures.failSeveritycontrols the process exit code, not what is displayed. The--display-only-failuresfiltering is already applied in the CLI before formatting (filterResultsBySeverityincommands/lint.ts), and the other formatters (stylish,text,json,pretty) render every result they receive.Fix
Drop the redundant
failSeverityfilter from the markdown formatter so it renders all results it is given, consistent with the other formatters.Test
Added a regression test asserting warnings are rendered with the default
failSeverityoferror. The existing markdown test continues to pass.