feat(health): Add healthcheck

Author: kristijanhusak

docs/troubleshoot.org

@@ -1,5 +1,7 @@
 #+OPTIONS: H:9 ^:nil
 * Troubleshooting
+💡 TIP: Run ~:checkhealth orgmode~ to check if Orgmode is correctly installed and configured.
+
 ** Indentation is not working
 
 Make sure you are not overriding indentexpr in Org buffers with [[https://github.com/nvim-treesitter/nvim-treesitter#indentation][nvim-treesitter indentation]]

ftplugin/org.lua

@@ -5,7 +5,6 @@ end
 vim.b.did_ftplugin = true
 
 local config = require('orgmode.config')
-local utils = require('orgmode.utils')
 
 vim.b.org_bufnr = vim.api.nvim_get_current_buf()
 

lua/orgmode/health.lua

@@ -0,0 +1,55 @@
+local h = vim.health
+
+local M = {}
+
+function M.check()
+  h.start('Orgmode')
+  M.check_has_treesitter()
+  M.check_setup()
+  M.check_shellslash()
+end
+
+function M.check_has_treesitter()
+  local ok, result, err = pcall(vim.treesitter.language.add, 'org')
+  if not ok or (not result and err ~= nil) then
+    return h.error('Treesitter grammar is not installed. Run `:Org install_treesitter_grammar` to install it.')
+  end
+  return h.ok('Treesitter grammar installed')
+end
+
+function M.check_setup()
+  local config = require('orgmode.config')
+  local orgmode = require('orgmode')
+
+  if not orgmode.is_setup_called() then
+    h.warn('Setup not called')
+  else
+    h.ok('Setup called')
+  end
+
+  if not config.org_agenda_files or #config.org_agenda_files == 0 then
+    h.warn('No agenda files configured. Set `org_agenda_files` in your config.')
+  else
+    h.ok('`org_agenda_files` configured')
+  end
+  if not config.org_default_notes_file or config.org_default_notes_file == '' then
+    h.warn('No default notes file configured. Set `org_default_notes_file` in your config.')
+  else
+    h.ok('`org_default_notes_file` configured')
+  end
+end
+
+function M.check_shellslash()
+  if vim.fn.has('win32') ~= 1 then
+    return
+  end
+  if not vim.opt.shellslash:get() then
+    h.warn(
+      '`shellslash` is not set. This might cause issues with file paths in links. Set `vim.opt.shellslash = true` in your configuration.'
+    )
+  else
+    h.ok('`shellslash` is set')
+  end
+end
+
+return M

lua/orgmode/init.lua

@@ -16,6 +16,7 @@ local auto_instance_keys = {
 
 ---@class Org
 ---@field initialized boolean
+---@field setup_called boolean
 ---@field files OrgFiles
 ---@field highlighter OrgHighlighter
 ---@field agenda OrgAgenda
@@ -38,6 +39,7 @@ setmetatable(Org, {
 function Org:new()
   require('orgmode.org.global')(self)
   self.initialized = false
+  self.setup_called = false
   self:setup_autocmds()
   require('orgmode.config'):setup_ts_predicates()
   return self
@@ -112,19 +114,14 @@ function Org:setup_autocmds()
   })
 end
 
-function Org.setup_ts_grammar()
-  require('orgmode.utils').echo_info(
-    'calling require("orgmode").setup_ts_grammar() is no longer necessary. Dependency on nvim-treesitter was removed'
-  )
-end
-
 ---@param opts? OrgConfigOpts
 ---@return Org
 function Org.setup(opts)
   opts = opts or {}
   local config = require('orgmode.config'):extend(opts)
   config:install_grammar()
   instance = Org:new()
+  instance.setup_called = true
   vim.defer_fn(function()
     if config.notifications.enabled and #vim.api.nvim_list_uis() > 0 then
       Org.files:load():next(vim.schedule_wrap(function()
@@ -224,6 +221,13 @@ function Org.destroy()
   end
 end
 
+function Org.is_setup_called()
+  if not instance then
+    return false
+  end
+  return instance.setup_called
+end
+
 function _G.orgmode.statusline()
   if not instance or not instance.initialized then
     return ''