feat(config): clean up comments

lua/cosmic/config/examples/config.lua

@@ -24,7 +24,7 @@ config.lsp = {
   format_on_save = true,
 
   -- set to false to disable rename notification
-  rename_notification = false,
+  rename_notification = true,
 
   -- see :h vim.diagnostic.config for all diagnostic configuration options
   -- see Cosmic defaults: lsp/diagnostics.lua
@@ -34,7 +34,7 @@ config.lsp = {
 
     -- enable non-default servers, use default lsp config
     -- check here for configs that will be used by default: https://github.com/williamboman/nvim-lsp-installer/tree/main/lua/nvim-lsp-installer/servers
-    rust_analyzer = true,
+    -- rust_analyzer = true,
 
     tsserver = {
       -- disable formatting (defaults to true)
@@ -53,6 +53,7 @@ config.lsp = {
   },
 
   -- See Cosmic defaults lsp/providers/tsserver.lua
+  -- If adding additional sources, be sure to also copy the defaults that you would like to preserve from lsp/providers/null_ls.lua
   ts_utils = {},
 }
 

lua/cosmic/config/examples/editor.lua

@@ -1,9 +1,12 @@
 -- Override Cosmic editor options
+
 local opt = vim.opt
 local g = vim.g
 
+-- Default leader is <space>
 g.mapleader = ','
 
+-- Default indent = 2
 opt.tabstop = 4
 opt.softtabstop = 4
 opt.shiftwidth = 4

lua/cosmic/config/examples/plugins.lua

@@ -9,7 +9,8 @@ local plugins = {
     },
   },
   disable = { -- disabling some core plugins may mean you'll have to remap some keybindings
-    --[[ 'auto-session',
+    --[[
+    'auto-session',
     'autocomplete',
     'colorizer',
     'dashboard',
@@ -22,7 +23,8 @@ local plugins = {
     'terminal',
     'theme',
     'todo-comments',
-    'treesitter', ]]
+    'treesitter',
+    ]]
   },
 }
 

lua/cosmic/config/examples/readme.md

@@ -1,11 +1,12 @@
 ## Configuration
 
-There are four main configuraiton files that you may want to create.
+There are five main configuraiton files that you may want to create.
 
 - cosmic/config/config.lua
 - cosmic/config/editor.lua
 - cosmic/config/mappings.lua
 - cosmic/config/plugins.lua
+- cosmic/config/utils.lua
 
 Please look at the examples in this directory in order to get started.
 
@@ -17,4 +18,5 @@ cp ./lua/cosmic/config/examples/config.lua ./lua/cosmic/config/config.lua
 cp ./lua/cosmic/config/examples/editor.lua ./lua/cosmic/config/editor.lua
 cp ./lua/cosmic/config/examples/mappings.lua ./lua/cosmic/config/mappings.lua
 cp ./lua/cosmic/config/examples/plugins.lua ./lua/cosmic/config/plugins.lua
+cp ./lua/cosmic/config/examples/utils.lua ./lua/cosmic/config/utils.lua
 ```