yamlfixer icon indicating copy to clipboard operation
yamlfixer copied to clipboard

💡 How to inject json summary in template engine (gomplate) 💡

Open adriens opened this issue 2 years ago • 3 comments

👉 Context

Actually the --jsonsummary makes it possible to get the summary as a valid json output :

image

So it can be queried for further integrations thanks to jq for example.

💡 The idea

The main idea is to extend yamlfixer by plugging it to a template engine so people can inject yamlfixer in a great variety of tools. The main idea consists on delivering ready to use gomplate templates, as part of the GH repo.

I thought about following outputs :

  • yaml
  • html
  • csv
  • markdown (?... as yaml already is very explicit)

🚀 Actions

Thanks to gomplate template engine :

  • [ ] Create a dedicated directory dedicated to gomplate templates (gomplates)
  • [ ] Create the template that output yaml
  • [ ] Create the template that output html
  • [ ] Create the template that output csv
  • [ ] Provide scripts that show a real use case for all of them
  • [ ] Update the Katacoda scenario to showcase how yamlfixer can be plugged with gomplate
  • [ ] Make de short demo in video ▶️ @adriens
  • [ ] Make a short DEV.to post showcasing this feature ▶️ @adriens
  • [ ] Tweet about the DEV.to post ▶️ @adriens (and tag @hairyhenderson)

adriens avatar Mar 15 '22 23:03 adriens

@adriens : please use yamlfixer v0.3.2 or higher to replace the above screenshot.

tamere-allo-peter avatar Mar 15 '22 23:03 tamere-allo-peter

@mbarre we need your skills on gomplate 🙏

adriens avatar Mar 15 '22 23:03 adriens

@tamere-allo-peter :

@adriens : please use yamlfixer v0.3.2 or higher to replace the above screenshot.

Done 👍

adriens avatar Mar 15 '22 23:03 adriens