Skip to content
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.

Sign up for GitHub

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

chore(luadoc): Let mapping items accept string[] #944

Merged
merged 3 commits into from
Mar 26, 2025
Merged

chore(luadoc): Let mapping items accept string[] #944

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11fb8c8
chore(luadoc): Let mapping items accept string[]
js0ny Mar 25, 2025
fcd15f6
chore(luadoc): Add alias for org mappings
js0ny Mar 26, 2025
eea9393
Merge branch 'master' into chore-mapping-luadoc
js0ny Mar 26, 2025
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
206 changes: 103 additions & 103 deletions lua/orgmode/config/_meta.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,124 +45,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? string | string[] Mappings used to open agenda prompt. Default: '<prefix>a'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's create an alias and use alias instead:

---@alias OrgMappingValue string | string[]


---@field org_agenda? OrgMappingValue Mappings used to open agenda prompt. Default: '<prefix>a'
---etc.

---@field org_capture? string | string[] 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? string | string[] Default: 'f'
---@field org_agenda_earlier? string | string[] Default: 'b'
---@field org_agenda_goto_today? string | string[] Default: '.'
---@field org_agenda_day_view? string | string[] Default: 'vd'
---@field org_agenda_week_view? string | string[] Default: 'vw'
---@field org_agenda_month_view? string | string[] Default: 'vm'
---@field org_agenda_year_view? string | string[] Default: 'vy'
---@field org_agenda_quit? string | string[] Default: 'q'
---@field org_agenda_switch_to? string | string[] Default: '<CR>'
---@field org_agenda_goto? string | string[] Default: '<TAB>'
---@field org_agenda_goto_date? string | string[] Default: 'J'
---@field org_agenda_redo? string | string[] Default: 'r'
---@field org_agenda_todo? string | string[] Default: 't'
---@field org_agenda_clock_goto? string | string[] Default: '<prefix>xj'
---@field org_agenda_set_effort? string | string[] Default: '<prefix>xe'
---@field org_agenda_clock_in? string | string[] Default: 'I'
---@field org_agenda_clock_out? string | string[] Default: 'O'
---@field org_agenda_clock_cancel? string | string[] Default: 'X'
---@field org_agenda_clockreport_mode? string | string[] Default: 'R'
---@field org_agenda_priority? string | string[] Default: '<prefix>,'
---@field org_agenda_priority_up? string | string[] Default: '+'
---@field org_agenda_priority_down? string | string[] Default: '-'
---@field org_agenda_archive? string | string[] Default: '<prefix>$'
---@field org_agenda_toggle_archive_tag? string | string[] Default: '<prefix>A'
---@field org_agenda_set_tags? string | string[] Default: '<prefix>t'
---@field org_agenda_deadline? string | string[] Default: '<prefix>id'
---@field org_agenda_schedule? string | string[] Default: '<prefix>is'
---@field org_agenda_filter? string | string[] Default: '/'
---@field org_agenda_refile? string | string[] Default: '<prefix>r'
---@field org_agenda_add_note? string | string[] Default: '<prefix>na'
---@field org_agenda_show_help? string | string[] 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? string | string[] Default: '<C-c>'
---@field org_capture_refile? string | string[] Default: '<prefix>r'
---@field org_capture_kill? string | string[] Default: '<prefix>k'
---@field org_capture_show_help? string | string[] Default: 'g?'
---
---@class OrgMappingsNote
---@field org_note_finalize? string Default: '<C-c>'
---@field org_note_kill? string Default: '<prefix>k'
---@field org_note_finalize? string | string[] Default: '<C-c>'
---@field org_note_kill? string | string[] 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? string | string[] Default: '<prefix>r'
---@field org_timestamp_up_day? string | string[] Default: '<S-UP>'
---@field org_timestamp_down_day? string | string[] Default: '<S-DOWN>'
---@field org_timestamp_up? string | string[] Default: '<C-a>'
---@field org_timestamp_down? string | string[] Default: '<C-x>'
---@field org_change_date? string | string[] Default: 'cid'
---@field org_priority? string | string[] Default: '<prefix>,'
---@field org_priority_up? string | string[] Default: 'ciR'
---@field org_priority_down? string | string[] Default: 'cir'
---@field org_todo? string | string[] Default: 'cit'
---@field org_todo_prev? string | string[] Default: 'ciT'
---@field org_toggle_checkbox? string | string[] Default: '<C-Space>'
---@field org_toggle_heading? string | string[] Default: '<prefix>*'
---@field org_open_at_point? string | string[] Default: '<prefix>o'
---@field org_edit_special? string | string[] Default: "<prefix>'"
---@field org_add_note? string | string[] Default: '<prefix>na'
---@field org_cycle? string | string[] Default: '<TAB>'
---@field org_global_cycle? string | string[] Default: '<S-TAB>'
---@field org_archive_subtree? string | string[] Default: '<prefix>$'
---@field org_set_tags_command? string | string[] Default: '<prefix>t'
---@field org_toggle_archive_tag? string | string[] Default: '<prefix>A'
---@field org_do_promote? string | string[] Default: '<<'
---@field org_do_demote? string | string[] Default: '>>'
---@field org_promote_subtree? string | string[] Default: '<s'
---@field org_demote_subtree? string | string[] Default: '>s'
---@field org_meta_return? string | string[] Add heading, item or row (context-dependent) Default: '<Leader><CR>'
---@field org_return? string | string[] Default: '<CR>'
---@field org_insert_heading_respect_content? string | string[] Add new heading after current heading block (same level) Default: '<prefix>ih'
---@field org_insert_todo_heading? string | string[] Add new todo heading right after current heading (same level) Default: '<prefix>iT'
---@field org_insert_todo_heading_respect_content? string | string[] Add new todo heading after current heading block (same level). Default: '<prefix>it'
---@field org_move_subtree_up? string | string[] Default: '<prefix>K'
---@field org_move_subtree_down? string | string[] Default: '<prefix>J'
---@field org_export? string | string[] Default: '<prefix>e'
---@field org_next_visible_heading? string | string[] Default: '}'
---@field org_previous_visible_heading? string | string[] Default: '{'
---@field org_forward_heading_same_level? string | string[] Default: ']]'
---@field org_backward_heading_same_level? string | string[] Default: '[['
---@field outline_up_heading? string | string[] Default: 'g{'
---@field org_deadline? string | string[] Default: '<prefix>id'
---@field org_schedule? string | string[] Default: '<prefix>is'
---@field org_time_stamp? string | string[] Default: '<prefix>i.'
---@field org_time_stamp_inactive? string | string[] Default: '<prefix>i!'
---@field org_toggle_timestamp_type? string | string[] Default: '<prefix>d!'
---@field org_insert_link? string | string[] Default: '<prefix>li'
---@field org_store_link? string | string[] Default: '<prefix>ls'
---@field org_clock_in? string | string[] Default: '<prefix>xi'
---@field org_clock_out? string | string[] Default: '<prefix>xo'
---@field org_clock_cancel? string | string[] Default: '<prefix>xq'
---@field org_clock_goto? string | string[] Default: '<prefix>xj'
---@field org_set_effort? string | string[] Default: '<prefix>xe'
---@field org_show_help? string | string[] Default: 'g?'
---@field org_babel_tangle? string | string[] 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? string | string[] Default: 'ih'
---@field around_heading? string | string[] Default: 'ah'
---@field inner_subtree? string | string[] Default: 'ir'
---@field around_subtree? string | string[] Default: 'ar'
---@field inner_heading_from_root? string | string[] Default: 'Oh'
---@field around_heading_from_root? string | string[] Default: 'OH'
---@field inner_subtree_from_root? string | string[] Default: 'Or'
---@field around_subtree_from_root? string | string[] 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? string | string[] Default: '<prefix>k'
---@field org_edit_src_save? string | string[] Default: '<prefix>w'
---@field org_edit_src_save_exit? string | string[] Default: "<prefix>'"
---@field org_edit_src_show_help? string | string[] Default: 'g?'
---
---@class OrgEmacsConfig
---@field executable_path? string path to emacs executable. Default: 'emacs'
Expand Down
Loading