[vcpkg] Add tab completion for Fish (microsoft#14206)

scripts/vcpkg_completion.fish

@@ -0,0 +1,94 @@
+# vcpkg completions for fish
+set vcpkg_executable (string split -m1 ' ' (commandline -cb))[1]
+
+function _vcpkg_completions
+  set arg (string split -m1 ' ' (commandline -cb))[2]
+  set curr_token (commandline -t)
+  if [ -n $arg ]
+    if [ -z $curr_token ]
+      set arg $arg " "
+    end
+  end
+  for key in ($vcpkg_executable autocomplete "$arg" -- 2>/dev/null)
+    echo $key
+  end
+end
+
+complete -c vcpkg -f --arguments '(_vcpkg_completions)'
+
+set vcpkg_commands ($vcpkg_executable autocomplete)
+
+function _set_triplet_arguments
+  set triplets ($vcpkg_executable help triplet)
+  set -e triplets[(contains -i -- "Available architecture triplets" $triplets)]
+  set -e triplets[(contains -i -- "" $triplets)]
+  set triplet_from ""
+  for triplet in $triplets
+    echo (test -n "$triplet") >> temp.txt
+    if [ (string sub -l5 -- $triplet) = "VCPKG" ]
+      set -l temp (string length $triplet)
+      set triplet_from (string sub -s6 -l(math $temp - 15) -- $triplet)
+    else if [ -n "$triplet" ]
+      complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l triplet -d "$triplet_from" -a (string sub -s3 -- $triplet)
+    end
+  end
+end
+_set_triplet_arguments
+
+# options for all completions
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l triplet -d "Specify the target architecture triplet. See 'vcpkg help triplet' (default: \$VCPKG_DEFAULT_TRIPLET)"
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l overlay-ports -d "Specify directories to be used when searching for ports (also: \$VCPKG_OVERLAY_PORTS)" -a '(__fish_complete_directories)'
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l overlay-triplets -d "Specify directories containing triplets files (also: \$VCPKG_OVERLAY_TRIPLETS)" -a '(__fish_complete_directories)'
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l binarysource -d "Add sources for binary caching. See 'vcpkg help binarycaching'" -a '(__fish_complete_directories)'
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l downloads-root -d "Specify the downloads root directory (default: \$VCPKG_DOWNLOADS)" -a '(__fish_complete_directories)'
+complete -c vcpkg -n "__fish_seen_subcommand_from $vcpkg_commands" -x -l vcpkg-root -d "Specify the vcpkg root directory (default: \$VCPKG_ROOT)" -a '(__fish_complete_directories)'
+
+# options for install
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l dry-run -d "Do not actually build or install"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l head -d "Install the libraries on the command line using the latest upstream sources"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l no-downloads -d "Do not download new sources"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l only-downloads -d "Download sources but don't build packages"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l recurse -d "Allow removal of packages as part of installation"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l keep-going -d "Continue installing packages on failure"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l editable -d "Disable source re-extraction and binary caching for libraries on the command line"
+complete -c vcpkg -n "__fish_seen_subcommand_from install" -f -l clean-after-build -d "Clean buildtrees, packages and downloads after building each package"
+
+# options for edit
+complete -c vcpkg -n "__fish_seen_subcommand_from edit" -f -l buildtrees -d "Open editor into the port-specific buildtree subfolder"
+complete -c vcpkg -n "__fish_seen_subcommand_from edit" -f -l all -d "Open editor into the port as well as the port-specific buildtree subfolder"
+
+# options for export
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l dry-run -d "Do not actually export"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l raw -d "Export to an uncompressed directory"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l nuget -d "Export a NuGet package"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l ifw -d "Export to an IFW-based installer"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l zip -d "Export to a zip file"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l 7zip -d "Export to a 7zip (.7z) file"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l prefab -d "Export to Prefab format"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l prefab-maven -d "Enable maven"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -l prefab-debug -d "Enable prefab debug"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l output -d "Specify the output name (used to construct filename)"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l output-dir -d "Specify the output directory for produced artifacts" -a '(__fish_complete_directories)'
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l nuget-id -d "Specify the id for the exported NuGet package (overrides --output)"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l nuget-version -d "Specify the version for the exported NuGet package"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l ifw-repository-url -d "Specify the remote repository URL for the online installer"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l ifw-packages-directory-path -d "Specify the temporary directory path for the repacked packages"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l ifw-repository-directory-path -d "Specify the directory path for the exported repository"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l ifw-configuration-file-path -d "Specify the temporary file path for the installer configuration"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l ifw-installer-file-path -d "Specify the file path for the exported installer"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l prefab-group-id -d "GroupId uniquely identifies your project according maven specifications"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l prefab-artifact-id -d "Artifact Id is the name of the project according maven specifications"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l prefab-version -d "Version is the name of the project according maven specifications"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l prefab-min-sdk -d "Android minimum supported sdk version"
+complete -c vcpkg -n "__fish_seen_subcommand_from export" -f -r -l prefab-target-sdk -d "Android target sdk version"
+
+# options for remove
+complete -c vcpkg -n "__fish_seen_subcommand_from remove" -f -l purge -d "Remove the cached copy of the package (default)"
+complete -c vcpkg -n "__fish_seen_subcommand_from remove" -f -l no-purge -d "Do not remove the cached copy of the package (deprecated)"
+complete -c vcpkg -n "__fish_seen_subcommand_from remove" -f -l recurse -d "Allow removal of packages not explicitly specified on the command line"
+complete -c vcpkg -n "__fish_seen_subcommand_from remove" -f -l dry-run -d "Print the packages to be removed, but do not remove them"
+complete -c vcpkg -n "__fish_seen_subcommand_from remove" -f -l outdated -d "Select all packages with versions that do not match the portfiles"
+
+# options for upgrade
+complete -c vcpkg -n "__fish_seen_subcommand_from upgrade" -f -l no-dry-run -d "Actually upgrade"
+complete -c vcpkg -n "__fish_seen_subcommand_from upgrade" -f -l keep-going -d "Continue installing packages on failure"

toolsrc/src/vcpkg/commands.integrate.cpp

@@ -477,6 +477,34 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
         fs.write_contents(bashrc_path, Strings::join("\n", bashrc_content) + '\n', VCPKG_LINE_INFO);
         Checks::exit_success(VCPKG_LINE_INFO);
     }
