User-friendly `config.json` format

weikanglim commented 1 year ago

config.json is currently formatted as nested JSON object:

{
"auth": {
 "account": {
    "currentUser": {
       "homeAccountId":"",
       "tenantId":"",
       "clientId":""
     }
  }
}
}

This is perfectly fine for most applications, but I wonder if we want a more user-friendly format for CLI users to be able to edit directly. I would lean towards having a single nesting like VSCode:

"auth.account.currentUser": {
       "homeAccountId":"",
       "tenantId":"",
       "clientId":""
}

Basically, only one-level of object nesting is allowed. Set(key string, value [map or primitive])

_Originally posted by @weikanglim in https://github.com/Azure/azure-dev/pull/1022#discussion_r1014235810_

vhvb1989 commented 1 year ago

My 50 cents:

Can we follow the same approach we have for azure.yaml and came up with a schema for the file? This would be the best if we are expecting customers to manually update.
Can we make the config file location something dynamic? We can use the home directory as default, but it would be good to let have a way to set the path for where the config file is. This would help in the future, in case we ever want to embed azd into VScode or VS and use VSCode config file to set azd config.

rajeshkamal5050 commented 1 year ago

@vhvb1989 can you take a look at this issue?

rajeshkamal5050 commented 1 year ago

@savannahostrowski @ellismg Not in scope for GA. Moving this to Gallium.

Azure / azure-dev

User-friendly `config.json` format #1091