chore(presets): add annotations

Author: Denzel

lua/cmake-tools/build_preset.lua

@@ -1,8 +1,12 @@
 local Path = require("plenary.path")
 local osys = require("cmake-tools.osys")
 
+---@class BuildPreset: CMakeBuildPreset
 local BuildPreset = {}
 
+---@param cwd string
+---@param obj CMakeBuildPreset?
+---@return BuildPreset
 function BuildPreset:new(cwd, obj)
   local instance = setmetatable(obj or {}, { __index = self })
   instance.__index = self
@@ -16,6 +20,7 @@ function BuildPreset:new(cwd, obj)
   return instance
 end
 
+---@return string[]|nil
 function BuildPreset:get_build_target()
   if self.targets == nil then
     return nil
@@ -28,13 +33,15 @@ function BuildPreset:get_build_target()
   return nil
 end
 
+---@return string|nil
 function BuildPreset:get_build_type()
   if self.configuration == nil then
     return nil
   end
   return self.configuration
 end
 
+---@return boolean
 function BuildPreset:is_valid()
   return self.valid
 end

lua/cmake-tools/preset.lua

@@ -2,6 +2,7 @@ local Path = require("plenary.path")
 local osys = require("cmake-tools.osys")
 local utils = require("cmake-tools.utils")
 
+---@class ConfigurePreset: CMakeConfigurePreset
 local Preset = {}
 
 local function expandMacro(self, str)
@@ -255,6 +256,10 @@ local function parseTree(self, get_preset)
   end
 end
 
+---@param cwd string
+---@param obj CMakeConfigurePreset?
+---@param get_preset fun(name: string): CMakeConfigurePreset?
+---@return ConfigurePreset
 function Preset:new(cwd, obj, get_preset)
   local instance = setmetatable(obj or {}, self)
   instance.__index = self
@@ -271,10 +276,12 @@ function Preset:new(cwd, obj, get_preset)
   return instance
 end
 
+---@return string
 function Preset:get_build_type()
   return self.cacheVariables and self.cacheVariables.CMAKE_BUILD_TYPE or "Debug"
 end
 
+---@return string[]|nil
 function Preset:get_build_configuration_types()
   local generator = self.generator
   local multi_configuration_generator = { "Visual Studio", "Xcode", "Ninja Multi-Config" }

lua/cmake-tools/presets.lua

@@ -91,8 +91,14 @@ local function decode(file, visited)
   return data
 end
 
+---@class Presets
+---@field configurePresets ConfigurePreset[]
+---@field buildPresets BuildPreset[]
+---@field testPresets TestPreset[]
 local Presets = {}
 
+---@param cwd string
+---@return Presets
 function Presets:parse(cwd)
   local function merge_presets(lhs, rhs)
     local ret = vim.deepcopy(lhs)
@@ -185,14 +191,20 @@ local function get_preset_names(presets, opts)
   return options
 end
 
+---@param opts table?
+---@return string[]
 function Presets:get_configure_preset_names(opts)
   return get_preset_names(self.configurePresets, opts)
 end
 
+---@param opts table?
+---@return string[]
 function Presets:get_test_preset_names(opts)
   return get_preset_names(self.testPresets, opts)
 end
 
+---@param opts table
+---@return string[]
 function Presets:get_build_preset_names(opts)
   local presets = get_preset_names(self.buildPresets, opts)
   local ret = {}
@@ -231,18 +243,29 @@ local function get_preset(name, tbl, opts)
   end
 end
 
+---@param name string
+---@param opts table?
+---@return ConfigurePreset?
 function Presets:get_configure_preset(name, opts)
   return get_preset(name, self.configurePresets, opts)
 end
 
+---@param name string
+---@param opts table?
+---@return TestPreset?
 function Presets:get_test_preset(name, opts)
   return get_preset(name, self.testPresets, opts)
 end
 
