Disable session

[YanzhaoW]

Describe the problem or limitation you are having
It seems that this plugin will automatically load configs from cache session files in ~/.cache folder. Sometimes this is very undesirable as it prevents the new config from being used.

Describe the solution you'd like

Add an option to not load the session cache files.

[lceWolf]

Just to confirm: Using :CMakeSettings to update the cached session does not work for you?
I guess you are referring to a case where a base setting is changed and you'd have to manually update many cached sessions by hand, right?

[bladevalor]

I guess you are referring to a case where a base setting is changed and you'd have to manually update many cached sessions by hand, right?

Exactly... Autoloading sessions disregards custom plugin configs(e.g the configuration shown below) from the nvim config which makes previous cmake workspaces unaware of the updated settings from the nvim config.

return {
  {
    "Civitasv/cmake-tools.nvim",
    opts = {
      cmake_build_directory = "build",
      cmake_build_options = { "-j5" },
      cmake_use_preset = false,
    },
  },
}

I think autoloading sessions is better if a custom settings file is present in the cmake project root directory(eg Session.toml or Session.lua or Session.json). Absence of this file should imply "cmake-tools.nvim" should obey/repect the nvim config settings then fallback to the default settings of "cmake-tools.nvim" if the user hasn't customized anything

Or just adding a toggle like enable_cached_sessions = false in the opts of this plugin config

[bladevalor]

I think autoloading sessions is better if a custom settings file is present in the cmake project root directory(eg Session.toml or Session.lua or Session.json). Absence of this file should imply "cmake-tools.nvim" should obey/repect the nvim config settings then fallback to the default settings of "cmake-tools.nvim" if the user hasn't customized anything

My quick fix was just to disable session autoloading by deleting the ~/.cache/cmake_tools_nvim folder before the plugin starts:

return {
  {
    "Civitasv/cmake-tools.nvim",

    opts = {
      cmake_build_directory = "build",
      cmake_build_options = { "-j5" },
      cmake_use_preset = false,
    },

    config = function(_, opts)
      -- Delete cached sessions if present
      local cache_path = vim.fn.expand("~/.cache/cmake_tools_nvim")
      if vim.uv.fs_stat(cache_path) then
        vim.fs.rm(cache_path, { recursive = true })
      end

      require("cmake-tools").setup(opts)
    end,
  },
}

[lceWolf]

Simply adding a disable option to turn off session handling entirely comes with significant downsides - things like your selected build and launch targets would never be remembered between sessions. (See here for the full list of what gets cached.)

I could imagine a copy-on-write approach: keep using the defaults from your plugin config until you explicitly change something for a specific project. Only the values that actually differ from your config defaults would be written to the cache - on a per-key basis.

This way, changes you make to your plugin config take effect immediately across all projects, while per-project overrides (made through :CMakeSettings, :CMakeSelectBuildType, etc.) are still remembered

[lceWolf]

@bladevalor mind giving this branch a try and see if it suits your needs?