yaml configuration support

sogaoh commented 2 years ago

Description

v1.3 時点ではオプションでの Configuration は json (+アルファ?) 形式での設定が想定されているように感じます。設定を yaml で行えるようになっていると、コメントが書きやすい・フォーマット(lint)を気にする機会が減る、と思うので可能であれば yaml 対応いただきたいです。

Use Case

Configuration の末尾等にコメントを記述する場合（行頭に書ける json なのも地味に凄い）
オプションを書き換える時にカンマが残っているかを気にしなくて良くなると思う

Proposed Solution

yaml 形式での Configuration 画面が追加であると良さそう
- json と両方ある場合は json 優先で良いように思います
現状の Configuration を json か yaml か選択させるようにしてそれに従ってパースする、でも良いかもしれません

Other information

No response

Acknowledge

[ ] I may be able to implement this feature request
[ ] This feature might incur a breaking change

umireon commented 2 years ago

YAMLパーサーはJSONもパースできるので、コンフィグのパースをJSON.parseからYAMLのライブラリに置き換えるだけでこれは実現できます

xhiroga commented 2 years ago

いいですね！ JSONCもパースしてくれるかは確認したいところです。

もしくは変換はユーザーに任せ、URL経由でJSONを読み取るという手も…

umireon commented 2 years ago

JSONCのパースはYAMLのライブラリでは無理そうです。

#か-で始まったらYAML、/か[で始まったらJSONCとしてパースすればいいんじゃないでしょうか？

umireon commented 2 years ago

const configListIsYaml = (configList: string) => /^\s*[#-]/.test(configList)
const configListIsJsonc = (configList: string) => /^\s*[\/\[]/.test(configList)

configListIsYaml(configList) ? YAML.parse(configList) :
configListIsJsonc(configList) ? JSONC.parse(configList) :
JSON.parse(configList)

xhiroga commented 2 years ago

Now YAML supported!!!

(Account ID is dummy)

xhiroga / aws-peacock-management-console