+---@param name string
+---@param opts table?
+---@return BuildPreset?
 function Presets:get_build_preset(name, opts)
   return get_preset(name, self.buildPresets, { include_hidden = true, include_disabled = true })
 end
 
+---@param cwd string
+---@return string?, string?
 function Presets.find_preset_files(cwd)
   local files = vim.fn.readdir(cwd)
   local presetFiles = {}
@@ -263,6 +286,8 @@ function Presets.find_preset_files(cwd)
   return unpack(presetFiles)
 end
 
+---@param cwd string
+---@return boolean
 function Presets.exists(cwd)
   return Presets.find_preset_files(cwd) ~= nil
 end

lua/types/cmake-preset/build_preset.lua

@@ -0,0 +1,21 @@
+---@meta _
+
+---@class CMakeBuildPreset
+---@field name string
+---@field hidden boolean?
+---@field inherits string|string[]?
+---@field condition CMakeCondition?
+---@field vendor table?
+---@field displayName string?
+---@field description string?
+---@field environment table<string, string?>?
+---@field configurePreset string?
+---@field inheritConfigureEnvironment boolean?
+---@field jobs integer?
+---@field targets string|string[]?
+---@field configuration string?
+---@field cleanFirst boolean?
+---@field resolvePackageReferences ("on"|"off"|"only")?
+---@field verbose boolean?
+---@field nativeToolOptions string[]?
+---@field disabled boolean?

lua/types/cmake-preset/configure_preset.lua

@@ -0,0 +1,60 @@
+---@meta _
+
+---@class CMakeConfigurePresetArchitecture
+---@field value string?
+---@field strategy ("set"|"external")?
+
+---@class CMakeConfigurePresetToolset
+---@field value string?
+---@field strategy ("set"|"external")?
+
+---@class CMakeConfigurePresetCacheVariable
+---@field type string?
+---@field value string|boolean
+
+---@class CMakeConfigurePresetWarnings
+---@field dev boolean?
+---@field deprecated boolean?
+---@field uninitialized boolean?
+---@field unusedCli boolean?
+---@field systemVars boolean?
+
+---@class CMakeConfigurePresetErrors
+---@field dev boolean?
+---@field deprecated boolean?
+
+---@class CMakeConfigurePresetDebug
+---@field output boolean?
+---@field tryCompile boolean?
+---@field find boolean?
+
+---@class CMakeConfigurePresetTrace
+---@field mode ("on"|"off"|"expand")?
+---@field format ("human"|"json-v1")?
+---@field source string|string[]?
+---@field redirect string?
+
+---@class CMakeConfigurePreset
+---@field name string
+---@field hidden boolean?
+---@field inherits string|string[]?
+---@field condition CMakeCondition?
+---@field vendor table?
+---@field displayName string?
+---@field description string?
+---@field generator string?
+---@field architecture string|CMakeConfigurePresetArchitecture?
+---@field toolset string|CMakeConfigurePresetToolset?
+---@field toolchainFile string?
+---@field graphviz string?
+---@field binaryDir string?
+---@field binaryDirExpanded string?
+---@field installDir string?
+---@field cmakeExecutable string?
+---@field cacheVariables table<string, string|boolean|CMakeConfigurePresetCacheVariable?>?
+---@field environment table<string, string?>?
+---@field warnings CMakeConfigurePresetWarnings?
+---@field errors CMakeConfigurePresetErrors?
+---@field debug CMakeConfigurePresetDebug?
+---@field trace CMakeConfigurePresetTrace?
+---@field disabled boolean?

lua/types/cmake-preset/test_preset.lua

@@ -60,7 +60,6 @@
 
 ---@class CMakeTestPreset
 ---@field name string
----@field valid boolean
 ---@field hidden boolean?
 ---@field inherits string|string[]?
 ---@field condition CMakeCondition?
@@ -76,4 +75,3 @@
 ---@field filter CMakeTestPresetFilter?
 ---@field execution CMakeTestPresetExecution?
 ---@field disabled boolean?
----@field cwd string