Error output is not formed correctly in Problems tab

[jeremyfiel]

What happened?

Recently, the VS Code output is not formatted correctly. I'm not sure exactly when it started, but it seems to have been from last week.. 03/10/23+

openapi: 3.0.3
info:
  title: blah
  version: 1.1.0
paths:
  /test/api:
    get:
      parameters: 
        - name: jeremy
          in: query
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "../../../common/shared/confirm-message-schema_v03.json"
    post:
      requestBody:
        $ref: "#/components/requestBodies/jeremy"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "schemas/test-schema_v01.json"
              examples: 
                example: 
                  externalValue: "./examples/example.json"
                example1:
                  $ref: "./not-schemas/test-schema_v01.json"
components:
  requestBodies:
    jeremy:
      required: true
      content:
        application/json:
          schema:
            $ref: "./common/shared/-schema_v01.json"
  schemas:
    jeremy:
      type: object
      properties:
        test:
          $ref: "jeremy-test"

Screenshots

two diff examples of output from different files.

Additional context

Last released
2023-9-20, 10:16:31
Last updated
2023-9-20, 20:18:54

[jeremyfiel]

I found a configurable rule is causing this behavior

  rule/header-param-exists:
    subject:
      type: Parameter
      property: in
    where:
      - subject:
          type: Operation
          property: parameters
        assertions:
          defined: true
    assertions:
      const: header

I was playing around with trying to find a solution to Redocly/redocly-cli#1286

[tatomyr]

Thank you @jeremyfiel for reporting this!

[RomanHotsiy]

@jeremyfiel so if you remove the configurable rule the formatting gets back to normal?

[jeremyfiel]

Yes, something with the reporting and the way this rule is written causes the invalid output

[jeremyfiel]

@RomanHotsiy I found this happens again with this new rule I was testing:

The formatting issue seems to be in both VSC and the cli output

rules:
  rule/operation-tags-must-be-defined:
  severity: error
  subject:
    type: Operation
  assertions:
    required:
      - tags

[jeremyfiel]

@RomanHotsiy @tatomyr

I think I found the root cause of this formatting error. If I omit message in the configurable rule, it creates this formatting error.

[tatomyr]

@jeremyfiel I think it has something to do with OS. On Mac I get correct problems' output formatting:

Do you use Windows?

[jeremyfiel]

I do use windows. But if you remove the message property it doesn't give you incorrect formatting?

[tatomyr]

Yes, this is without the message property.