Support yaml files

[T0RAT0RA]

Provide a way to support yaml instead of json.

Ex: all.yaml:

---
- entityRef:
    kind: api
    name: api.foo
  scorePercent: 50
  scoreLabel: Yellow
  scoringReviewDate: '2022-01-01T08:00:00Z'
  scoreSuccess: almost-failure
  areaScores:
  - title: Extensibility
    scorePercent: 50
    scoreLabel: Yellow
    scoreSuccess: almost-failure
  - title: Code
    scorePercent: 100
    scoreLabel: Green
    scoreSuccess: success
  - title: Quality
    scorePercent: 25
    scoreLabel: Red
    scoreSuccess: failure
  - title: Documentation
    scorePercent: 100
    scoreLabel: Green
    scoreSuccess: success
  - title: Operations
    scorePercent: 50
    scoreLabel: Yellow
    scoreSuccess: almost-failure

Feature Suggestion

JSON doesn't support comments so having the scores in YAML enable commenting the score file, for better maintenance.

Possible Implementation

Adding a new boolean config useYaml that would use .yaml suffix to the urls, and convert the fileback to JSON before processing it.

Context

I can provide an implementation once I'm done with #99

[jvilimek]

Thanks for the suggestion. How do you plan to do it? Implementing a new ScoringDataYamlClient ?

[T0RAT0RA]

Yes it could be, but I see some common code in ScoringDataJsonClient.ts that could be extracted, like the helpers and the call to the catalog API.

Actually the only difference will be:

• use a .yaml suffix in the urlWithData
• convert yaml to json, using a package (Ex: https://www.npmjs.com/package/yaml)

Then we call the catalog and extend the Entity Score.