feat: add type safety and lua language server integration (#104)

* feat: add type safety and lua language server integration

* docs: add descriptions to API and start adding descriptions for types

lua/astrotheme/groups/astronvim.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     HighlightURL = { underline = true },

lua/astrotheme/groups/base.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   return {
     --------------------

lua/astrotheme/groups/lsp.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   local error = C.ui.red
   local hint = C.ui.cyan

lua/astrotheme/groups/plugins/aerial.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     AerialNormal = { fg = C.ui.text },

lua/astrotheme/groups/plugins/beacon.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback() return { Beacon = { bg = C.syntax.blue } } end
 
 return callback

lua/astrotheme/groups/plugins/bufferline.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     BufferLineBufferVisible = { fg = C.ui.text_inactive, bg = C.ui.base },

lua/astrotheme/groups/plugins/dashboard-nvim.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     DashboardHeader = { fg = C.syntax.cyan },

lua/astrotheme/groups/plugins/flash.lua

@@ -1,4 +1,5 @@
 -- this is a test to see what i like
+---@type AstroThemeCallback
 local function callback()
   return {
     FlashBackdrop = { fg = C.syntax.mute },

lua/astrotheme/groups/plugins/gitsigns.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     GitSignsAdd = { fg = C.ui.green, bg = C.none },

lua/astrotheme/groups/plugins/hop.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     HopNextKey = { fg = C.ui.red, bold = true },

lua/astrotheme/groups/plugins/indent-blankline.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     IndentBlanklineChar = { fg = C.ui.none_text },

lua/astrotheme/groups/plugins/lazy.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     LazyH1 = { fg = C.ui.base, bg = C.ui.accent, bold = true }, -- home button

lua/astrotheme/groups/plugins/lightspeed.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     LightspeedLabel = { fg = C.ui.red, underline = true },

lua/astrotheme/groups/plugins/mason.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     MasonNormal = { link = "NormalFloat" },

lua/astrotheme/groups/plugins/ministarter.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     MiniStarterItem = { fg = C.ui.text },

lua/astrotheme/groups/plugins/neo-tree.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   return {
     NeoTreeDirectoryIcon = { fg = C.ui.blue },

lua/astrotheme/groups/plugins/neogit.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     NeogitDiffDelete = {

lua/astrotheme/groups/plugins/noice.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     NoiceCursor = { link = "Cursor" },

lua/astrotheme/groups/plugins/nvim-cmp.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     CmpItemAbbr = { fg = C.ui.text },

lua/astrotheme/groups/plugins/nvim-dap-ui.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     DapUIVariable = { link = "Identifier" },

lua/astrotheme/groups/plugins/nvim-notify.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   local bg = (opts.transparent and C.none) or C.ui.tool
 

lua/astrotheme/groups/plugins/nvim-tree.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     NvimTreeFolderIcon = { fg = C.syntax.blue },

lua/astrotheme/groups/plugins/nvim-treesitter.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   return {
 

lua/astrotheme/groups/plugins/nvim-ts-rainbow.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     rainbowcol1 = { fg = "Gold" },

lua/astrotheme/groups/plugins/nvim-ts-rainbow2.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     TSRainbowRed = { fg = C.syntax.red },

lua/astrotheme/groups/plugins/nvim-web-devicons.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     DevIconC = { fg = C.icon.c },

lua/astrotheme/groups/plugins/nvim-window-picker.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     WindowPickerStatusLine = { fg = C.ui.red, bg = C.none },

lua/astrotheme/groups/plugins/rainbow-delimiters.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     RainbowDelimiterRed = { fg = C.syntax.red },

lua/astrotheme/groups/plugins/spotlight.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   local bg = (opts.float and C.ui.base) or (opts.transparent and C.none) or C.ui.base
   local blend = vim.o.winblend or 0

lua/astrotheme/groups/plugins/symbols-outline.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback() return { FocusedSymbol = { fg = C.ui.yellow, bg = C.none } } end
 
 return callback

lua/astrotheme/groups/plugins/telescope.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback(opts)
   local title = {
     fg = (opts.title_invert and C.ui.float) or C.ui.title,

lua/astrotheme/groups/plugins/vimwiki.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     VimwikiLink = { fg = C.syntax.cyan, bg = C.none },

lua/astrotheme/groups/plugins/which-key.lua

@@ -1,3 +1,4 @@
+---@type AstroThemeCallback
 local function callback()
   return {
     WhichKey = { fg = C.ui.cyan },

lua/astrotheme/groups/syntax.lua

@@ -8,6 +8,7 @@
 --       - Character (Subgroup)
 --
 -- Ref: :help group-name
+---@type AstroThemeCallback
 local function callback(opts)
   return {
     -- Comment

lua/astrotheme/init.lua

@@ -3,6 +3,8 @@ local util = require "astrotheme.lib.util"
 
 local M = { config = {} }
 
+--- Load a specific theme given a palette name
+---@param theme string?
 function M.load(theme)
   if
     not theme
@@ -32,6 +34,8 @@ function M.load(theme)
   if M.config.terminal_colors then util.set_terminal_colors() end
 end
 
+--- Set up AstroTheme with provided user configured options
+---@param opts AstroThemeOpts
 function M.setup(opts)
   M.config = require("astrotheme.lib.config").user_config(opts)
   M.config.plugins = util.get_plugin_list(M.config)

lua/astrotheme/lib/config.lua

@@ -1,5 +1,6 @@
 M = {}
 
+---@type AstroThemeOpts
 M.default = {
   palette = "astrodark",
   termguicolors = true,
@@ -35,6 +36,12 @@ M.default = {
   plugins = {},
 }
 
-function M.user_config(opts) return vim.tbl_deep_extend("force", M.default, opts or {}) end
+---@param opts AstroThemeOpts
+---@return AstroThemeOpts
+function M.user_config(opts)
+  local new_config = vim.tbl_deep_extend("force", M.default, opts or {})
+  ---@cast new_config AstroThemeOpts
+  return new_config
+end
 
 return M