+
+    static void integrate_fish(const VcpkgPaths& paths)
+    {
+        fs::path fish_completions_path;
+        const auto config_path = System::get_environment_variable("XDG_CONFIG_HOME");
+        if (config_path.has_value())
+        {
+            fish_completions_path = fs::path{config_path.value_or_exit(VCPKG_LINE_INFO)};
+        }
+        else
+        {
+            const auto home_path = System::get_environment_variable("HOME").value_or_exit(VCPKG_LINE_INFO);
+            fish_completions_path = fs::path{home_path} / ".config";
+        }
+        fish_completions_path = fish_completions_path / "fish" / "completions" / "vcpkg.fish";
+
+        if (fs::stdfs::exists(fish_completions_path))
+        {
+            System::printf("vcpkg fish completion is already added at %s.\n", fs::u8string(fish_completions_path));
+            Checks::exit_success(VCPKG_LINE_INFO);
+        }
+
+        const fs::path completion_script_path = paths.scripts / "vcpkg_completion.fish";
+
+        System::printf("Adding vcpkg completion entry at %s.\n", fs::u8string(fish_completions_path));
+        fs::stdfs::create_symlink(completion_script_path, fish_completions_path);
+        Checks::exit_success(VCPKG_LINE_INFO);
+    }
 #endif
 
     void append_helpstring(HelpTableFormatter& table)
@@ -491,6 +519,7 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
         table.format("vcpkg integrate install", "Make installed packages available user-wide");
         table.format("vcpkg integrate remove", "Remove user-wide integration");
         table.format("vcpkg integrate bash", "Enable bash tab-completion");
+        table.format("vcpkg integrate fish", "Enable fish tab-completion");
 #endif // ^^^ !defined(_WIN32)
     }
 
@@ -508,6 +537,7 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
         static const std::string PROJECT = "project";
         static const std::string POWERSHELL = "powershell";
         static const std::string BASH = "bash";
+        static const std::string FISH = "x-fish";
     }
 
     static std::vector<std::string> valid_arguments(const VcpkgPaths&)
@@ -518,7 +548,7 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
 #if defined(_WIN32)
                 Subcommand::PROJECT, Subcommand::POWERSHELL,
 #else
-                Subcommand::BASH,
+                Subcommand::BASH, Subcommand::FISH,
 #endif
         };
     }
@@ -557,6 +587,10 @@ With a project open, go to Tools->NuGet Package Manager->Package Manager Console
         {
             return integrate_bash(paths);
         }
+        if (args.command_arguments[0] == Subcommand::FISH)
+        {
+            return integrate_fish(paths);
+        }
 #endif
 
         Checks::exit_with_message(VCPKG_LINE_INFO, "Unknown parameter %s for integrate", args.command_arguments[0]);