feat: adds command to open the cmake cache file (#309)

Co-authored-by: Ben Leadbetter <[email protected]>

Author: BenLeadbetter

docs/all_commands.md

@@ -20,6 +20,7 @@
 | CMakeSelectCwd                  | Opens an input popup to select a directory with the main CMakeLists.txt file. If there's an argument given, that will be treated as the path to the main directory. Attention if you change current working dir, the build directory will still be as before, to change build directory, you should use `CMakeSelectBuildDir`.                                                                                                                   |
 | CMakeSelectBuildDir                  | Opens an input popup to select a directory where should the build files in. If there's an argument given, that will be treated as the path to the build directory.                                                                                                                   |
 | CMakeOpen(Executor/Runner)                       | Open CMake Executor/Runner window                                                                                                                                                                                                                                                                     |
+| CMakeOpenCache                                   | Open CMakeCache.txt             |
 | CMakeClose(Executor/Runner)                      | Close CMake Executor/Runner window                                                                                                                                                                                                                                                                    |
 | CMakeInstall                    | Install CMake targets. Additional arguments will be passed to "cmake" command.                                                                                                                                                                                                        |
 | CMakeClean                      | Cleans All targets, intermediates and deps                                                                                                                                                                                                                                            |

lua/cmake-tools/init.lua

@@ -463,6 +463,17 @@ function cmake.open_runner()
   utils.show_runner(config.runner)
 end
 
+function cmake.open_cache()
+  local path = cmake.get_build_directory() .. "/CMakeCache.txt"
+  local file = io.open(path, "r")
+  if file then
+    file:close()
+    vim.cmd("edit " .. path)
+  else
+    vim.notify("CMakeCache.txt not found", vim.log.levels.ERROR)
+  end
+end
+
 function cmake.substitute_path(path, vars)
   for key, value in pairs(vars) do
     if type(value) == "string" or type(value) == "number" then

plugin/cmake-tools.lua

@@ -108,6 +108,15 @@ vim.api.nvim_create_user_command(
   }
 )
 
+--- CMake open cache
+vim.api.nvim_create_user_command(
+  "CMakeOpenCache", -- name
+  cmake_tools.open_cache, -- command
+  { -- opts
+    desc = "Open CMakeCache.txt",
+  }
+)
+
 --- CMake run
 vim.api.nvim_create_user_command(
   "CMakeRun", -- name