UP | HOME

Table of Contents

Module: yalms.orgonomics

Classes

Class: OrgClockReport

Fields
  • from (OrgDate)
  • to (OrgDate)
  • filter? (ClockReportFilter)
  • table (OrgTable)
  • files (OrgFiles)

Class: OrgConfigOpts

@diagnostic disable-next-line: duplicate-doc-field

Fields
  • win_split_mode? ('horizontal') | 'vertical' | 'auto' | 'float' | string[] | fun(name: string) How to open agenda and capture windows. Default: 'horizontal'

Class: Global

Fields
  • __yalms_orgonomics_capture_win (snacks.win.Config)

Class: ClockManagerOpts

Fields
  • org_dir (string) Base directory for org files (required)
  • tag? (string)
  • breaks_tag? (string)
  • breaks_file? (string) (default "breaks.org", relative to orgdir)
  • exports_dir? (string) (default "exports", relative to orgdir)
  • checkin_task? (string)

Class: ClockManagerRt (extends ClockManagerOpts)

Fields
  • org_dir (string)
  • tag (string)
  • breaks_tag (string)
  • breaks_file (string)
  • exports_dir (string)
  • checkin_task (string)
  • break_types (string[])
  • last_known_clock? (OrgApiHeadline)

Class: ClockManager (extends EventEmitter)

Fields
  • private (_rt) ClockManagerRt

Class: OrgApiFile

Fields
  • insert_headline (fun(self: OrgApiFile, headline: OrgApiHeadline | OrgHeadline | { text: string, level: integer }, after?: OrgApiHeadline | OrgHeadline))

Class: snacks.picker

Fields
  • orgfiles (OrgFilePickerOpts)

Class: OrgFilesActivePicker

Fields
  • source ('orgfiles')
  • picker (snacks.Picker)

Class: OrgFilesPickerItem

Fields
  • text (string)
  • file (string)
  • orgfile (OrgFile)

Class: OrgFilePickerOpts (extends snacks.picker.files.Config)

Fields
  • title_format? ('title') | 'filename' | 'both'

Class: OrgApiHeadline

Fields
  • set_todo (fun(self: OrgApiHeadline, keyword: string))

Class: OrgApiHeadline

Fields
  • clock_in (fun(self: OrgApiHeadline))

Class: OrgApiHeadline

Fields
  • clock_out (fun(self: OrgApiHeadline))

Class: OrgApiHeadline

Fields
  • is_clocked_in (fun(self: OrgApiHeadline))

Class: OrgApiHeadline

Fields
  • toggle_clock (fun(self: OrgApiHeadline))

Class: OrgApiHeadline

Fields
  • cancel_active_clock (fun(self: OrgApiHeadline))

Class: OrgApiHeadline

Fields
  • promote (fun(self: OrgApiHeadline, amount?: number, recursive?: boolean))

Class: OrgApiHeadline

Fields
  • demote (fun(self: OrgApiHeadline, amount?: number, recursive?: boolean))

Class: OrgApiHeadline

Fields
  • get_closest_headline (OrgPromise<OrgHeadline>)

Class: OrgApiHeadline

Fields
  • get_lines (OrgPromise<string>)

Class: OrgApiHeadline

Fields
  • get_content (OrgPromise<string>)

Class: snacks.picker

Fields
  • orgheadlines (OrgHeadlinesPicker)

Class: OrgHeadlinesPicker (extends snacks.Picker)

Fields
  • opts (OrgHeadlinesPickerConfig)
  • narea? (NArea)

Class: OrgHeadlinesPickerConfig (extends snacks.picker.Config)

Fields
  • orgtags? (string[])
  • dirs? (string[]) directories to search
  • sort (OrgHeadlinesPickerSort?)
  • level (integer)
  • file (string?)
  • keywords (string[]?)
  • _keywords (table<string,) string>?
  • node? (OrgHeadline)
  • actions (OrgHeadlinesPickerActionsSpecs)
  • hooks? ({) after?: table<OrgHeadlinesPickerAction, fun(item: OrgHeadlinesPickerItem, picker: snacks.Picker, action?: OrgHeadlinesPickerAction)> }
  • narea? (NArea)

Class: OrgHeadlinesPickerFindarCtx (extends snacks.picker.finder.ctx)

Fields
  • _opts (OrgHeadlinesPickerConfig)

Class: OrgHeadlinesPickerFilter

Fields
  • filter (fun(item: OrgHeadlinesPickerItem, filter: OrgHeadlinesPickerFilterOpts):boolean?)

Class: OrgHeadlinesPickerSort

Fields
  • fields (OrgHeadlinesPickerSortFields)

Class: OrgHeadlinesPickerSortFields

Fields
  • priority (snacks.picker.sort.Field)
  • deadline (snacks.picker.sort.Field)

Class: OrgHeadlinesPickerFilterOpts

Fields
  • level (integer)
  • file (string?)
  • keywords (table<string,) string>?
  • node? (OrgHeadline)

Class: OrgHeadlinesPickerItem

Fields
  • node (OrgHeadline)
  • file (string)
  • text (string)
  • orgtags (string[])
  • tags_str (string)
  • keyword (string)
  • keyword_l (string)
  • level (integer)
  • priority (integer)
  • deadline_unix (integer)
  • preview (snacks.picker.preview)

