Skip to content

feat: allow user to set the default todo keyword #923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lua/orgmode/config/defaults.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ local DefaultConfig = {
org_agenda_files = '',
org_default_notes_file = '',
org_todo_keywords = { 'TODO', '|', 'DONE' },
org_default_todo_keyword = nil,
org_todo_repeat_to_state = nil,
org_todo_keyword_faces = {},
org_deadline_warning_days = 14,
Expand Down
1 change: 1 addition & 0 deletions lua/orgmode/config/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ function Config:get_todo_keywords()
end
self.todo_keywords = TodoKeywords:new({
org_todo_keywords = self.opts.org_todo_keywords,
org_default_todo_keyword = self.opts.org_default_todo_keyword,
org_todo_keyword_faces = self.opts.org_todo_keyword_faces,
})
return self.todo_keywords
Expand Down
10 changes: 9 additions & 1 deletion lua/orgmode/objects/todo_keywords/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ local TodoKeyword = require('orgmode.objects.todo_keywords.todo_keyword')

---@class OrgTodoKeywords
---@field org_todo_keywords string[]
---@field org_default_todo_keyword string[]
---@field org_todo_keyword_faces table<string, string>
---@field todo_keywords OrgTodoKeyword[]
local TodoKeywords = {}
TodoKeywords.__index = TodoKeywords

---@param opts { org_todo_keywords: string[], org_todo_keyword_faces: table<string, string> }
---@param opts { org_todo_keywords: string[], org_default_todo_keyword: string[], org_todo_keyword_faces: table<string, string> }
---@return OrgTodoKeywords
function TodoKeywords:new(opts)
local this = setmetatable({
org_todo_keywords = opts.org_todo_keywords,
org_default_todo_keyword = opts.org_default_todo_keyword,
org_todo_keyword_faces = opts.org_todo_keyword_faces,
}, self)
this:_parse()
Expand Down Expand Up @@ -47,6 +49,12 @@ end
---@param type OrgTodoKeywordType
---@return OrgTodoKeyword
function TodoKeywords:first_by_type(type)
if type == 'TODO' and self.org_default_todo_keyword ~= nil then
local default_todo = self:find(self.org_default_todo_keyword)
if default_todo ~= nil then
return default_todo
end
end
for _, keyword in ipairs(self.todo_keywords) do
if type == keyword.type then
return keyword
Expand Down
Loading