From 65bbf7fd61799485e779dbc1f3375a5feea75aaa Mon Sep 17 00:00:00 2001
From: rootiest <chris@rootiest.com>
Date: Sun, 21 Jul 2024 11:57:40 -0400
Subject: [PATCH] =?UTF-8?q?=F0=9F=92=A1=20Add=20better=20plugin=20comments?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Add an identifying comment for each plugin
---
 lua/config/check-files.lua |  5 ++++
 lua/config/ui.lua          | 16 ++++++-----
 lua/plugins/coding.lua     | 26 +++++++++++-------
 lua/plugins/dashboard.lua  |  2 +-
 lua/plugins/debug.lua      |  8 ++++--
 lua/plugins/editor.lua     | 36 ++++++++++++++++---------
 lua/plugins/languages.lua  | 43 ++++++++++++++++++++---------
 lua/plugins/terminal.lua   | 16 +++++------
 lua/plugins/themes.lua     | 32 +++++++++++-----------
 lua/plugins/util.lua       | 55 ++++++++++++++++++++++++++------------
 10 files changed, 154 insertions(+), 85 deletions(-)

diff --git a/lua/config/check-files.lua b/lua/config/check-files.lua
index 555b7ea..0c5c0a3 100644
--- a/lua/config/check-files.lua
+++ b/lua/config/check-files.lua
@@ -41,3 +41,8 @@ end
 if vim.fn.filereadable(vim.fn.stdpath("config") .. "/.wakatime") ~= 1 then
   vim.fn.writefile({ "true" }, vim.fn.stdpath("config") .. "/.wakatime")
 end
