Skip to content

Feature request: add option to show only verbose errors and not require the full verbose output #648

@frehov

Description

@frehov

Hi,

We're currently using check-jsonschema with pre-commit for around a hundred files in a CI pipeline.
If we're pushing an update to all configuration files, we'll see something like below.

When we turn on the verbose option, we see the following:

The following files were checked:
  ...
  ...
  ...
  ...
The following files were checked:
  applications/phyron.yaml
  applications/baltic-offer-tool.yaml
  applications/batch-onprem.yaml
  applications/node-libraries.yaml
  applications/cloud-utilities.yaml
  applications/terraform.yaml
  applications/dynamics-event-platform.yaml
Schema validation errors were encountered.
  applications/identityprovider.yaml::$.github.code_review: {'require_code_owner_review': True} is not valid under any of the given schemas
  Underlying errors caused this.

  Best Match:
    $.github.code_review: 'notify' is a required property
  All Errors:
    $.github.code_review: 'notify' is a required property
    $.github.code_review: 'algorithm' is a required property
    $.github.code_review: 'allow_bypass' is a required property

When verbose is turned off, we see the following.
And we can see thet there is an error, but not all of them.
In this case the schema defines that one of those properties must be set.

ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
Schema validation errors were encountered.
  applications/identityprovider.yaml::$.github.code_review: {'require_code_owner_review': True} is not valid under any of the given schemas
  Underlying errors caused this.

  Best Match:
    $.github.code_review: 'notify' is a required property

  2 other errors were produced. Use '--verbose' to see all errors.

Would it be possible to have either a verbose option or separate option to only turn on the full error output, while keeping the other parts "silent"?

Example of output we'd consider very beneficial for the teams.

ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
ok -- validation done
Schema validation errors were encountered.
  applications/identityprovider.yaml::$.github.code_review: {'require_code_owner_review': True} is not valid under any of the given schemas
  Underlying errors caused this.

  Best Match:
    $.github.code_review: 'notify' is a required property
  All Errors:
    $.github.code_review: 'notify' is a required property
    $.github.code_review: 'algorithm' is a required property
    $.github.code_review: 'allow_bypass' is a required property

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions