Merge pull request #280 from joaomsa/configurable-tags-column

Allow configurable org tags column

Author: kristijanhusak

DOCS.md

@@ -368,6 +368,15 @@ Example value: `{'agenda-archives'}`
 
 ### Tags settings
 
+#### **org_tags_column**
+*type*: `number`
+*default value*: `80`
+The column to which tags should be indented in a headline.
+If this number is positive, it specifies the column.
+If it is negative, it means that the tags should be flushright to that column.
+For example, -80 works well for a normal 80 character screen.
+When 0, place tags directly after headline text, with only one space in between.
+
 #### **org_use_tag_inheritance**
 *type*: `boolean`
 *default value*: `true`

doc/orgmode.txt

@@ -41,8 +41,9 @@ CONTENTS                                                        *orgmode-content
             1.2.2.11. org_agenda_skip_deadline_if_done.|orgmode-org_agenda_skip_deadline_if_done|
             1.2.2.12. org_agenda_text_search_extra_files.|orgmode-org_agenda_text_search_extra_files|
         1.2.3. Tags settings...............................|orgmode-tags_settings|
-            1.2.3.1. org_use_tag_inheritance.....|orgmode-org_use_tag_inheritance|
-            1.2.3.2. org_tags_exclude_from_inheritance.|orgmode-org_tags_exclude_from_inheritance|
+            1.2.3.1. org_tags_column.....................|orgmode-org_tags_column|
+            1.2.3.2. org_use_tag_inheritance.....|orgmode-org_use_tag_inheritance|
+            1.2.3.3. org_tags_exclude_from_inheritance.|orgmode-org_tags_exclude_from_inheritance|
     1.3. Mappings...............................................|orgmode-mappings|
         1.3.1. Global mappings...........................|orgmode-global_mappings|
             1.3.1.1. org_agenda...............................|orgmode-org_agenda|
@@ -566,6 +567,16 @@ Example value: `{'agenda-archives'}`
 
 TAGS SETTINGS                                              *orgmode-tags_settings*
 
+ORG_TAGS_COLUMN                                          *orgmode-org_tags_column*
+
+type: `number`
+default value: `80`
+The column to which tags should be indented in a headline.
+If this number is positive, it specifies the column.
+If it is negative, it means that the tags should be flushright to that column.
+For example, -80 works well for a normal 80 character screen.
+When 0, place tags directly after headline text, with only one space in between.
+
 ORG_USE_TAG_INHERITANCE                          *orgmode-org_use_tag_inheritance*
 
 type: `boolean`

lua/orgmode/config/defaults.lua

@@ -21,6 +21,7 @@ return {
   org_priority_default = 'B',
   org_priority_lowest = 'C',
   org_archive_location = '%s_archive::',
+  org_tags_column = 80,
   org_use_tag_inheritance = true,
   org_tags_exclude_from_inheritance = {},
   org_hide_leading_stars = false,

lua/orgmode/org/mappings.lua

@@ -66,23 +66,28 @@ function OrgMappings:archive()
 end
 
 function OrgMappings:set_tags()
-  local headline = Files.get_closest_headline()
-  local own_tags = headline:get_own_tags()
-  local tags = vim.fn.OrgmodeInput('Tags: ', utils.tags_to_string(own_tags), Files.autocomplete_tags)
-  return self:_set_headline_tags(headline, tags)
+  local headline = Headline:new(tree_utils.closest_headline())
+  local _, current_tags = headline:tags()
+
+  local tags = vim.fn.OrgmodeInput('Tags: ', current_tags, Files.autocomplete_tags)
+
+  return headline:set_tags(tags)
 end
 
 function OrgMappings:toggle_archive_tag()
-  local headline = Files.get_closest_headline()
-  local own_tags = headline:get_own_tags()
-  if vim.tbl_contains(own_tags, 'ARCHIVE') then
-    own_tags = vim.tbl_filter(function(tag)
+  local headline = Headline:new(tree_utils.closest_headline())
+  local _, current_tags = headline:tags()
+
+  local parsed = utils.parse_tags_string(current_tags)
+  if vim.tbl_contains(parsed, 'ARCHIVE') then
+    parsed = vim.tbl_filter(function(tag)
       return tag ~= 'ARCHIVE'
-    end, own_tags)
+    end, parsed)
   else
-    table.insert(own_tags, 'ARCHIVE')
+    table.insert(parsed, 'ARCHIVE')
   end
-  return self:_set_headline_tags(headline, utils.tags_to_string(own_tags))
+
+  return headline:set_tags(utils.tags_to_string(parsed))
 end
 
 function OrgMappings:cycle()
@@ -852,19 +857,6 @@ function OrgMappings:_adjust_date(amount, span, fallback)
   return vim.api.nvim_feedkeys(utils.esc(fallback), 'n', true)
 end
 
-function OrgMappings:_set_headline_tags(headline, tags_string)
-  local tags = tags_string:gsub('^:+', ''):gsub(':+$', ''):gsub(':+', ':')
-  if tags ~= '' then
-    tags = ':' .. tags .. ':'
-  end
-  local line_without_tags = headline.line
-    :gsub(vim.pesc(utils.tags_to_string(headline:get_own_tags())) .. '%s*$', '')
-    :gsub('%s*$', '')
-  local spaces = 80 - math.min(vim.api.nvim_strwidth(line_without_tags), 79)
-  local new_line = string.format('%s%s%s', line_without_tags, string.rep(' ', spaces), tags):gsub('%s*$', '')
-  return vim.fn.setline(headline.range.start_line, new_line)
-end
-
 ---@return string|nil
 function OrgMappings:_get_link_under_cursor()
   local found_link = nil

lua/orgmode/treesitter/headline.lua

@@ -28,6 +28,51 @@ function Headline:priority()
   return self:parse('%[#(%w+)%]')
 end
 
+function Headline:tags()
+  local node = self.headline:field('tags')[1]
+  local text = ''
+  if node then
+    text = query.get_node_text(node, 0)
+  end
+  return node, text
+end
+
+function Headline:set_tags(tags)
+  local predecessor = nil
+  for _, node in ipairs(ts_utils.get_named_children(self.headline)) do
+    if node:type() ~= 'tag_list' then
+      predecessor = node
+    end
+  end
+
+  local pred_end_row, pred_end_col, _ = predecessor:end_()
+  local end_col = vim.api.nvim_strwidth(vim.fn.getline(pred_end_row + 1))
+
+  local text = ''
+  tags = vim.trim(tags):gsub('^:', ''):gsub(':$', '')
+  if tags ~= '' then
+    tags = ':' .. tags .. ':'
+
+    local to_col = config.org_tags_column
+    if to_col < 0 then
+      local tags_width = vim.api.nvim_strwidth(tags)
+      to_col = math.abs(to_col) - tags_width
+    end
+
+    local spaces = math.max(to_col - pred_end_col, 1)
+    text = string.rep(' ', spaces) .. tags
+  end
+
+  vim.api.nvim_buf_set_text(0, pred_end_row, pred_end_col, pred_end_row, end_col, { text })
+end
+
+function Headline:align_tags()
+  local current_tags, current_text = self:tags()
+  if current_tags then
+    self:set_tags(current_text)
+  end
+end
+
 function Headline:set_priority(priority)
   local current_priority = self:priority()
   if current_priority then
@@ -96,7 +141,7 @@ function Headline:dates()
   end
 
   for _, node in ipairs(ts_utils.get_named_children(plan)) do
-    local name = vim.treesitter.query.get_node_text(node:named_child(0), 0)
+    local name = query.get_node_text(node:named_child(0), 0)
     dates[name] = node
   end
   return dates