[Feature] Rename lv-config.lua to config.lua (#1193)

* Rename example config files

* Update user config path in installer

* Update user config path with a variable

* Update default user config file to config.lua

* Add fallback to lv-config if config.lua not found

* Add global variable USER_CONFIG_PATH

.luacheckrc

@@ -1,31 +1,31 @@
 -- vim: ft=lua tw=80
 
 stds.nvim = {
-	globals = {
-		"lvim",
-		vim = { fields = { "g" } },
-		"CONFIG_PATH",
-		"CACHE_PATH",
-		"DATA_PATH",
-		"TERMINAL",
-		"USER",
+  globals = {
+    "lvim",
+    vim = { fields = { "g" } },
+    "CONFIG_PATH",
+    "CACHE_PATH",
+    "DATA_PATH",
+    "TERMINAL",
+    "USER",
     "C",
     "Config",
     "WORKSPACE_PATH",
     "JAVA_LS_EXECUTABLE",
     "MUtils",
-    os = {fields = {"capture"}}
-	},
-	read_globals = {
-		"jit",
-		"os",
-		"vim",
-		-- vim = { fields = { "cmd", "api", "fn", "o" } },
-	},
+    "USER_CONFIG_PATH",
+    os = { fields = { "capture" } },
+  },
+  read_globals = {
+    "jit",
+    "os",
+    "vim",
+    -- vim = { fields = { "cmd", "api", "fn", "o" } },
+  },
 }
 std = "lua51+nvim"
 
-
 -- Don't report unused self arguments of methods.
 self = false
 
@@ -33,6 +33,6 @@ self = false
 cache = true
 
 ignore = {
-	"631", -- max_line_length
-	"212/_.*", -- unused argument, for vars with "_" prefix
+  "631", -- max_line_length
+  "212/_.*", -- unused argument, for vars with "_" prefix
 }

README.md

@@ -38,9 +38,9 @@ LVBRANCH=rolling bash <(curl -s https://raw.githubusercontent.com/ChristianChiar
 * The latest changes to LunarVim require you to [remove it completely](https://github.com/ChristianChiarulli/LunarVim/wiki/Uninstalling-LunarVim) before upgrading
 * Going forward LunarVim will no longer reside in the nvim configuration folder.  LunarVim has been moved to `~/.local/share/lunarvim`.  
 * To launch Lunarvim use the new `lvim` command.  `nvim` will only launch standard neovim.  
-* Your personal configuration file (`lv-config.lua`) can now be found in `~/.config/lvim`.  You can initialize this folder as a git repository to track changes to your configuration files.
+* Your personal configuration file (`config.lua`) can now be found in `~/.config/lvim`.  You can initialize this folder as a git repository to track changes to your configuration files.
 * If you want to keep launching LunarVim with the `nvim` command, add an alias entry to your shell's config file:  `alias nvim=lvim`.  To temporarily revert to the default `nvim` prefix it with a backslash `\nvim`.
-* Many options formerly available in `lv-config.lua` have been renamed.  For details [look here](https://github.com/ChristianChiarulli/LunarVim/wiki/Breaking-changes-in-rolling)
+* Many options formerly available in `config.lua` have been renamed.  For details [look here](https://github.com/ChristianChiarulli/LunarVim/wiki/Breaking-changes-in-rolling)
 
 ### Fixing installation problems
 If your installation is stuck on `Ok to remove? [y/N]`, it means there are some leftovers, \
@@ -60,13 +60,13 @@ then run nvim and wait for treesitter to finish the installation
 
 Just enter `:LspInstall` followed by `<TAB>` to see your options
 
-**NOTE** I recommend installing `lua` for autocomplete in `lv-config.lua`
+**NOTE** I recommend installing `lua` for autocomplete in `config.lua`
 
 For the julia language server look [here](https://github.com/ChristianChiarulli/LunarVim/wiki/Enabling-a-language-server#julia-support)
 
 ## Configuration file
 
-To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/lv-config.lua`) on rolling
+To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/config.lua`) on rolling
 
 Example:
 

init.lua

@@ -11,12 +11,32 @@ vim.cmd [[
   set runtimepath^=~/.local/share/lunarvim/lvim/after
 ]]
 -- vim.opt.rtp:append() instead of vim.cmd ?
+
+local function file_exists(name)
+  local f = io.open(name, "r")
+  if f ~= nil then
+    io.close(f)
+    return true
+  else
+    return false
+  end
+end
+
+local lvim_path = os.getenv "HOME" .. "/.config/lvim/"
+USER_CONFIG_PATH = lvim_path .. "config.lua"
+local config_exist = file_exists(USER_CONFIG_PATH)
+if not config_exist then
+  USER_CONFIG_PATH = lvim_path .. "lv-config.lua"
+  print "Rename ~/.config/lvim/lv-config.lua to config.lua"
+end
+
 require "default-config"
 local autocmds = require "core.autocmds"
 require("settings").load_options()
-local status_ok, error = pcall(vim.cmd, "luafile ~/.config/lvim/lv-config.lua")
+
+local status_ok, error = pcall(vim.cmd, "luafile " .. USER_CONFIG_PATH)
 if not status_ok then
-  print "something is wrong with your lv-config"
+  print("something is wrong with your " .. USER_CONFIG_PATH)
   print(error)
 end
 require("settings").load_commands()

lua/core/autocmds.lua

@@ -27,7 +27,7 @@ lvim.autocommands = {
       "*",
       "setlocal formatoptions-=c formatoptions-=r formatoptions-=o",
     },
-    { "BufWritePost", "lv-config.lua", "lua require('utils').reload_lv_config()" },
+    { "BufWritePost", USER_CONFIG_PATH, "lua require('utils').reload_lv_config()" },
     {
       "FileType",
       "qf",

lua/core/dashboard.lua

@@ -43,8 +43,7 @@ M.config = function()
       },
       d = {
         description = { "  Settings           " },
-        -- command = ":e " .. CONFIG_PATH .. "/lv-config.lua",
-        command = ":e ~/.config/lvim/lv-config.lua",
+        command = ":e " .. USER_CONFIG_PATH,
       },
     },
 

lua/core/terminal.lua

@@ -32,7 +32,7 @@ M.config = function()
         background = "Normal",
       },
     },
-    -- Add executables on the lv-config file
+    -- Add executables on the config.lua
     -- { exec, keymap, name}
     -- lvim.builtin.terminal.execs = {{}} to overwrite
     -- lvim.builtin.terminal.execs[#lvim.builtin.terminal.execs+1] = {"gdb", "tg", "GNU Debugger"}

lua/default-config.lua

@@ -88,7 +88,7 @@ lvim = {
   },
 
   plugins = {
-    -- use lv-config.lua for this not put here
+    -- use config.lua for this not put here
   },
 
   autocommands = {},

lua/utils/init.lua

@@ -81,7 +81,7 @@ end
 
 function utils.reload_lv_config()
   vim.cmd "source ~/.local/share/lunarvim/lvim/lua/settings.lua"
-  vim.cmd "source ~/.config/lvim/lv-config.lua"
+  vim.cmd("source " .. USER_CONFIG_PATH)
   vim.cmd "source ~/.local/share/lunarvim/lvim/lua/plugins.lua"
   local plugins = require "plugins"
   local plugin_loader = require("plugin-loader").init()

utils/installer/install.sh

@@ -114,7 +114,7 @@ cloneconfig() {
 	mkdir -p "$HOME/.config/lvim"
 	sudo cp "$HOME/.local/share/lunarvim/lvim/utils/bin/lvim" "/usr/local/bin"
 	sudo chmod a+rx /usr/local/bin/lvim
-	cp "$HOME/.local/share/lunarvim/lvim/utils/installer/lv-config.example-no-ts.lua" "$HOME/.config/lvim/lv-config.lua"
+	cp "$HOME/.local/share/lunarvim/lvim/utils/installer/config.example-no-ts.lua" "$HOME/.config/lvim/config.lua"
 
 	nvim -u ~/.local/share/lunarvim/lvim/init.lua --cmd "set runtimepath+=~/.local/share/lunarvim/lvim" --headless \
 		+'autocmd User PackerComplete sleep 100m | qall' \
@@ -127,9 +127,9 @@ cloneconfig() {
 	printf "\nCompile Complete\n"
 
 	if [ -e "$HOME/.local/share/lunarvim/lvim/init.lua" ]; then
-		echo 'lv-config already present'
+		echo 'config.lua already present'
 	else
-		cp "$HOME/.local/share/lunarvim/lvim/utils/installer/lv-config.example.lua" "$HOME/.config/lvim/lv-config.lua"
+		cp "$HOME/.local/share/lunarvim/lvim/utils/installer/config.example.lua" "$HOME/.config/lvim/config.lua"
 	fi
 
 }