add health check via :checkhealth defold

Author: atomicptr

README.md

@@ -266,6 +266,11 @@ Here's how you can interact with Defold directly from Neovim:
 * **: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.
+
 ## Special Thanks
 
 - [astrochili/defold-annotations](https://github.com/astrochili/defold-annotations)

lua/defold/health.lua

@@ -0,0 +1,64 @@
+local M = {}
+
+function M.check()
+    vim.health.start "System"
+
+    local os = require "defold.service.os"
+
+    vim.health.info(string.format("OS: %s / %s", os.name(), os.architecture()))
+
+    vim.health.start "Sidecar"
+
+    local sidecar_ok, sidecar = pcall(require, "defold.sidecar")
+    if sidecar_ok then
+        vim.health.ok(string.format("Sidecar Loaded Version: %s", sidecar.version))
+    else
+        vim.health.error(string.format("Sidecar Not Available: %s", sidecar))
+    end
+
+    vim.health.start "Bridge"
+
+    local bridge_path_ok, bridge_path = pcall(sidecar.find_bridge_path, require("defold").plugin_root())
+    if bridge_path_ok then
+        vim.health.ok(string.format("Bridge Path: %s", bridge_path))
+    else
+        vim.health.error(string.format("Bridge Not Found: %s", bridge_path))
+    end
+
+    vim.health.start "mobdap"
+
+    local debugger = require "defold.service.debugger"
+    local mobdap_path = debugger.mobdap_path()
+
+    if mobdap_path ~= nil then
+        vim.health.ok(string.format("mobdap Path: %s", mobdap_path))
+    else
+        vim.health.warn(string.format("mobdap not available: %s, debugger disabled", mobdap_path))
+    end
+
+    vim.health.start "Defold"
+
+    local project = require "defold.project"
+
+    if project.is_defold_project() then
+        vim.health.ok "Current project is Defold project"
+
+        local project_root = project.project_root(false)
+
+        if project_root then
+            vim.health.ok(string.format("Project Root: %s", project_root))
+        end
+    else
+        vim.health.warn "Current project is NOT a Defold project"
+    end
+
+    local editor_port = project.editor_port()
+
+    if editor_port ~= nil then
+        vim.health.ok(string.format("Editor Port found at: %d", editor_port))
+    else
+        vim.health.warn "Could not find editor port, is the editor running?"
+    end
+end
+
+return M