Use gist name or description consistent across all extension

🐛 Describe the bug
I am trying to use a different name of the gist and have set "askGistName": true in syncLocalSettings.json but I do not get any prompt asking for the name of the gist.

🌴 Visual Studio Code Version : 1.37.1 🌴 Code Settings Sync Version : 3.4.2 🌴 Standard or Insiders : Standard 🌴 Portable or Installed : Installed 🌴 OSS or Official Build : Official 🌴 Operating System : OSX 10.14.5 (18F132) 🌴 Occurs On: Upload 🌴 Proxy Enabled: N.A. 🌴 Gist Id: N.A.

📰 To Reproduce Steps to reproduce the behavior:

1. Cmnd + p, then >
2. Sync: Update/Upload settings

💪 Expected behavior As per the documentation, there should be a prompt asking for the Gist Name.

[shanalikhan]

This was rather confusing for a new user. Could you at least make Ask Gist Name and Gist Description consistent? Either use name or description, not both (not sure what official GitHub terminology is)

@slavdok alright, sounds good. I will make it consistent.

[slavdok]

@vikas027 I think I figured it out.

First, when you set Ask Gist Name to true, you also have to clear Gist ID. Then upload settings (and it will prompt for a new name)

Second, Gist Description and Gist Name are the same thing. If you want to “Save as” a pre-configured new name, remove Gist ID, fill Gist Description with your desired name and uncheck Ask Gist Name. OR if you want to “Save as” and prompt for a name, then remove Gist ID, and set Ask Gist Name to true (the Gist Description will be ignored in this case).

Third, once a gist is created, you cannot “rename” it through a tool, so changing Gist Description or setting/unsetting Ask Gist Name does absolutely nothing, unless you also clear the Gist ID (which creates a new gist as described above). You can rename on the GitHub side

Fourth. On the GitHub side, it looks like they always list your first file in the gist as the “link”, i.e. yourname / cloudSettings. Since Settings Sync uploads the first file titled “cloudSettings” you will always see that in the list of gits. Your customized Gist Description or the result of your prompt for Ask Gist Name is what’s shown under it

Lastly, when you want to load one of multiple previously saved gists, either manually change the Gist ID, or F1 > Sync: Reset Extension Settings, then click Login with Github, and you will see a window to pick form existing gist

@shanalikhan This was rather confusing for a new user. Could you at least make Ask Gist Name and Gist Description consistent? Either use name or description, not both (not sure what official GitHub terminology is)

Also, I don’t know if it’s possible to disable the form controls on that custom Sync Settings page, but if so, please don’t allow Ask Gist Name and Gist Description while Gist ID is filled in. Only enable these fields when Gist ID is clear. Ideally, Gist Description and Ask Gist Name should be mutually exclusive too, only one or the other selectable.

And thank you for the hard work, this extension is a life saver!