+
+-- Check if the .hardtime file exists
+if vim.fn.filereadable(vim.fn.stdpath("config") .. "/.hardtime") ~= 1 then
+  vim.fn.writefile({ "false" }, vim.fn.stdpath("config") .. "/.hardtime")
+end
diff --git a/lua/config/ui.lua b/lua/config/ui.lua
index f8554fd..3ae70bf 100644
--- a/lua/config/ui.lua
+++ b/lua/config/ui.lua
@@ -3,14 +3,18 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  { import = "lazyvim.plugins.extras.ui.edgy" },
-  { import = "lazyvim.plugins.extras.ui.mini-animate" },
-  {
+  { -- Edgy
+    import = "lazyvim.plugins.extras.ui.edgy",
+  },
+  { -- Mini-animate
+    import = "lazyvim.plugins.extras.ui.mini-animate",
+  },
+  { -- Transparent
     "xiyaowong/transparent.nvim",
     event = "VeryLazy",
     config = true,
   },
-  {
+  { -- Auto Dark Mode
     "f-person/auto-dark-mode.nvim",
     lazy = true,
     opts = {
@@ -33,7 +37,7 @@ return {
       return not ssh
     end,
   },
-  {
+  { -- Hlchunk
     "shellRaining/hlchunk.nvim",
     event = "BufEnter",
     config = function()
@@ -113,7 +117,7 @@ return {
       require("hlchunk").setup(common_config)
     end,
   },
-  {
+  { -- Alternate
     "ton/vim-alternate",
     event = "VeryLazy",
   },
diff --git a/lua/plugins/coding.lua b/lua/plugins/coding.lua
index 54a961b..5fe1497 100644
--- a/lua/plugins/coding.lua
+++ b/lua/plugins/coding.lua
@@ -3,7 +3,7 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  {
+  { -- Codeium
     import = "lazyvim.plugins.extras.coding.codeium",
     cond = function()
       if
@@ -14,7 +14,7 @@ return {
       end
     end,
   },
-  {
+  { -- Copilot
     import = "lazyvim.plugins.extras.coding.copilot",
     cond = function()
       if
@@ -25,7 +25,7 @@ return {
       end
     end,
   },
-  {
+  { -- Tabnine
     import = "lazyvim.plugins.extras.coding.tabnine",
     cond = function()
       if
@@ -36,7 +36,7 @@ return {
       end
     end,
   },
-  {
+  { -- Minuet-AI
     "milanglacier/minuet-ai.nvim",
     dependencies = { { "nvim-lua/plenary.nvim" }, { "hrsh7th/nvim-cmp" } },
     config = function()
@@ -51,10 +51,16 @@ return {
       end
     end,
   },
-  { import = "lazyvim.plugins.extras.coding.yanky" },
-  { import = "lazyvim.plugins.extras.coding.mini-surround" },
-  { import = "lazyvim.plugins.extras.vscode" },
-  {
+  { -- Yanky
+    import = "lazyvim.plugins.extras.coding.yanky",
+  },
+  { -- Mini Surround
+    import = "lazyvim.plugins.extras.coding.mini-surround",
+  },
+  { -- VSCode
+    import = "lazyvim.plugins.extras.vscode",
+  },
+  { -- Mini Align
     "echasnovski/mini.align",
     event = "InsertEnter",
     config = function()
@@ -103,14 +109,14 @@ return {
       "Dynge/gitmoji.nvim",
     },
   },
-  {
+  { -- Colorizer
     "norcalli/nvim-colorizer.lua",
     event = "InsertEnter",
     config = function()
       require("colorizer").setup()
     end,
   },
-  {
+  { -- Substitute
     "gbprod/substitute.nvim",
     event = "InsertEnter",
     opts = {
diff --git a/lua/plugins/dashboard.lua b/lua/plugins/dashboard.lua
index 71438b2..beb0968 100644
--- a/lua/plugins/dashboard.lua
+++ b/lua/plugins/dashboard.lua
@@ -2,7 +2,7 @@
 -- -------------------------------- DASHBOARD ----------------------------------
 -- -----------------------------------------------------------------------------
 
-return {
+return { -- Dashboard
   "nvimdev/dashboard-nvim",
   opts = function()
     if vim.fn.winheight(0) >= 80 and vim.fn.winwidth(0) >= 80 then
diff --git a/lua/plugins/debug.lua b/lua/plugins/debug.lua
index b87965c..0193ffa 100644
--- a/lua/plugins/debug.lua
+++ b/lua/plugins/debug.lua
@@ -3,6 +3,10 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  { import = "lazyvim.plugins.extras.dap.core" },
-  { import = "lazyvim.plugins.extras.dap.nlua" },
+  { -- DAP Core
+    import = "lazyvim.plugins.extras.dap.core",
+  },
+  { -- DAP Neovim Lua Adapter
+    import = "lazyvim.plugins.extras.dap.nlua",
+  },
 }
diff --git a/lua/plugins/editor.lua b/lua/plugins/editor.lua
index 42cdd7f..6c20ee5 100644
--- a/lua/plugins/editor.lua
+++ b/lua/plugins/editor.lua
@@ -3,12 +3,22 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  { import = "lazyvim.plugins.extras.editor.aerial" },
-  { import = "lazyvim.plugins.extras.editor.dial" },
-  { import = "lazyvim.plugins.extras.editor.illuminate" },
-  { import = "lazyvim.plugins.extras.editor.outline" },
-  { import = "lazyvim.plugins.extras.editor.telescope" },
-  {
+  { -- Aerial
+    import = "lazyvim.plugins.extras.editor.aerial",
+  },
+  { -- Dial
+    import = "lazyvim.plugins.extras.editor.dial",
+  },
+  { -- Illuminate
+    import = "lazyvim.plugins.extras.editor.illuminate",
+  },
+  { -- Outline
+    import = "lazyvim.plugins.extras.editor.outline",
+  },
+  { -- Telescope
+    import = "lazyvim.plugins.extras.editor.telescope",
+  },
+  { -- Which-Key
     "folke/which-key.nvim",
     opts = {
       preset = "modern",
@@ -19,7 +29,7 @@ return {
       },
     },
   },
-  {
+  { -- CodeWindow
     "gorbit99/codewindow.nvim",
     event = "InsertEnter",
     config = function()
@@ -49,12 +59,12 @@ return {
       require("codewindow").apply_default_keybinds()
     end,
   },
-  {
+  { -- Persistence
     "folke/persistence.nvim",
     event = "BufReadPre",
     opts = {},
   },
-  {
+  { -- Remote-nvim
     "amitds1997/remote-nvim.nvim",
     event = "VeryLazy",
     version = "*", -- Pin to GitHub releases
@@ -65,7 +75,7 @@ return {
     },
     config = true,
   },
-  {
+  { -- DeadColumn
     "Bekaboo/deadcolumn.nvim",
     event = "VeryLazy",
     config = function()
@@ -94,16 +104,16 @@ return {
       vim.cmd(":set colorcolumn=120")
     end,
   },
-  {
+  { -- Precognition
     "tris203/precognition.nvim",
     event = "VeryLazy",
   },
-  {
+  { -- Zen Mode
     "folke/zen-mode.nvim",
     event = "VeryLazy",
     opts = {},
   },
-  {
+  { -- SmoothCursor
     "gen740/SmoothCursor.nvim",
     event = "InsertEnter",
     lazy = true,
diff --git a/lua/plugins/languages.lua b/lua/plugins/languages.lua
index 722bf87..2244a90 100644
--- a/lua/plugins/languages.lua
+++ b/lua/plugins/languages.lua
@@ -3,22 +3,41 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  { import = "lazyvim.plugins.extras.lang.json" },
-  { import = "lazyvim.plugins.extras.lang.markdown" },
-  { import = "lazyvim.plugins.extras.lang.toml" },
-  { import = "lazyvim.plugins.extras.lang.git" },
-  { import = "lazyvim.plugins.extras.lang.python" },
-  { import = "lazyvim.plugins.extras.lang.toml" },
-  {
+  { -- JSON
+    import = "lazyvim.plugins.extras.lang.json",
+  },
+  { -- Markdown
+    import = "lazyvim.plugins.extras.lang.markdown",
+  },
+  { -- Toml
+    import = "lazyvim.plugins.extras.lang.toml",
+  },
+  { -- Git
+    import = "lazyvim.plugins.extras.lang.git",
+  },
+  { -- Python
+    import = "lazyvim.plugins.extras.lang.python",
+  },
+  { -- Yaml
+    import = "lazyvim.plugins.extras.lang.yaml",
+  },
+  { -- clangd
+    import = "lazyvim.plugins.extras.lang.clangd",
+  },
+  { -- cmake
+    import = "lazyvim.plugins.extras.lang.cmake",
+  },
+  { -- Docker
+    import = "lazyvim.plugins.extras.lang.docker",
+  },
+  { -- Java
+    import = "lazyvim.plugins.extras.lang.java",
+  },
+  { -- Markdown-Preview
     "iamcco/markdown-preview.nvim",
     build = "cd app && yarn install",
     init = function()
       vim.g.mkdp_filetypes = { "markdown" }
     end,
   },
-  { import = "lazyvim.plugins.extras.lang.yaml" },
-  { import = "lazyvim.plugins.extras.lang.clangd" },
-  { import = "lazyvim.plugins.extras.lang.cmake" },
-  { import = "lazyvim.plugins.extras.lang.docker" },
-  { import = "lazyvim.plugins.extras.lang.java" },
 }
diff --git a/lua/plugins/terminal.lua b/lua/plugins/terminal.lua
index 612c943..04f1a2b 100644
--- a/lua/plugins/terminal.lua
+++ b/lua/plugins/terminal.lua
@@ -12,7 +12,7 @@ package.path = package.path
   .. "/.luarocks/share/lua/5.1/?.lua"
 
 return {
-  {
+  { -- ToggleTerm
     "akinsho/toggleterm.nvim",
     event = "VeryLazy",
     config = function()
@@ -52,7 +52,7 @@ return {
       })
     end,
   },
-  {
+  { -- Kitty-Navigator
     "MunsMan/kitty-navigator.nvim",
     build = {
       "cp navigate_kitty.py ~/.config/kitty",
@@ -64,7 +64,7 @@ return {
       return kit ~= nil
     end,
   },
-  {
+  { -- Kitty-Runner
     "jghauser/kitty-runner.nvim",
     cond = function() -- Using Kitty
       local term = os.getenv("TERM") or ""
@@ -72,7 +72,7 @@ return {
       return kit ~= nil
     end,
   },
-  {
+  { -- Kitty-Scrollback
     "mikesmithgh/kitty-scrollback.nvim",
     enabled = true,
     lazy = true,
@@ -85,7 +85,7 @@ return {
       end
     end,
   },
-  {
+  { -- Image Renderer
     "3rd/image.nvim",
     config = function()
       require("image").setup()
@@ -108,7 +108,7 @@ return {
       end
     end,
   },
-  {
+  { -- WezTerm
     "willothy/wezterm.nvim",
     config = true,
     cond = function() -- Using WezTerm
@@ -116,7 +116,7 @@ return {
       return wterm and string.find(wterm, "WezTerm")
     end,
   },
-  {
+  { -- Tmux
     "aserowy/tmux.nvim",
     config = function()
       return require("tmux").setup()
@@ -134,7 +134,7 @@ return {
       end
     end,
   },
-  {
+  { -- Navigator (wezterm/tmux)
     "numToStr/Navigator.nvim",
     config = function()
       require("Navigator").setup()
diff --git a/lua/plugins/themes.lua b/lua/plugins/themes.lua
index 5b35794..ebdba9f 100644
--- a/lua/plugins/themes.lua
+++ b/lua/plugins/themes.lua
@@ -3,55 +3,55 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  {
+  { -- Tokyonight
     "folke/tokyonight.nvim",
     lazy = false, -- Override
   },
-  {
+  { -- Catppuccin
     "catppuccin/nvim",
     lazy = false, -- Override
   },
-  {
+  { -- Ayu
     "Shatur/neovim-ayu",
   },
-  {
+  { -- Dracula
     "Mofiqul/dracula.nvim",
   },
-  {
+  { -- Eldritch
     "eldritch-theme/eldritch.nvim",
   },
-  {
+  { -- Github-theme
     "projekt0n/github-nvim-theme",
   },
-  {
+  { -- Gruvbox
     "ellisonleao/gruvbox.nvim",
   },
-  {
+  { -- Kanagawa
     "rebelot/kanagawa.nvim",
   },
-  {
+  { -- Monochrome
     "kdheepak/monochrome.nvim",
   },
-  {
+  { -- NeoFusion
     "diegoulloao/neofusion.nvim",
   },
-  {
+  { -- Nord
     "shaunsingh/nord.nvim",
   },
-  {
+  { -- One Dark Pro
     "olimorris/onedarkpro.nvim",
   },
-  {
+  { -- Oxocarbon
     "nyoom-engineering/oxocarbon.nvim",
   },
-  {
+  { -- Paper
     "https://gitlab.com/yorickpeterse/vim-paper.git",
   },
-  {
+  { -- Rose-Pine
     "rose-pine/neovim",
     name = "rose-pine",
   },
-  {
+  { -- Umbra
     "LZDQ/umbra.nvim",
   },
 }
diff --git a/lua/plugins/util.lua b/lua/plugins/util.lua
index a9fc53c..90ffea0 100644
--- a/lua/plugins/util.lua
+++ b/lua/plugins/util.lua
@@ -3,15 +3,23 @@
 -- -----------------------------------------------------------------------------
 
 return {
-  {
+  { -- Project management
     import = "lazyvim.plugins.extras.util.project",
     opts = { manual_mode = false },
   },
-  { import = "lazyvim.plugins.extras.util.chezmoi" },
-  { import = "lazyvim.plugins.extras.util.dot" },
-  { import = "lazyvim.plugins.extras.util.gitui" },
-  { import = "lazyvim.plugins.extras.util.octo" },
-  {
+  { -- Chezmoi
+    import = "lazyvim.plugins.extras.util.chezmoi",
+  },
+  { -- Dotfiles plugins
+    import = "lazyvim.plugins.extras.util.dot",
+  },
+  { -- Git UI
+    import = "lazyvim.plugins.extras.util.gitui",
+  },
+  { -- Octo plugin
+    import = "lazyvim.plugins.extras.util.octo",
+  },
+  { -- Wakatime
     "wakatime/vim-wakatime",
     cond = function()
       if
@@ -22,7 +30,7 @@ return {
       end
     end,
   },
-  {
+  { -- Link following
     "chrishrb/gx.nvim",
     cmd = { "Browse" },
     init = function()
@@ -31,27 +39,27 @@ return {
     dependencies = { "nvim-lua/plenary.nvim" },
     config = true,
   },
-  {
+  { -- Auto-save
     "Pocco81/auto-save.nvim",
     config = function()
       require("auto-save").setup({})
     end,
   },
-  {
+  { -- User is bored
     "mikesmithgh/ugbi",
     event = "VeryLazy",
   },
-  {
+  { -- Ripgrep substitute
     "chrisgrieser/nvim-rip-substitute",
     cmd = "RipSubstitute",
   },
-  {
+  { -- Gist Tools
     "Rawnly/gist.nvim",
     event = "VeryLazy",
     cmd = { "GistCreate", "GistCreateFromFile", "GistsList" },
     config = true,
   },
-  {
+  { -- Unception
     "samjwill/nvim-unception",
     init = function()
       vim.g.unception_block_while_host_edits = true
@@ -64,7 +72,7 @@ return {
       require("icon-picker").setup({ disable_legacy_commands = true })
     end,
   },
-  {
+  { -- LazyGit
     "kdheepak/lazygit.nvim",
     event = "VeryLazy",
     cmd = {
@@ -78,7 +86,7 @@ return {
       "nvim-lua/plenary.nvim",
     },
   },
-  {
+  { -- Codesnap
     "mistricky/codesnap.nvim",
     event = "InsertEnter",
     build = "make",
@@ -92,22 +100,35 @@ return {
       code_font_size = 12,
     },
   },
-  {
+  { -- Kulala
     "mistweaverco/kulala.nvim",
     event = "InsertEnter",
     config = function()
       require("kulala").setup()
     end,
   },
-  {
+  { -- Fugitive
     "tpope/vim-fugitive",
     event = "InsertEnter",
     dependencies = { "tpope/vim-rhubarb" },
   },
-  {
+  { -- Thanks/github-stars
     "jsongerber/thanks.nvim",
     config = {
       star_on_install = false,
     },
   },
+  { -- Hardtime
+    "m4xshen/hardtime.nvim",
+    dependencies = { "MunifTanjim/nui.nvim", "nvim-lua/plenary.nvim" },
+    opts = {},
+    cond = function()
+      if
+        vim.fn.readfile(vim.fn.stdpath("config") .. "/.hardtime")[1]
+        == "true"
+      then
+        return true
+      end
+    end,
+  },
 }