Class: OrgHeadline

Class: OrgonomicsOpts

Fields
  • pickers? (OrgonomicsPickersOpts|boolean)
  • capture_win? (true) | snacks.win.Config
  • clock? (OrgonomicsClockOpts|true)

Class: OrgonomicsClockOpts

Fields
  • org_dir (string) Base directory for org files (required)
  • tag? (string) (default "orgonomics")
  • breaks_tag? (string) (default "breaks")
  • breaks_file? (string) (default "breaks.org", relative to orgdir)
  • exports_dir? (string) (default "exports", relative to orgdir)
  • checkin_task? (string) (default "No active task")

Class: Orgonomics

Class: OrgonomicsPickersOpts

Fields
  • files? (boolean) | OrgFilePickerOpts
  • headlines? (boolean) | OrgHeadlinesPickerConfig

Class: OrgonomicsPickers

Functions

new(opts)

ClockReport:new

Parameters
  • opts ({) from: OrgDate, to: OrgDate, files: OrgFiles, filter?: ClockReportFilter }
Returns
  • OrgClockReport

gettablereport(startline)

ClockReport:get_table_report

Parameters
  • start_line (number)
Returns
  • OrgTable

capture(cfg)

yalms.orgonomics.capture

Parameters
  • cfg (snacks.win.Config, optional)

getcheckintask()

ClockManager:get_checkin_task

Returns
  • OrgPromise<OrgApiHeadline>

editcheckedintask()

ClockManager:edit_checked_in_task

Returns
  • OrgPromise<OrgApiHeadline>

clockin(opts)

ClockManager:clock_in

Parameters
  • opts ({, optional) pick?: boolean, memo?: boolean, captured?: boolean, isbreak?: boolean, template?: string, file?: string, dirs?: string[] }

_pick(isbreak, dirs)

ClockManager:_pick

Parameters
  • is_break (boolean, optional)
  • dirs (string[], optional)

_memo(isbreak, templatename, file)

ClockManager:_memo

Parameters
  • is_break (boolean)
  • template_name (string, optional)
  • file (string, optional)

isbreak(headline, title)

ClockManager:is_break

Parameters
  • headline (OrgApiHeadline)
  • title (string, optional)

ischeckintask(breakheadline)

ClockManager:is_checkin_task

NOTE: It doesn't check if it is break at all.

Parameters
  • break_headline (OrgApiHeadline)

summarize(period, wincfg)

ClockManager:summarize

TODO: Optimize by caching results

Parameters
  • period (Period)
  • win_cfg (snacks.win.Config, optional)

make(cb, kind)

yalms.orgonomics.make

Parameters
  • cb (fun(item:) OrgHeadlinesPickerItem, picker: OrgHeadlinesPicker)
  • kind ('filter', optional) | 'mutation' | 'done'

make(keyword)

yalms.orgonomics.make

Parameters
  • keyword ('TODO') | 'PROG' | 'DONE' | 'CLOSED'

resolvefileapi(filenameorheadline, checknode, checkfile)

yalms.orgonomics.resolve_file_api

Resolve API File by Headline or filename

Parameters
  • filename_or_headline (OrgHeadline) | string
  • check_node (fun(node:, optional) OrgHeadline): string?
  • check_file (fun(file:, optional) OrgApiFile): string?
Returns
  • OrgApiFile? file

resolveheadlineapi(node, checknode, checkfile, checkheadline)

yalms.orgonomics.resolve_headline_api

Parameters
  • node (OrgHeadline)
  • check_node (fun(node:, optional) OrgHeadline): string?
  • check_file (fun(file:, optional) OrgApiFile): string?
  • check_headline (fun(headline:, optional) OrgApiHeadline): string?
Returns
  • OrgApiHeadline? headline
  • OrgApiFile? file

getactiveclock()

yalms.orgonomics.get_active_clock

Get active clock

Returns
  • OrgPromise<OrgActiveClock>

clockoutall(keep)

yalms.orgonomics.clock_out_all

Parameters
  • keep (OrgHeadline?) Keep this headline clocked in

issameheadline(a, b)

yalms.orgonomics.is_same_headline

Parameters
  • a (OrgHeadline?)
  • b (OrgHeadline?)

isbreak(headline, title, check)

yalms.orgonomics.is_break

Parameters
  • headline (OrgApiHeadline)
  • title (string, optional)
  • check (fun(headline:, optional) OrgApiHeadline): boolean

prioritytointeger(priority)

yalms.orgonomics.priority_to_integer

Parameters
  • priority (string)

diriscovered(dirs, target)

yalms.orgonomics.dir_is_covered

Checks if a directory is already added to org agenda files

Parameters
  • dirs (string[])
  • target (string)

setup(opts)

yalms.orgonomics.setup

Parameters
  • opts (OrgonomicsOpts|true, optional)

setup(opts)

yalms.orgonomics.setup

Parameters
  • opts (OrgonomicsPickersOpts)

default()

yalms.orgonomics.default

Returns
  • OrgonomicsPickersOpts