Refactor (#665)

* refactor!: Rewrite file management to use tree-sitter

* feat!: Deprecate org_mappings.handle_return in favor of org_mappings.meta_return

If you did not use this mapping directly everything is ok. This is just for users that mapped it directly

* feat: Add org_return_uses_meta_return option

* fix: Allow modifications of plan date range end date

* fix: Properly show plan date ranges in agenda

* feat(api): Add get_closest_headline and refile to api

* fix: Update minimal init to work with Windows

* tests: Add tests for file and fix edge case with set text

* fix(cron): Instantiate orgmode before running cron

* refactor: Stars highlighter

* refactor: Todo faces highlighter

* refactor: Markup highlighter

* fix: Do not rely on node:has_changes()

* feat: make VirtualIndent dynamically attach/detach based on `vim.b.org_indent_mode` (#658)

* feat: make VirtualIndent react to changes in `vim.b.org_indent_mode`

* test: add test to validate VirtualIndent dynamic attach functionality

* docs: update docs to reflect dynamic virtual indent attach

* refactor: make VirtualIndent `start_watch_org_indent` idempotent

This ensures we can call `start_watch_org_indent` as much as we want
without starting a bunch of timers in the background.

This enforces the use of `start_watch_org_indent` and `stop_watch_org_indent` for managing the timer.

* feat: add dict_watcher utility

* refactor: use `dict_watcher` to monitor `vim.b.org_indent_mode`

* ci: Run tests when creating PR to nightly

* chore: Reformat files

* refactor: remove sync call to set indent for virtual indents (#663)

On the current version of nightly (at the time of writing this is NVIM
v0.10.0-dev-2361+ga376d979b) the synchronous call doesn't seem to have
any value.

Using only a scheduled call is seemingly smooth now -- perhaps when I
made the original commit I had something wrong with my configuration or
perhaps upstream Neovim fixed whatever was causing some choppiness?

Another note is that `on_lines` in `nvim_buf_attach` can have `textlock`
restrictions and more applied, thus we really should just use
`vim.schedule` only anyhow.

* feat: add `org-indent-mode-turns-on-hiding-stars` equivalent (#659)

* feat: add equivalent of `org-indent-mode-turns-on-hiding-stars`

* docs: add documentation for `org_indent_mode_turns_on_hiding_stars`

* docs: add reference to `org_indent_mode`  for hiding stars

Co-authored-by: Kristijan Husak <[email protected]>

* fix: ensure hl group for hiding stars is applied

See
#659 (review)

Co-authored-by: Kristijan Husak <[email protected]>

---------

Co-authored-by: Kristijan Husak <[email protected]>

* fix: Hide leading stars on foldtext

* ci: Run tests only on nightly

* fix: run Org init as part of setup (#664)

This ensures that notifications do not error on startup. Prior to this
commit the `OrgFiles` object wasn't loaded in time for notifications to
work.

* fix: Statusline function for clock

* ci: Remove nightly branch from CI triggers

---------

Co-authored-by: Price Hiller <[email protected]>

Author: kristijanhusak

.github/workflows/tests.yml

@@ -27,9 +27,6 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - v0.9.2
-          - v0.9.4
-          - v0.9.5
           - nightly
     runs-on: ubuntu-latest
     steps:

DOCS.md

@@ -237,14 +237,15 @@ Ensure your `:h conceallevel` is set properly in order for this to function.
 *type*: `string`<br />
 *default value*: `...`<br />
 Marker used to indicate a folded headline.
+Not applicable with new empty `foldtext` options in Neovim
 
 #### **org_log_done**
-*type*: `string|nil`<br />
+*type*: `string|false`<br />
 *default value*: `time`<br />
 Possible values:
 * `time` - adds `CLOSED` date when marking headline as done
 * `note` - adds `CLOSED` date as above, and prompts for closing note via capture window. Confirm note with `org_note_finalize` (Default `<C-c>`), or ignore providing note via `org_note_kill` (Default `<Leader>ok`)
-* `nil|false` - Disable any logging
+* `false` - Disable any logging
 
 #### **org_log_into_drawer**
 *type*: `string|nil`<br />
@@ -273,6 +274,10 @@ Possible values:
 * `true` - Uses *Virtual* indents to align content visually. The indents are only visual, they are not saved to the file.
 * `false` - Do not add any *Virtual* indentation.
 
+You can toggle Virtual indents on the fly by setting `vim.b.org_indent_mode` to either `true` or `false` when in a org
+buffer. For example, if virtual indents were enabled in the current buffer then you could disable them immediately by
+setting `vim.b.org_indent_mode = false`.
+
 This feature has no effect when enabled on Neovim versions < 0.10.0
 
 #### **org_adapt_indentation**
@@ -291,6 +296,14 @@ Possible values:
 * `true` - Disable [`org_adapt_indentation`](#org_adapt_indentation) by default when [`org_startup_indented`](#org_startup_indented) is enabled.
 * `false` - Do not disable [`org_adapt_indentation`](#org_adapt_indentation) by default when [`org_startup_indented`](#org_startup_indented) is enabled.
 
+#### **org_indent_mode_turns_on_hiding_stars**
+
+*type*: `boolean`<br />
+*default value*: `true`<br />
+Possible values:
+* `true` - Enable [`org_hide_leading_stars`](#org_hide_leading_stars) by default when [`org_indent_mode`](#org_startup_indented) is enabled for buffer (`vim.b.org_indent_mode = true`).
+* `false` - Do not modify the value in [`org_hide_leading_stars`](#org_hide_leading_stars) by default when [`.org_indent_mode`](#org_startup_indented) is enabled for buffer (`vim.b.org_indent_mode = true`).
+
 #### **org_src_window_setup**
 *type*: `string|function`<br />
 *default value*: "top 16new"<br />
@@ -668,7 +681,37 @@ require('orgmode').setup({
 
 You can find the configuration file that holds all default mappings [here](./lua/orgmode/config/mappings/init.lua)
 
-**NOTE**: All mappings are normal mode mappings (`nnoremap`)
+**NOTE**: All mappings are normal mode mappings (`nnoremap`) with exception of `org_return`
+
+### Use Enter in insert mode to add list items/checkboxes/todos
+By default, adding list items/checkboxes/todos is done with [org_meta_return](#org_meta_return) which is a normal mode mapping.
+If you want to have an insert mode mapping there are two options:
+
+1. If your terminal supports it, map a key like `Shift + Enter` to the meta return mapping (Recommended):
+```lua
+vim.api.nvim_create_autocmd('FileType', {
+  pattern = 'org',
+  callback = function()
+    vim.keymap.set('i', '<S-CR>', '<cmd>lua require("orgmode").action("org_mappings.meta_return")<CR>', {
+      silent = true,
+      buffer = true,
+    })
+  end,
+})
+```
+2. If you want to use only enter, enable `org_return_uses_meta_return` option:
+```lua
+require('orgmode').setup({
+  org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'},
+  org_default_notes_file = '~/Dropbox/org/refile.org',
+  mappings = {
+    org_return_uses_meta_return = true
+  }
+})
+```
+This will trigger `org_meta_return` if there is no content after the cursor position (either at the end of line or has just trailing spaces).
+Just note that this option always tries to use `meta_return`, which also adds new headlines
+automatically if you are on the headline line, which can give undesired results.
 
 ### Global mappings
 

ftplugin/org.lua

@@ -13,8 +13,9 @@ config:setup_foldlevel()
 if config.org_startup_indented then
   vim.b.org_indent_mode = true
 end
-require("orgmode.org.indent").setup()
+require('orgmode.org.indent').setup()
 
+vim.b.org_bufnr = vim.api.nvim_get_current_buf()
 vim.bo.modeline = false
 vim.opt_local.fillchars:append('fold: ')
 vim.opt_local.foldmethod = 'expr'

lua/orgmode/agenda/agenda_item.lua

@@ -9,11 +9,11 @@ local function add_padding(datetime)
   return datetime .. string.rep('.', 11 - datetime:len()) .. ' '
 end
 
----@class AgendaItem
----@field date Date
----@field headline_date Date
----@field real_date Date
----@field headline Section
+---@class OrgAgendaItem
+---@field date OrgDate
+---@field headline_date OrgDate
+---@field real_date OrgDate
+---@field headline OrgHeadline
 ---@field is_valid boolean
 ---@field is_today boolean
 ---@field is_same_day boolean
@@ -23,10 +23,10 @@ end
 ---@field highlights table[]
 local AgendaItem = {}
 
----@param headline_date Date single date in a headline
----@param headline Section
----@param date Date date for which item should be rendered
----@param index number
+---@param headline_date OrgDate single date in a headline
+---@param headline OrgHeadline
+---@param date OrgDate date for which item should be rendered
+---@param index? number
 function AgendaItem:new(headline_date, headline, date, index)
   local opts = {}
   opts.headline_date = headline_date
@@ -97,6 +97,9 @@ function AgendaItem:_is_valid_for_today()
     if self.headline:is_done() and config.org_agenda_skip_deadline_if_done then
       return false
     end
+    if self.headline_date.is_date_range_end then
+      return false
+    end
     if self.is_same_day then
       return true
     end
@@ -142,6 +145,12 @@ function AgendaItem:_is_valid_for_date()
     end
   end
 
+  if
+    (self.headline_date:is_deadline() or self.headline_date:is_scheduled()) and self.headline_date.is_date_range_end
+  then
+    return false
+  end
+
   if not self.headline_date:is_scheduled() or not self.headline_date:get_negative_adjustment() then
     return self.is_same_day or self.is_in_date_range
   end
@@ -188,7 +197,7 @@ function AgendaItem:_generate_label()
 end
 
 ---@private
----@param date Date
+---@param date OrgDate
 function AgendaItem:_format_time(date)
   local formatted_time = date:format_time()
 
@@ -238,14 +247,15 @@ function AgendaItem:_generate_highlight()
 end
 
 function AgendaItem:_add_keyword_highlight()
-  if self.headline.todo_keyword.value == '' then
+  local todo_keyword, _, type = self.headline:get_todo()
+  if not todo_keyword then
     return
   end
-  local hlgroup = hl_map[self.headline.todo_keyword.value] or hl_map[self.headline.todo_keyword.type]
+  local hlgroup = hl_map[todo_keyword] or hl_map[type]
   if hlgroup then
     table.insert(self.highlights, {
       hlgroup = hlgroup,
-      todo_keyword = self.headline.todo_keyword.value,
+      todo_keyword = todo_keyword,
     })
   end
 end

lua/orgmode/agenda/filter.lua

@@ -1,5 +1,5 @@
 local utils = require('orgmode.utils')
----@class AgendaFilter
+---@class OrgAgendaFilter
 ---@field value string
 ---@field available_tags table<string, boolean>
 ---@field available_categories table<string, boolean>
@@ -33,7 +33,7 @@ function AgendaFilter:should_filter()
   return vim.trim(self.value) ~= ''
 end
 
----@param headline Section
+---@param headline OrgHeadline
 ---@return boolean
 function AgendaFilter:matches(headline)
   if not self:should_filter() then
@@ -44,7 +44,7 @@ function AgendaFilter:matches(headline)
 
   if not term_match then
     local rgx = vim.regex(self.term)
-    term_match = rgx:match_str(headline.title)
+    term_match = rgx:match_str(headline:get_title())
   end
 
   if tag_cat_match_empty then
@@ -62,7 +62,7 @@ function AgendaFilter:matches(headline)
   return tag_cat_match and term_match
 end
 
----@param headline Section
+---@param headline OrgHeadline
 ---@private
 function AgendaFilter:_matches_exclude(headline)
   for _, tag in ipairs(self.tags) do
@@ -80,7 +80,7 @@ function AgendaFilter:_matches_exclude(headline)
   return true
 end
 
----@param headline Section
+---@param headline OrgHeadline
 ---@private
 function AgendaFilter:_matches_include(headline)
   local tags_to_check = {}
@@ -175,8 +175,8 @@ function AgendaFilter:parse_tags_and_categories(content)
   local categories = {}
   for _, item in ipairs(content) do
     if item.jumpable and item.headline then
-      categories[item.headline.category:lower()] = true
-      for _, tag in ipairs(item.headline.tags) do
+      categories[item.headline:get_category():lower()] = true
+      for _, tag in ipairs(item.headline:get_tags()) do
         tags[tag:lower()] = true
       end
     end