From 7cff9dcd98c26487ba817f235ce9cde1b9731159 Mon Sep 17 00:00:00 2001
From: Matt Leong <mattleong91@gmail.com>
Date: Sat, 6 Nov 2021 22:10:57 -0700
Subject: [PATCH] refactor(config): rename example configs

---
 .gitignore                                       |  4 ++++
 .../config/{config.lua => config-example.lua}    |  0
 .../config/{editor.lua => editor-example.lua}    |  0
 lua/cosmic/config/init.lua                       |  5 -----
 .../{mappings.lua => mappings-example.lua}       |  0
 .../config/{plugins.lua => plugins-example.lua}  |  0
 lua/cosmic/init.lua                              | 13 ++++++++++---
 lua/cosmic/pluginsInit.lua                       |  5 -----
 readme.md                                        | 16 ++++++++--------
 9 files changed, 22 insertions(+), 21 deletions(-)
 rename lua/cosmic/config/{config.lua => config-example.lua} (100%)
 rename lua/cosmic/config/{editor.lua => editor-example.lua} (100%)
 rename lua/cosmic/config/{mappings.lua => mappings-example.lua} (100%)
 rename lua/cosmic/config/{plugins.lua => plugins-example.lua} (100%)

diff --git a/.gitignore b/.gitignore
index 50d063e..3d6a001 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,7 @@ sessions/**
 .netrwhist
 plugin/
 lua/cosmic/compiled.lua
+lua/cosmic/config/editor.lua
+lua/cosmic/config/config.lua
+lua/cosmic/config/mappings.lua
+lua/cosmic/config/plugins.lua
diff --git a/lua/cosmic/config/config.lua b/lua/cosmic/config/config-example.lua
similarity index 100%
rename from lua/cosmic/config/config.lua
rename to lua/cosmic/config/config-example.lua
diff --git a/lua/cosmic/config/editor.lua b/lua/cosmic/config/editor-example.lua
similarity index 100%
rename from lua/cosmic/config/editor.lua
rename to lua/cosmic/config/editor-example.lua
diff --git a/lua/cosmic/config/init.lua b/lua/cosmic/config/init.lua
index 104312d..8c7e704 100644
--- a/lua/cosmic/config/init.lua
+++ b/lua/cosmic/config/init.lua
@@ -2,11 +2,6 @@
 local ok, user_config = pcall(require, 'cosmic.config.config')
 
 if not ok then
-  error(('Error loading user config...\n\n%s'):format(user_config))
-  error('No user config, using default instead...')
-end
-
-if user_config == true then
   user_config = {}
 end
 
diff --git a/lua/cosmic/config/mappings.lua b/lua/cosmic/config/mappings-example.lua
similarity index 100%
rename from lua/cosmic/config/mappings.lua
rename to lua/cosmic/config/mappings-example.lua
diff --git a/lua/cosmic/config/plugins.lua b/lua/cosmic/config/plugins-example.lua
similarity index 100%
rename from lua/cosmic/config/plugins.lua
rename to lua/cosmic/config/plugins-example.lua
diff --git a/lua/cosmic/init.lua b/lua/cosmic/init.lua
index 8b3f3d8..d8a4806 100644
--- a/lua/cosmic/init.lua
+++ b/lua/cosmic/init.lua
@@ -3,10 +3,8 @@ local cosmic_modules = {
   'cosmic.pluginsInit',
   'cosmic.compiled',
   'cosmic.editor',
-  'cosmic.core.theme.highlights',
-  'cosmic.config.editor',
   'cosmic.mappings',
-  'cosmic.config.mappings',
+  'cosmic.core.theme.highlights',
 }
 
 for _, mod in ipairs(cosmic_modules) do
@@ -15,3 +13,12 @@ for _, mod in ipairs(cosmic_modules) do
     error(('Error loading %s...\n\n%s'):format(mod, err))
   end
 end
+
+local user_config_modules = {
+  'cosmic.config.editor',
+  'cosmic.config.mappings',
+}
+
+for _, mod in ipairs(user_config_modules) do
+  pcall(require, mod)
+end
diff --git a/lua/cosmic/pluginsInit.lua b/lua/cosmic/pluginsInit.lua
index 1508ddb..2381a28 100644
--- a/lua/cosmic/pluginsInit.lua
+++ b/lua/cosmic/pluginsInit.lua
@@ -9,11 +9,6 @@ local use = packer.use
 
 local ok, user_plugins = pcall(require, 'cosmic.config.plugins')
 if not ok then
-  error(('Error loading user custom plugins...\n\n%s'):format(user_plugins))
-  return false
-end
-
-if user_plugins == true then
   user_plugins = {
     add = {},
     disable = {},
diff --git a/readme.md b/readme.md
index 7b2c228..fda34bd 100644
--- a/readme.md
+++ b/readme.md
@@ -66,13 +66,13 @@ Additional LSP server installation [details](https://github.com/mattleong/Cosmic
 
 ## Configuration
 
-[Cosmic configurations](./lua/cosmic/config/config.lua)
+[Cosmic configurations](./lua/cosmic/config/config-example.lua)
 
-[Plugin configurations](./lua/cosmic/config/plugins.lua)
+[Plugin configurations](./lua/cosmic/config/plugins-example.lua)
 
-[Add additional mappings](./lua/cosmic/config/mappings.lua)
+[Add additional mappings](./lua/cosmic/config/mappings-example.lua)
 
-[Add additional vim options](./lua/cosmic/config/editor.lua)
+[Add additional vim options](./lua/cosmic/config/editor-example.lua)
 
 ## Treesitter Support
 
@@ -98,15 +98,15 @@ Enter `:TSInstall` followed by <TAB> to see your options for additional language
 ![insert](https://user-images.githubusercontent.com/3721204/137990345-d036c2d1-0f9e-4d4e-bd6c-13e051609f61.png)
 ![visual](https://user-images.githubusercontent.com/3721204/137990348-6eb29e9b-e912-4d6e-8a5e-e763816613d7.png)
 ![replace](https://user-images.githubusercontent.com/3721204/137990347-b59428d6-b5fe-4edb-8ceb-ab37b69b7e76.png)
-  
+
 ### Dashboard
-  
+
 <img width="1792" alt="dashboard" src="https://user-images.githubusercontent.com/3721204/140592730-fc512005-6060-4dd2-8b90-0afa865d61d3.png">
 
 ### Autocomplete
 
 <img width="1792" alt="autocomplete" src="https://user-images.githubusercontent.com/3721204/140592713-f08c72f8-4fc5-4422-8987-2224b9425725.png">
-  
+
 ### Rename
 
 <img width="859" alt="rename" src="https://user-images.githubusercontent.com/3721204/140592783-c9875634-805e-45f4-8547-6dcb5b5c7404.png">
@@ -118,5 +118,5 @@ Enter `:TSInstall` followed by <TAB> to see your options for additional language
 ### Hover
 
 <img width="1792" alt="hover" src="https://user-images.githubusercontent.com/3721204/140592798-b9dbbdee-8496-4998-a874-110a051a7672.png">
-  
+
 [See more screenshots](https://github.com/mattleong/CosmicNvim/wiki/Screenshots)