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
[ -f resources/install/index.json ] && echo exists should output nothing
[ -f resources/install/index.yaml ] && echo exists should output exists
[ -f resources/install/index-package-template.json ] && echo exists should output nothing
[ -f resources/install/index-package-template.yaml ] && echo exists should output exists
A comment above each package containing the package name
A comment above each package-manager containing the package-manager-name
All remaining bash scripts work as they did before the migration
bsctl works as it did before the migration
No github Issue references index.json or index-package-template.json
Code of Conduct
[X] I agree to follow this project's Code of Conduct
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 ofjq
. The github Issues that reference the index files should also be updated.Steps to Test
[ -f resources/install/index.json ] && echo exists
should output nothing[ -f resources/install/index.yaml ] && echo exists
should outputexists
[ -f resources/install/index-package-template.json ] && echo exists
should output nothing[ -f resources/install/index-package-template.yaml ] && echo exists
should outputexists
Code of Conduct