feat: add better typing support in lua files

miszo · miszo · commit 6ce31c9d6840 · 2024-12-20T12:44:53.000+01:00
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/colorscheme.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/colorscheme.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'catppuccin/nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/conform.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/conform.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'stevearc/conform.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/core.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/core.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'LazyVim/LazyVim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/disabled.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/disabled.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   { 'folke/tokyonight.nvim', enabled = false },
 }
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/editor.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/editor.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   -- Go forward/backward with square brackets
   {
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/git.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/git.lua
@@ -14,6 +14,7 @@ local get_gh_env = function()
   }
 end
 
+---@type LazySpec[]
 return {
   {
     'tpope/vim-fugitive',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/laravel.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/laravel.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'ricardoramirezr/blade-nav.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/lazydev.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/lazydev.lua
@@ -0,0 +1,21 @@
+---@type LazySpec[]
+return {
+  {
+    'folke/lazydev.nvim',
+    dependencies = {
+      { 'Bilal2453/luvit-meta', lazy = true },
+      { 'justinsgithub/wezterm-types', lazy = true },
+    },
+    ft = 'lua',
+    cmd = 'LazyDev',
+    opts = function(_, opts)
+      vim.list_extend(opts.library, {
+        { path = '${3rd}/luv/library', words = { 'vim%.uv' } },
+        { path = '${3rd}/luassert/library', words = { 'assert' } },
+        { path = '${3rd}/busted/library', words = { 'describe' } },
+        { path = 'wezterm-types', mods = { 'wezterm' } },
+        { path = 'lazy.nvim', words = { 'LazySpec' } },
+      })
+    end,
+  },
+}
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/local_plugins.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/local_plugins.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     dir = vim.g.local_plugins_path .. 'copy-filepath',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/lsp.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/lsp.lua
@@ -3,6 +3,7 @@ local get_root_dir = function(...)
   return util.root_pattern('package.json', 'tsconfig.json')(...) or util.root_pattern('.git')(...)
 end
 
+---@type LazySpec[]
 return {
   -- tools
   {
@@ -24,8 +25,9 @@ return {
   -- lsp servers
   {
     'neovim/nvim-lspconfig',
-    ---@class PluginLspOpts
+    ---@type lspconfig.options
     opts = {
+      diagnostics = { virtual_text = { prefix = 'icons' } },
       inlay_hints = { enabled = false },
       servers = {
         cssls = {},
@@ -39,7 +41,7 @@ return {
           init_options = {
             enabledFeatures = {
               'codeActions',
-              'codeLens',
+              -- "codeLens", -- adds "Run/Debug Test" lenses and ruby-lsp-rails "Go to Controller Action Route"
               'completion',
               'definition',
               'diagnostics',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/navigator.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/navigator.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'numToStr/Navigator.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/neotree.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/neotree.lua
@@ -6,6 +6,7 @@ local trash_not_installed = function(commmand_name)
   }, false, {})
 end
 
+---@type LazySpec[]
 return {
   {
     'vhyrro/luarocks.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/op.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/op.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'mrjones2014/op.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/rails.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/rails.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   { 'tpope/vim-rails' },
 }
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/snacks.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/snacks.lua
@@ -119,6 +119,7 @@ local zen = {
   },
 }
 
+---@type LazySpec[]
 return {
   {
     'folke/snacks.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/telescope.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/telescope.lua
@@ -1,6 +1,7 @@
 local Util = require('lazyvim.util')
 local multigrep = require('utils.telescope.multigrep')
 
+---@type LazySpec[]
 return {
   {
     'nvim-telescope/telescope.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/test.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/test.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'nvim-neotest/neotest',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/treesitter.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/treesitter.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   { 'nvim-treesitter/playground', cmd = 'TSPlaygroundToggle' },
   {
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/ts-worksheet.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/ts-worksheet.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'typed-rocks/ts-worksheet-neovim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/typescript.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/typescript.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'dmmulroy/tsc.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/ui.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/ui.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'folke/noice.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/undotree.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/undotree.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'mbbill/undotree',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/urls.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/urls.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'axieax/urlview.nvim',
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/visual-multi.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/visual-multi.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   { 'mg979/vim-visual-multi' },
 }
diff --git a/home/dot_config/exact_nvim/exact_lua/exact_plugins/wich-key.lua b/home/dot_config/exact_nvim/exact_lua/exact_plugins/wich-key.lua
@@ -1,3 +1,4 @@
+---@type LazySpec[]
 return {
   {
     'folke/which-key.nvim',
diff --git a/home/dot_config/exact_nvim/exact_private_snippets/lua.json b/home/dot_config/exact_nvim/exact_private_snippets/lua.json
@@ -0,0 +1,87 @@
+{
+  "Create Auto Command": {
+    "prefix": "autocmd",
+    "body": [
+      "vim.api.nvim_create_autocmd(\"${1:event}\", {",
+      "  group = vim.api.nvim_create_augroup(\"${2:group}\", { clear = true }),",
+      "  callback = function(ev)",
+      "    ${0}",
+      "  end",
+      "})"
+    ]
+  },
+  "Create Auto Command Group": {
+    "prefix": "augroup",
+    "body": [
+      "vim.api.nvim_create_augroup(\"${1:group}\", { clear = true })$0"
+    ]
+  },
+  "Current Win": {
+    "prefix": "win",
+    "body": "local win = vim.api.nvim_get_current_win()\n$0"
+  },
+  "Current Buf": {
+    "prefix": "buf",
+    "body": "local buf = vim.api.nvim_get_current_buf()\n$0"
+  },
+  "Buf Valid": {
+    "prefix": "bufvalid",
+    "body": "vim.api.nvim_buf_is_valid(${1:buf})"
+  },
+  "Win Valid": {
+    "prefix": "winvalid",
+    "body": "vim.api.nvim_win_is_valid(${1:win})"
+  },
+  "Win Call": {
+    "prefix": "wincall",
+    "body": [
+      "vim.api.nvim_win_call(${1:win}, function(win)",
+      "  ${0}",
+      "end)"
+    ]
+  },
+  "Buf Call": {
+    "prefix": "bufcall",
+    "body": [
+      "vim.api.nvim_buf_call(${1:buf}, function(buf)",
+      "  ${0}",
+      "end)"
+    ]
+  },
+  "Schedule": {
+    "prefix": "schedule",
+    "body": [
+      "vim.schedule(function()",
+      "  ${0}",
+      "end)"
+    ]
+  },
+  "Table Deep Extend": {
+    "prefix": "deepextend",
+    "body": "vim.tbl_deep_extend(\"force\", ${1:table}, ${2:table})$0"
+  },
+  "Table Filter": {
+    "prefix": "filter",
+    "body": [
+      "vim.tbl_filter(function()",
+      "  $0",
+      "end, ${1:table})"
+    ]
+  },
+  "Table Map": {
+    "prefix": "map",
+    "body": [
+      "vim.tbl_map(function()",
+      "  $0",
+      "end, ${1:table})"
+    ]
+  },
+  "Table Values": {
+    "prefix": "values",
+    "body": "vim.tbl_values(${1:table})"
+  },
+  "Table Keys": {
+    "prefix": "keys",
+    "body": "vim.tbl_keys(${1:table})"
+  }
+}
diff --git a/home/dot_config/exact_nvim/exact_queries/exact_caddy/highlights.scm b/home/dot_config/exact_nvim/exact_queries/exact_caddy/highlights.scm
@@ -0,0 +1,64 @@
+[
+  (http_error_code)
+  (http_status_code)
+  (size_number)
+] @number
+
+(snippet_name) @function
+
+(_ directive_type: _ @keyword)
+
+
+; (_ respond_or_error_option_message: _ @function.method)
+
+(_ matcher_type: _ @function.macro)
+
+; (_ basicauth_user_name: _ @string)
+; (_ basicauth_user_pass: _ @string)
+; (_ basicauth_user_pass_saltb64: _ @string)
+; (_ respond_or_error_message: _ @string)
+
+(_ path_regexp_matcher_value: _ @string)
+
+(_ global_option_type: _ @function.method)
+
+(_ directive_option_name: _ @function.method)
+
+(_ directive_option_fixed_value: _ @variable.parameter)
+
+(_ directive_option_user_string_value: _ @string)
+
+[
+  (matcher_name)
+  (matcher_token)
+] @tag
+
+(header_name) @variable.parameter
+
+[
+  (header_value)
+  (unix_path)
+  (email_address)
+  (http_message)
+] @string
+
+(comment_line) @comment
+
+(site_address) @constant
+
+[
+  "stdout"
+  "stderr"
+  "discard"
+  "file"
+
+  "console"
+  "json"
+
+  "info"
+  "INFO"
+  "error"
+  "ERROR"
+] @constant.builtin
+
+["{" "}"] @punctuation.bracket
diff --git a/home/dot_config/exact_wezterm/exact_config/keys.lua b/home/dot_config/exact_wezterm/exact_config/keys.lua
@@ -49,7 +49,7 @@ function M.setup(config)
     activate_pane(window, pane, 'Down', 'j')
   end)
 
-  config.leader = { key = 'q', mods = 'ALT', timeout_milliseconds = 2000 }
+  config.leader = { key = 'b', mods = 'CTRL', timeout_milliseconds = 2000 }
   config.keys = {
     -- Pane keybindings
     { key = 's', mods = 'LEADER', action = act.SplitVertical({ domain = 'CurrentPaneDomain' }) },

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+---@type LazySpec[]`
`1`	`2`	`return {`
`2`	`3`	`{`
`3`	`4`	`'catppuccin/nvim',`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ local get_gh_env = function()`
`14`	`14`	`}`
`15`	`15`	`end`
`16`	`16`
	`17`	`+---@type LazySpec[]`
`17`	`18`	`return {`
`18`	`19`	`{`
`19`	`20`	`'tpope/vim-fugitive',`