search

runfinch / finch

The Finch CLI is an open source client for container development
https://www.runfinch.com
Apache License 2.0
3.51k stars 90 forks source link

Support comments in the Finch configuration file finch.yaml #655

Open ollypom opened 11 months ago

ollypom commented 11 months ago

What is the problem you're trying to solve?. I would like to use comments in the Finch configuration file finch.yaml.

I often find myself commenting something out while testing a feature, or using comments to annotate why a key was set. However on a finch vm stop / finch vm start all commented out lines are removed, meaning I have to go back through and find the syntax again.

Describe the feature you'd like

cpus: 3
memory: 4GiB
# Configured the overlay snapshotter for Finch
snapshotters:
    - overlayfs
# creds_helpers:
#     - ecr-login

Additional context Add any other context or screenshots about the feature request here.

pendo324 commented 11 months ago

This is a long running issue with the YAML library we use: https://github.com/go-yaml/yaml/issues/709. The easy fix we could make for this is to not write default values to disk, which is why we currently parse / re-write the file in the first place. Not sure if the tradeoff is worth it?