Vacuum does not return error if there is an error on reference about vacuum HOT 5 CLOSED

This is a missing feature rather than a bug, it's the same problem as #230 vacuum needs more intelligence to detect this.

In regard to the update for #230 this is high on the list of fixes I want to make in the next round of updates, that should be coming along soon, I am working on some other tooling at the moment.

from vacuum.

Please try v0.1.0 and let me know how you get on.

from vacuum.

Hi @daveshanley thanks for quick fix

Now, I get a circular-references error after using 0.1.0 version. Please see the example:

Command: vacuum report v1/routes.yaml -p v1

v1/routes.yaml

components:
  schema:
    testSchema:
      type: object
      metadata:
        $ref: >-
          ../base-yaml#/components/schemas/metadata

base.yaml

components:
  schema:
    metadata:
      type: object
      properties:
        data1:
          type: string
          description: data 1
        data2:
          type: string
          description: data 2

The error that I get:

  {
      "message": "cannot resolve reference `../base.yaml#/components/schemas/metadata`, it's missing: $components.schemas['metadata'] [...:..]",
      "range": {
          ...
      },
      "path": "$components.schemas['metadata']",
      "ruleId": "circular-references",
      "ruleSeverity": "error"
  }

Could you please tell me if there is any problem on my side or if it is a bug in this version? Thanks

from vacuum.

Hi @sezgigumus

What you're now seeing is improved detection for missing references or un-resolved references. This is supposed to happen, before these bad refs were not being reported.

However what is wrong here, is that the rule is marked as 'circular-references' it should not be lumped into that category. I will fix that to be something appropriate, however the error is accurate.

To use local / remote or relative references, use the -p / --base flag to set a base directory or URL for vacuum to use to look up the references.

https://quobix.com/vacuum/commands/lint/

Thanks

from vacuum.

I cleaned up the rule for reporting circular references and resolving issues in v0.1.1

from vacuum.