mrlunchbox777 / basic-setup

basic box setup
MIT License
6 stars 3 forks source link

feature: Switch the index file to yaml #119

Open mrlunchbox777 opened 4 months ago

mrlunchbox777 commented 4 months ago

Contact Details

mrlunchbox777@gmail.com

Feature Description

Switch the index file from json to yaml

Why?

This should be done after https://github.com/mrlunchbox777/basic-setup/issues/117

yaml is a superset of json, so it offers more features. It also supports comments, is more consistent with modern projects, puts more information in a single screen, and will be easier for humans to manage.

What-should happen?

The index.json should be converted to index.yaml. Comments should be added, particularly above array items showing their name to more easily identify collapsed items in an IDE. The remaining bash scripts that need to interact with the index file should be updated to use yq instead of jq. The github Issues that reference the index files should also be updated.

Steps to Test

Code of Conduct

mrlunchbox777 commented 4 months ago

when this starts getting worked, we should block all of the github Issues that reference the index.json to reduce conflicts and rework