diff --git a/lua/orgmode/config/_meta.lua b/lua/orgmode/config/_meta.lua index 852baa6b6..8b37ddf3d 100644 --- a/lua/orgmode/config/_meta.lua +++ b/lua/orgmode/config/_meta.lua @@ -1,5 +1,6 @@ ---@meta ---@alias OrgAgendaSpan 'day' | 'week' | 'month' | 'year' | number +---@alias OrgMappingValue string | string[] ---@class OrgAgendaCustomCommandTypeInterface ---@field type? 'agenda' | 'tags' | 'tags_todo' @@ -45,124 +46,124 @@ ---@field scheduled_reminder? boolean Enable notifiactions for DEADLINE dates. Default: true ---@class OrgMappingsGlobal ----@field org_agenda? string Mappings used to open agenda prompt. Default: '<prefix>a' ----@field org_capture? string Mappings used to open capture prompt. Default: '<prefix>c' +---@field org_agenda? OrgMappingValue Mappings used to open agenda prompt. Default: '<prefix>a' +---@field org_capture? OrgMappingValue Mappings used to open capture prompt. Default: '<prefix>c' ---@class OrgHyperlinksConfig ---@field sources OrgLinkType[] ---@class OrgMappingsAgenda ----@field org_agenda_later? string Default: 'f' ----@field org_agenda_earlier? string Default: 'b' ----@field org_agenda_goto_today? string Default: '.' ----@field org_agenda_day_view? string Default: 'vd' ----@field org_agenda_week_view? string Default: 'vw' ----@field org_agenda_month_view? string Default: 'vm' ----@field org_agenda_year_view? string Default: 'vy' ----@field org_agenda_quit? string Default: 'q' ----@field org_agenda_switch_to? string Default: '<CR>' ----@field org_agenda_goto? string Default: '<TAB>' ----@field org_agenda_goto_date? string Default: 'J' ----@field org_agenda_redo? string Default: 'r' ----@field org_agenda_todo? string Default: 't' ----@field org_agenda_clock_goto? string Default: '<prefix>xj' ----@field org_agenda_set_effort? string Default: '<prefix>xe' ----@field org_agenda_clock_in? string Default: 'I' ----@field org_agenda_clock_out? string Default: 'O' ----@field org_agenda_clock_cancel? string Default: 'X' ----@field org_agenda_clockreport_mode? string Default: 'R' ----@field org_agenda_priority? string Default: '<prefix>,' ----@field org_agenda_priority_up? string Default: '+' ----@field org_agenda_priority_down? string Default: '-' ----@field org_agenda_archive? string Default: '<prefix>$' ----@field org_agenda_toggle_archive_tag? string Default: '<prefix>A' ----@field org_agenda_set_tags? string Default: '<prefix>t' ----@field org_agenda_deadline? string Default: '<prefix>id' ----@field org_agenda_schedule? string Default: '<prefix>is' ----@field org_agenda_filter? string Default: '/' ----@field org_agenda_refile? string Default: '<prefix>r' ----@field org_agenda_add_note? string Default: '<prefix>na' ----@field org_agenda_show_help? string Default: 'g?' +---@field org_agenda_later? OrgMappingValue Default: 'f' +---@field org_agenda_earlier? OrgMappingValue Default: 'b' +---@field org_agenda_goto_today? OrgMappingValue Default: '.' +---@field org_agenda_day_view? OrgMappingValue Default: 'vd' +---@field org_agenda_week_view? OrgMappingValue Default: 'vw' +---@field org_agenda_month_view? OrgMappingValue Default: 'vm' +---@field org_agenda_year_view? OrgMappingValue Default: 'vy' +---@field org_agenda_quit? OrgMappingValue Default: 'q' +---@field org_agenda_switch_to? OrgMappingValue Default: '<CR>' +---@field org_agenda_goto? OrgMappingValue Default: '<TAB>' +---@field org_agenda_goto_date? OrgMappingValue Default: 'J' +---@field org_agenda_redo? OrgMappingValue Default: 'r' +---@field org_agenda_todo? OrgMappingValue Default: 't' +---@field org_agenda_clock_goto? OrgMappingValue Default: '<prefix>xj' +---@field org_agenda_set_effort? OrgMappingValue Default: '<prefix>xe' +---@field org_agenda_clock_in? OrgMappingValue Default: 'I' +---@field org_agenda_clock_out? OrgMappingValue Default: 'O' +---@field org_agenda_clock_cancel? OrgMappingValue Default: 'X' +---@field org_agenda_clockreport_mode? OrgMappingValue Default: 'R' +---@field org_agenda_priority? OrgMappingValue Default: '<prefix>,' +---@field org_agenda_priority_up? OrgMappingValue Default: '+' +---@field org_agenda_priority_down? OrgMappingValue Default: '-' +---@field org_agenda_archive? OrgMappingValue Default: '<prefix>$' +---@field org_agenda_toggle_archive_tag? OrgMappingValue Default: '<prefix>A' +---@field org_agenda_set_tags? OrgMappingValue Default: '<prefix>t' +---@field org_agenda_deadline? OrgMappingValue Default: '<prefix>id' +---@field org_agenda_schedule? OrgMappingValue Default: '<prefix>is' +---@field org_agenda_filter? OrgMappingValue Default: '/' +---@field org_agenda_refile? OrgMappingValue Default: '<prefix>r' +---@field org_agenda_add_note? OrgMappingValue Default: '<prefix>na' +---@field org_agenda_show_help? OrgMappingValue Default: 'g?' --- ---@class OrgMappingsCapture ----@field org_capture_finalize? string Default: '<C-c>' ----@field org_capture_refile? string Default: '<prefix>r' ----@field org_capture_kill? string Default: '<prefix>k' ----@field org_capture_show_help? string Default: 'g?' +---@field org_capture_finalize? OrgMappingValue Default: '<C-c>' +---@field org_capture_refile? OrgMappingValue Default: '<prefix>r' +---@field org_capture_kill? OrgMappingValue Default: '<prefix>k' +---@field org_capture_show_help? OrgMappingValue Default: 'g?' --- ---@class OrgMappingsNote ----@field org_note_finalize? string Default: '<C-c>' ----@field org_note_kill? string Default: '<prefix>k' +---@field org_note_finalize? OrgMappingValue Default: '<C-c>' +---@field org_note_kill? OrgMappingValue Default: '<prefix>k' --- ---@class OrgMappingsOrg ----@field org_refile? string Default: '<prefix>r' ----@field org_timestamp_up_day? string Default: '<S-UP>' ----@field org_timestamp_down_day? string Default: '<S-DOWN>' ----@field org_timestamp_up? string Default: '<C-a>' ----@field org_timestamp_down? string Default: '<C-x>' ----@field org_change_date? string Default: 'cid' ----@field org_priority? string Default: '<prefix>,' ----@field org_priority_up? string Default: 'ciR' ----@field org_priority_down? string Default: 'cir' ----@field org_todo? string Default: 'cit' ----@field org_todo_prev? string Default: 'ciT' ----@field org_toggle_checkbox? string Default: '<C-Space>' ----@field org_toggle_heading? string Default: '<prefix>*' ----@field org_open_at_point? string Default: '<prefix>o' ----@field org_edit_special? string Default: "<prefix>'" ----@field org_add_note? string Default: '<prefix>na' ----@field org_cycle? string Default: '<TAB>' ----@field org_global_cycle? string Default: '<S-TAB>' ----@field org_archive_subtree? string Default: '<prefix>$' ----@field org_set_tags_command? string Default: '<prefix>t' ----@field org_toggle_archive_tag? string Default: '<prefix>A' ----@field org_do_promote? string Default: '<<' ----@field org_do_demote? string Default: '>>' ----@field org_promote_subtree? string Default: '<s' ----@field org_demote_subtree? string Default: '>s' ----@field org_meta_return? string Add heading, item or row (context-dependent) Default: '<Leader><CR>' ----@field org_return? string Default: '<CR>' ----@field org_insert_heading_respect_content? string Add new heading after current heading block (same level) Default: '<prefix>ih' ----@field org_insert_todo_heading? string Add new todo heading right after current heading (same level) Default: '<prefix>iT' ----@field org_insert_todo_heading_respect_content? string Add new todo heading after current heading block (same level). Default: '<prefix>it' ----@field org_move_subtree_up? string Default: '<prefix>K' ----@field org_move_subtree_down? string Default: '<prefix>J' ----@field org_export? string Default: '<prefix>e' ----@field org_next_visible_heading? string Default: '}' ----@field org_previous_visible_heading? string Default: '{' ----@field org_forward_heading_same_level? string Default: ']]' ----@field org_backward_heading_same_level? string Default: '[[' ----@field outline_up_heading? string Default: 'g{' ----@field org_deadline? string Default: '<prefix>id' ----@field org_schedule? string Default: '<prefix>is' ----@field org_time_stamp? string Default: '<prefix>i.' ----@field org_time_stamp_inactive? string Default: '<prefix>i!' ----@field org_toggle_timestamp_type? string Default: '<prefix>d!' ----@field org_insert_link? string Default: '<prefix>li' ----@field org_store_link? string Default: '<prefix>ls' ----@field org_clock_in? string Default: '<prefix>xi' ----@field org_clock_out? string Default: '<prefix>xo' ----@field org_clock_cancel? string Default: '<prefix>xq' ----@field org_clock_goto? string Default: '<prefix>xj' ----@field org_set_effort? string Default: '<prefix>xe' ----@field org_show_help? string Default: 'g?' ----@field org_babel_tangle? string Default: '<prefix>bt' +---@field org_refile? OrgMappingValue Default: '<prefix>r' +---@field org_timestamp_up_day? OrgMappingValue Default: '<S-UP>' +---@field org_timestamp_down_day? OrgMappingValue Default: '<S-DOWN>' +---@field org_timestamp_up? OrgMappingValue Default: '<C-a>' +---@field org_timestamp_down? OrgMappingValue Default: '<C-x>' +---@field org_change_date? OrgMappingValue Default: 'cid' +---@field org_priority? OrgMappingValue Default: '<prefix>,' +---@field org_priority_up? OrgMappingValue Default: 'ciR' +---@field org_priority_down? OrgMappingValue Default: 'cir' +---@field org_todo? OrgMappingValue Default: 'cit' +---@field org_todo_prev? OrgMappingValue Default: 'ciT' +---@field org_toggle_checkbox? OrgMappingValue Default: '<C-Space>' +---@field org_toggle_heading? OrgMappingValue Default: '<prefix>*' +---@field org_open_at_point? OrgMappingValue Default: '<prefix>o' +---@field org_edit_special? OrgMappingValue Default: "<prefix>'" +---@field org_add_note? OrgMappingValue Default: '<prefix>na' +---@field org_cycle? OrgMappingValue Default: '<TAB>' +---@field org_global_cycle? OrgMappingValue Default: '<S-TAB>' +---@field org_archive_subtree? OrgMappingValue Default: '<prefix>$' +---@field org_set_tags_command? OrgMappingValue Default: '<prefix>t' +---@field org_toggle_archive_tag? OrgMappingValue Default: '<prefix>A' +---@field org_do_promote? OrgMappingValue Default: '<<' +---@field org_do_demote? OrgMappingValue Default: '>>' +---@field org_promote_subtree? OrgMappingValue Default: '<s' +---@field org_demote_subtree? OrgMappingValue Default: '>s' +---@field org_meta_return? OrgMappingValue Add heading, item or row (context-dependent) Default: '<Leader><CR>' +---@field org_return? OrgMappingValue Default: '<CR>' +---@field org_insert_heading_respect_content? OrgMappingValue Add new heading after current heading block (same level) Default: '<prefix>ih' +---@field org_insert_todo_heading? OrgMappingValue Add new todo heading right after current heading (same level) Default: '<prefix>iT' +---@field org_insert_todo_heading_respect_content? OrgMappingValue Add new todo heading after current heading block (same level). Default: '<prefix>it' +---@field org_move_subtree_up? OrgMappingValue Default: '<prefix>K' +---@field org_move_subtree_down? OrgMappingValue Default: '<prefix>J' +---@field org_export? OrgMappingValue Default: '<prefix>e' +---@field org_next_visible_heading? OrgMappingValue Default: '}' +---@field org_previous_visible_heading? OrgMappingValue Default: '{' +---@field org_forward_heading_same_level? OrgMappingValue Default: ']]' +---@field org_backward_heading_same_level? OrgMappingValue Default: '[[' +---@field outline_up_heading? OrgMappingValue Default: 'g{' +---@field org_deadline? OrgMappingValue Default: '<prefix>id' +---@field org_schedule? OrgMappingValue Default: '<prefix>is' +---@field org_time_stamp? OrgMappingValue Default: '<prefix>i.' +---@field org_time_stamp_inactive? OrgMappingValue Default: '<prefix>i!' +---@field org_toggle_timestamp_type? OrgMappingValue Default: '<prefix>d!' +---@field org_insert_link? OrgMappingValue Default: '<prefix>li' +---@field org_store_link? OrgMappingValue Default: '<prefix>ls' +---@field org_clock_in? OrgMappingValue Default: '<prefix>xi' +---@field org_clock_out? OrgMappingValue Default: '<prefix>xo' +---@field org_clock_cancel? OrgMappingValue Default: '<prefix>xq' +---@field org_clock_goto? OrgMappingValue Default: '<prefix>xj' +---@field org_set_effort? OrgMappingValue Default: '<prefix>xe' +---@field org_show_help? OrgMappingValue Default: 'g?' +---@field org_babel_tangle? OrgMappingValue Default: '<prefix>bt' ---@class OrgMappingsTextObjects ----@field inner_heading? string Default: 'ih' ----@field around_heading? string Default: 'ah' ----@field inner_subtree? string Default: 'ir' ----@field around_subtree? string Default: 'ar' ----@field inner_heading_from_root? string Default: 'Oh' ----@field around_heading_from_root? string Default: 'OH' ----@field inner_subtree_from_root? string Default: 'Or' ----@field around_subtree_from_root? string Default: 'OR' +---@field inner_heading? OrgMappingValue Default: 'ih' +---@field around_heading? OrgMappingValue Default: 'ah' +---@field inner_subtree? OrgMappingValue Default: 'ir' +---@field around_subtree? OrgMappingValue Default: 'ar' +---@field inner_heading_from_root? OrgMappingValue Default: 'Oh' +---@field around_heading_from_root? OrgMappingValue Default: 'OH' +---@field inner_subtree_from_root? OrgMappingValue Default: 'Or' +---@field around_subtree_from_root? OrgMappingValue Default: 'OR' --- ---@class OrgMappingsEditSrc ----@field org_edit_src_abort? string Default: '<prefix>k' ----@field org_edit_src_save? string Default: '<prefix>w' ----@field org_edit_src_save_exit? string Default: "<prefix>'" ----@field org_edit_src_show_help? string Default: 'g?' +---@field org_edit_src_abort? OrgMappingValue Default: '<prefix>k' +---@field org_edit_src_save? OrgMappingValue Default: '<prefix>w' +---@field org_edit_src_save_exit? OrgMappingValue Default: "<prefix>'" +---@field org_edit_src_show_help? OrgMappingValue Default: 'g?' --- ---@class OrgEmacsConfig ---@field executable_path? string path to emacs executable. Default: 'emacs'