From ae9195d3f2214c361a50d09ae2046a3ef45055d6 Mon Sep 17 00:00:00 2001
From: Nico Madysa <nico.madysa@cern.ch>
Date: Fri, 21 Apr 2023 13:23:01 +0200
Subject: [PATCH] Force-disable spellcheck in certain markup groups.

This passes the `spell` option to `nvim_buf_set_extmark()` for all
markup groups. In most cases, the passed value is simply `nil`, i.e. the
same as if it were not passed at all.

In the following cases, however, we pass `spell=false`, i.e. forcefully
disable spell-checking:

- the URL part of `[[URL][hyperlinks]]`;
- the inside of `[[hyperlinks]]` without description;
- `~code~` and `=verbatim=` spans;
- in-line LaTeX markup using `\(parentheses\)`.

The reason in all cases is that these spans are extremely likely to
contain purposefully non-orthographic spelling, in particular
hyperlinks.
---
 lua/orgmode/colors/markup_highlighter.lua | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/lua/orgmode/colors/markup_highlighter.lua b/lua/orgmode/colors/markup_highlighter.lua
index ac86f23ee..6c50097dc 100644
--- a/lua/orgmode/colors/markup_highlighter.lua
+++ b/lua/orgmode/colors/markup_highlighter.lua
@@ -36,18 +36,21 @@ local markers = {
     hl_name = 'org_code',
     hl_cmd = 'hi def link org_code String',
     nestable = false,
+    spell = false,
     type = 'text',
   },
   ['='] = {
     hl_name = 'org_verbatim',
     hl_cmd = 'hi def link org_verbatim String',
     nestable = false,
+    spell = false,
     type = 'text',
   },
   ['\\('] = {
     hl_name = 'org_latex',
     hl_cmd = 'hi def link org_latex OrgTSLatex',
     nestable = false,
+    spell = false,
     type = 'latex',
   },
   ['\\{'] = {
@@ -381,6 +384,7 @@ local function apply(namespace, bufnr, line_index)
       ephemeral = true,
       end_col = range.to['end'].character,
       hl_group = markers[range.type].hl_name,
+      spell = markers[range.type].spell,
       priority = 110 + range.from.start.character,
     })
 
@@ -402,6 +406,7 @@ local function apply(namespace, bufnr, line_index)
     local line = vim.api.nvim_buf_get_lines(bufnr, link_range.from.start.line, link_range.from.start.line + 1, false)[1]
     local link = line:sub(link_range.from.start.character + 1, link_range.to['end'].character)
     local alias = link:find('%]%[') or 1
+    local link_end = link:find('%]%[') or (link:len() - 1)
 
     vim.api.nvim_buf_set_extmark(bufnr, namespace, link_range.from.start.line, link_range.from.start.character, {
       ephemeral = true,
@@ -416,6 +421,12 @@ local function apply(namespace, bufnr, line_index)
       conceal = '',
     })
 
+    vim.api.nvim_buf_set_extmark(bufnr, namespace, link_range.from.start.line, link_range.from.start.character + 2, {
+      ephemeral = true,
+      end_col = link_range.from.start.character - 1 + link_end,
+      spell = false,
+    })
+
     vim.api.nvim_buf_set_extmark(bufnr, namespace, link_range.from.start.line, link_range.to['end'].character - 2, {
       ephemeral = true,
       end_col = link_range.to['end'].character,
@@ -428,6 +439,7 @@ local function apply(namespace, bufnr, line_index)
       ephemeral = true,
       end_col = latex_range.to['end'].character,
       hl_group = markers[latex_range.type].hl_name,
+      spell = markers[latex_range.type].spell,
       priority = 110 + latex_range.from.start.character,
     })
   end