misc/vscode-extensions: improve scripts for updating VSC extensions

[cideM]

This PR is a bit out of the blue but I've added my motivation for it under the appropriate heading. It was a fairly spontaneous thing that came up when I was migrating from controlling VSC extensions with VSC to Nix.

Motivation for this change

The current update_installed_exts.sh script does several things. It tries to find the Visual Studio Code (VSC) binary (although it misses -insiders), and then it lists the extensions and prints a Nix object for each extensions which contains the updated version and sha. The idea is that it makes it easy to migrate to having extensions controlled with Nix.

Unfortunately this makes it hard to reuse the functionality in that script in other settings. What if I just want to update a single extension?

I thought it would be nice to just separate the two concerns. As such I've created two separate scripts which are used in the update_installed_exts.sh script, so that it's 100% backwards compatible. The new update_exts.sh script makes it easier to e.g., pipe the name of an extension to it.

# Examples:
#
# $ echo 'ms-toolsai.jupyter' | ./update_exts.sh
#   {
#     name = "jupyter";
#     publisher = "ms-toolsai";
#     version = "2020.12.414227025";
#     sha256 = "1zv5p37qsmp2ycdaizb987b3jw45604vakasrggqk36wkhb4bn1v";
#   }
#
# $ ./list_installed_exts.sh | ./update_exts.sh
# ...lots of output as shown above

Things done

• Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
• Built on platform(s)
  • NixOS
  • macOS
  • other Linux distributions
• Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
• Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• Determined the impact on package closure size (by running nix path-info -S before and after)
• Ensured that relevant documentation is up to date
• Fits CONTRIBUTING.md.

[cideM]

I also need to make sure that the other shell scripts are called relative to the first file, not relative to the working directory. Or maybe it's OK to use relative paths here as long as it's mentioned in the Wiki and the script itself

[SuperSandro2000]

I also need to make sure that the other shell scripts are called relative to the first file, not relative to the working directory. Or maybe it's OK to use relative paths here as long as it's mentioned in the Wiki and the script itself

That should be documented in here https://github.com/NixOS/nixpkgs/tree/master/doc/languages-frameworks

[cideM]

Haven't forgotten was just busy over the weekend, will do the necessary changes over the next couple of days

[cideM]

I had a change of heart and decided to remove the existing script which lists installed extensions. After extracting the other bit it became apparent that listing extensions is a bit of bash when the user can just call code --list-extensions. I don't think abstracting that away helps.

I also added documentation, as was asked. I took some cues from the existing info in the Wiki:

• https://nixos.wiki/wiki/Vscode
• https://nixos.wiki/wiki/VSCodium

Please let me know if that's in the right direction 🙏

[SuperSandro2000]

The examples are quite long. Maybe they could be reduced to the parts that matter for that section?

[SuperSandro2000]

Linking lines will likely break in the future.

[cideM]

Hm yeah that's a good point I'll take that out

[SuperSandro2000]

Not sure why the manual fails to build.

[cideM]

@SuperSandro2000

I updated the PR. I removed all line links. I also overhauled the documentation so it has less superfluous code snippets and gets to the point a bit quicker.

Hopefully fixed doc build by giving the file a valid name

[SuperSandro2000]

Hopefully fixed doc build by giving the file a valid name

It did.

[SuperSandro2000]

Please also add an entry to https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/index.xml and yourself as a codeowner for doc/languages-frameworks/vscode.section.md.

[cideM]

• Added myself to CODEOWNERS for vscode docs
• Fixed link
• Added index entry

[cideM]

Accidentally removed the branch from my fork

[SuperSandro2000]

@jonringer can you take a look at this?

[jonringer]

otherwise looks mostly good to moe

[ShamrockLee]

@cideM @jonringer I'll integrate #121583 with this commit after this PR is merged.

Please take a look at that PR then.

[cideM]

@jonringer I renamed the attribute that was sort of shadowing the package and I also added a paragraph about your FHS changes. It's somewhat duplicated from the Wiki but I'm in general unsure what goes where with regards to Wiki and the official documentation.

i also rearranged some headings to make the different modes of operation a bit more clear. You can ultimately use Nix or the VSC UI and I think that's gonna be the most important question people have, so it should be easy to find.

[cideM]

ping @jonringer (or should I ping someone else?)

[jonringer]

I think this now conflicts with #127741.

We should probably have merged this long ago, sorry

[cideM]

Ah no worries, I'll just close this one then and see if the documentation changes can help with the other PR at least