nvim-orgmode / nvim-orgmode/orgmode
Dynamically add files to `org_agenda_files`
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 3.9k
- Forks
- 190
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Description
Does this feature exist in Emacs orgmode core?
N/A
Orgmode link
No response
Feature value
I usually take project notes using org, and I will keep those notes in the project folder.
It would be useful to add or drop a particular folder from org_agenda_files whenever needed. That way we do not bloat the amount of notes parsed by the plugin and allow the user to focus on the notes she/he needs at the moment.
Additional context
My guess would be to create a lua function (maybe in my init.lua) that would:
- change
org_agenda_files - call
Config:get_all_files - call
File:reload().
Is that the way to go? Would I be missing something important?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing Config:get_all_files and File:reload, then inspect how org_agenda_files is read and how agenda files are represented. Determine how a Lua-facing add/drop operation should update the configuration and refresh files; done means a folder can be added or removed without restarting Neovim and the agenda reflects the change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100