replace :SetupDefold command with lua imports if the user wants to do something the manual way, close #57

Author: atomicptr

README.md

@@ -216,8 +216,18 @@ defold.setup(config)
 1. Install the plugin (see above)
 2. Install [Defold](https://defold.com/)
 3. Start Defold and open a project
-4. Open Neovim in the projects directory and run `:SetupDefold`
-5. Done, when you try to open files via Defold now they should open in a Neovim window.
+4. Open Neovim in the projects directory once (Defold must be running)
+5. Done, when you try to open files via Defold now they open in your current Neovim instance or in a new window if none could be found.
+
+#### Manual Setup
+
+If you have the auto setup for the Defold external editor disabled and/or you want to initialize this a different way, use:
+
+`:lua require("defold").setup_default_editor()`
+
+Similarly the Debugger can be initialized using
+
+`:lua require("defold").setup_debugger()`
 
 ### Setup Debugging
 
@@ -253,14 +263,16 @@ Here's how you can interact with Defold directly from Neovim:
 * **:DefoldFetch**
     This command fetches all Defold dependencies and creates annotations for the Lua LSP. Run with bang to force re-downloading the annotations.
 
-* **:SetupDefold**
-    This commands does the required setup for Defold to use Neovim as its external editor (this will be done by default unless disabled, see config above)
-
 ## Troubleshooting
 
 Should you have problems, please open Neovim (preferably through Defold) and use the command `:checkhealth defold`, this should give you a short list of several checks that might help to identify
 the issue. If it didn't, please be sure to include the health check if you report the issue.
 
+There are also logs available, you can find the paths inside `:checkhealth defold`.
+
+- **System > Cache Dir**: The location of the plugin logs
+- **Sidecar > Sidecar Cache Dir**: The location of the sidecar (Neovim native extension) and bridge (Tool that calls Neovim instances)
+
 ## Special Thanks
 
 - [astrochili/defold-annotations](https://github.com/astrochili/defold-annotations)

lua/defold/init.lua

@@ -108,30 +108,6 @@ function M.setup(opts)
         end
     end
 
-    -- add setup defold command
-    vim.api.nvim_create_user_command("SetupDefold", function()
-        local project = require "defold.project"
-        local port = project.editor_port()
-
-        if not port then
-            log.error "Editor is not running, please make sure the editor for this project is running."
-            return
-        end
-
-        local sidecar = require "defold.sidecar"
-        local ok, err = pcall(sidecar.set_default_editor, port, M.plugin_root(), M.config.launcher)
-        if not ok then
-            log.error(string.format("Could not set default editor because: %s", err))
-        end
-
-        if M.config.debugger.enable then
-            local debugger = require "defold.service.debugger"
-            debugger.setup(M.config.debugger.custom_executable, M.config.debugger.custom_arguments)
-        end
-
-        log.info "Defold setup successfully"
-    end, { nargs = 0, desc = "Setup Defold to use Neovim as its default editor" })
-
     -- register some filetypes
     vim.filetype.add(require("defold.config.filetype").minimal)
 
@@ -176,20 +152,12 @@ function M.setup(opts)
             project.ensure_nvim_server(M.config.launcher.socket_type)
         end
 
-        local port = project.editor_port()
-
-        if M.config.defold.set_default_editor and port then
-            local sidecar = require "defold.sidecar"
-            local ok, err = pcall(sidecar.set_default_editor, port, M.plugin_root(), M.config.launcher)
-
-            if not ok then
-                log.error(string.format("Could not set default editor because: %s", err))
-            end
+        if M.config.defold.set_default_editor then
+            M.setup_default_editor()
         end
 
         if M.config.debugger.enable then
-            local debugger = require "defold.service.debugger"
-            debugger.setup(M.config.debugger.custom_executable, M.config.debugger.custom_arguments)
+            M.setup_debugger()
         end
 
         if not M.config.force_plugin_enabled and not project.is_defold_project() then
@@ -326,4 +294,29 @@ function M.load_plugin()
     end
 end
 
+---Sets Neovim as the default Defold editor
+function M.setup_default_editor()
+    local project = require "defold.project"
+    local log = require "defold.service.logger"
+
+    local port = project.editor_port()
+
+    if not port then
+        return
+    end
+
+    local sidecar = require "defold.sidecar"
+    local ok, err = pcall(sidecar.set_default_editor, port, M.plugin_root(), M.config.launcher)
+
+    if not ok then
+        log.error(string.format("Could not set default editor because: %s", err))
+    end
+end
+
+---Sets up MobDap as the debugger
+function M.setup_debugger()
+    local debugger = require "defold.service.debugger"
+    debugger.setup(M.config.debugger.custom_executable, M.config.debugger.custom_arguments)
+end
+
 return M