From b4224d0023abc6565f7ff9c3497ed1280929aee0 Mon Sep 17 00:00:00 2001
From: pfych <contact@pfy.ch>
Date: Sat, 17 Aug 2024 09:38:44 +1000
Subject: [PATCH] Attempted to tidy nvim configuration

---
 .config/nvim/README.md             | 29 +++++++++++++++++++++++++++++
 .config/nvim/init.lua              |  5 -----
 .config/nvim/lua/.luarc.json       |  5 -----
 .config/nvim/lua/pfych/plugins.lua | 13 +------------
 .config/nvim/plugin/barbar.lua     |  0
 .config/nvim/plugin/lspconfig.lua  |  5 ++++-
 .config/nvim/plugin/mason.lua      |  2 +-
 .config/nvim/plugin/telescope.lua  |  2 +-
 8 files changed, 36 insertions(+), 25 deletions(-)
 create mode 100644 .config/nvim/README.md
 delete mode 100644 .config/nvim/lua/.luarc.json
 delete mode 100644 .config/nvim/plugin/barbar.lua

diff --git a/.config/nvim/README.md b/.config/nvim/README.md
new file mode 100644
index 0000000..a98bb4a
--- /dev/null
+++ b/.config/nvim/README.md
@@ -0,0 +1,29 @@
+# Neovim Configuration
+
+Running neovim with packer for plugins and lsp stuff.
+
+## Plugins & LSP
+
+```sh
+:PackerInstall
+:PackerUpdate
+:Mason -> U # Update all LSP servers
+```
+
+Mason should auto-install LSP servers. However, the following is what should be installed:
+
+- `prettier`
+- `lua-language-server`
+- `luaformatter`
+- `eslint_d`
+- `typescript-language-server`
+- `stylelint-lsp`
+
+`prettierd` and `eslintd` will need to be installed manually via pnpm as a global package.
+
+## Custom key binds
+
+- `<space>f` to toggle NerdTREE
+- `?` to view code action items
+- `>` to go to next diagnostic
+- `<` to go to previous diagnostic
diff --git a/.config/nvim/init.lua b/.config/nvim/init.lua
index 2e77153..442602a 100644
--- a/.config/nvim/init.lua
+++ b/.config/nvim/init.lua
@@ -1,8 +1,3 @@
--- If stuff is broken try the following
--- 1. :PackerUpdate
--- 2. :Mason -> U
--- 3. :TSUpdate
-
 require('pfych.base')
 require('pfych.plugins')
 require('pfych.colours')
diff --git a/.config/nvim/lua/.luarc.json b/.config/nvim/lua/.luarc.json
deleted file mode 100644
index deda1dc..0000000
--- a/.config/nvim/lua/.luarc.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
-    "diagnostics.disable": [
-        "unused-local"
-    ]
-}
\ No newline at end of file
diff --git a/.config/nvim/lua/pfych/plugins.lua b/.config/nvim/lua/pfych/plugins.lua
index 87de586..474ce2e 100644
--- a/.config/nvim/lua/pfych/plugins.lua
+++ b/.config/nvim/lua/pfych/plugins.lua
@@ -13,30 +13,19 @@ packer.startup(function(use)
   use 'hrsh7th/cmp-nvim-lsp' -- nvim-cmp source for neovim's built-in LSP
   use 'hrsh7th/nvim-cmp'     -- Completion
   use 'L3MON4D3/LuaSnip'
-
   use 'neovim/nvim-lspconfig'   -- LSP
   use 'jose-elias-alvarez/null-ls.nvim'
   use 'williamboman/mason.nvim' -- LSP Installer
   use 'williamboman/mason-lspconfig.nvim'
-
   use 'nvim-tree/nvim-web-devicons'
-
   use { 'catppuccin/nvim', as = "catppuccin" }
-
   use {
     'nvim-telescope/telescope.nvim', tag = '0.1.8', -- For file searching :Telescope find_files
     requires = { { 'nvim-lua/plenary.nvim' } }
   }
-
   use { 'prettier/vim-prettier', build = 'pnpm install' }
-
   use { 'weilbith/nvim-code-action-menu', cmd = 'CodeActionMenu' }
-
   use 'bellinitte/uxntal.vim'
-
-  use { 'edkolev/tmuxline.vim', run = ':Tmuxline vim_statusline_2' }
-
-  use 'preservim/nerdtree' -- For filebrowser :NERDTree
-
+  use 'preservim/nerdtree' -- For file-browser :NERDTree
   use 'elkowar/yuck.vim'
 end)
diff --git a/.config/nvim/plugin/barbar.lua b/.config/nvim/plugin/barbar.lua
deleted file mode 100644
index e69de29..0000000
diff --git a/.config/nvim/plugin/lspconfig.lua b/.config/nvim/plugin/lspconfig.lua
index 072df54..18d5008 100644
--- a/.config/nvim/plugin/lspconfig.lua
+++ b/.config/nvim/plugin/lspconfig.lua
@@ -1,5 +1,8 @@
 local status, nvim_lsp = pcall(require, "lspconfig")
-if (not status) then return end
+if (not status) then
+  print("LSPConfig is not installed")
+  return
+end
 
 local protocol = require('vim.lsp.protocol')
 
diff --git a/.config/nvim/plugin/mason.lua b/.config/nvim/plugin/mason.lua
index 9432abf..808b3b9 100644
--- a/.config/nvim/plugin/mason.lua
+++ b/.config/nvim/plugin/mason.lua
@@ -1,6 +1,6 @@
 local status, mason = pcall(require, "mason")
 if (not status) then
-  print("mason is not installed")
+  print("Mason is not installed")
   return
 end
 
diff --git a/.config/nvim/plugin/telescope.lua b/.config/nvim/plugin/telescope.lua
index dd7bd95..7313b9d 100644
--- a/.config/nvim/plugin/telescope.lua
+++ b/.config/nvim/plugin/telescope.lua
@@ -1,6 +1,6 @@
 local status, telescope = pcall(require, "telescope")
 if (not status) then
-  print("telescope is not installed")
+  print("Telescope is not installed")
   return
 end