Skip to content
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.

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

Formatter: Statistics #1121

Closed
philsturgeon opened this issue Apr 24, 2020 · 1 comment
Closed

Formatter: Statistics #1121

philsturgeon opened this issue Apr 24, 2020 · 1 comment
Labels
enhancement New feature or request hacktoberfest help wanted Extra attention is needed p/low
Milestone

Comments

@philsturgeon
Copy link
Contributor

User story.
As a spectral CLI user I'd like to see common offenders in a clearer way than line by line.

Describe the solution you'd like

A new formatter that can output something along these lines:

statistics
  Total number of errors   : 284
  Total number of warnings : 378
  errors
   1   (0%) : 'scopes' is required property type object. The available scopes for the OAuth2 security scheme.
   3   (1%) : Arrays MUST NOT be returned as the top-level structure in a response body.
   1   (0%) : Parameter names must follow case convention
  42  (15%) : Path segments must follow case convention
 219  (77%) : Property names must follow case convention
  18   (6%) : Enum values must follow case convention
  warnings
  66  (17%) : operationIds should follow naming convention
  93  (25%) : operationIds must follow case convention
   5   (1%) : Required parameters should appear before optional parameters.
  10   (3%) : Common path parameters should be defined on path object
   5   (1%) : Definition was declared but never used in document
 104  (28%) : Schema must have a non-empty description.
  61  (16%) : Schema properties must have a description with content in it.
  17   (4%) : Property has inconsistent type
  17   (4%) : Description sibling to $ref matches that of the referenced schema. This is redundant and should be removed.

Additional context

Suggestion from @mkistler.

@philsturgeon philsturgeon added this to the v6.0 milestone Apr 28, 2020
@philsturgeon philsturgeon added the breaking Pull requests that introduce a breaking change label Jul 9, 2020
@P0lip P0lip added enhancement New feature or request and removed breaking Pull requests that introduce a breaking change labels Sep 30, 2020
@philsturgeon philsturgeon added the help wanted Extra attention is needed label Dec 31, 2020
@mnaumanali94
Copy link
Contributor

Related to scoring discussion here: #2429

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest help wanted Extra attention is needed p/low
Projects
None yet
Development

No branches or pull requests

4 participants