Skip to content

fix(formatters): render warnings in markdown output #2966

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.

Sign up for GitHub

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

Open
slegarraga wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(formatters): render warnings in markdown output #2966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/formatters/src/__tests__/markdown.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,16 @@ describe('Markdown formatter', () => {

expect(normalizedMd).toEqual(normalizedExpectedMd);
});

test('renders warnings regardless of failSeverity (#2928)', () => {
const CRLF = '\r\n';
// failSeverity defaults to "error"; warnings must still be rendered, since
// display-only-failures filtering already happens in the CLI before formatting.
const md = markdown(results, { failSeverity: DiagnosticSeverity.Error }, context);

const normalizedMd = md.replace(new RegExp(CRLF, 'g'), '\n').trim();
const normalizedExpectedMd = expectedMd.replace(new RegExp(CRLF, 'g'), '\n').trim();

expect(normalizedMd).toEqual(normalizedExpectedMd);
});
});
6 changes: 2 additions & 4 deletions packages/formatters/src/markdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,15 @@ import { DiagnosticSeverity } from '@stoplight/types';
import markdownEscape from 'markdown-escape';
import { getRuleDocumentationUrl } from './utils/getDocumentationUrl';

export const markdown: Formatter = (results, { failSeverity }, ctx?: FormatterContext) => {
export const markdown: Formatter = (results, _options, ctx?: FormatterContext) => {
const groupedResults = groupBySource(results);

const lines: string[][] = [];
for (const [source, validationResults] of Object.entries(groupedResults)) {
validationResults.sort((a, b) => a.range.start.line - b.range.start.line);

if (validationResults.length > 0) {
const filteredValidationResults = validationResults.filter(result => result.severity <= failSeverity);

for (const result of filteredValidationResults) {
for (const result of validationResults) {
const ruleDocumentationUrl = getRuleDocumentationUrl(result.code, ctx);
const codeWithOptionalLink =
ruleDocumentationUrl != null
Expand Down