plugins.ledger.settings

The configuration options for ledger without the ledger_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal ledger_foo_bar=1
  • hello = "world" -> :setglobal ledger_hello="world"
  • some_toggle = true -> :setglobal ledger_some_toggle
  • other_toggle = false -> :setglobal noledger_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  detailed_first = 1;
  fillstring = " ";
  fold_blanks = 0;
  maxwidth = 80;
}

Declared by:

plugins.ledger.settings.accounts_cmd

To use a custom external system command to generate a list of account names for completion, set the following. If bin is set, this will default to running that command with arguments to parse the current file using the accounts subcommand (works with ledger or hledger), otherwise it will parse the postings in the current file itself.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.align_at

Specify at which column decimal separators should be aligned.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 60

Declared by:

plugins.ledger.settings.align_commodity

Align on the commodity location instead of the amount

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.align_last

Specify alignment on first or last matching separator.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.bin

Path to the ledger executable.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.cleared_string

Text of the output of the |:Balance| command.

Type: null or string or raw lua code

Default: null

Plugin default: "Cleared: "

Declared by:

plugins.ledger.settings.commodity_before

Flag that tells whether the commodity should be prepended or appended to the amount.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.ledger.settings.commodity_sep

String to be put between the commodity and the amount:

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.ledger.settings.commodity_spell

Flag that enable the spelling of the amount.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.date_format

Format of transaction date.

Type: null or string or raw lua code

Default: null

Plugin default: "%Y/%m/%d"

Declared by:

plugins.ledger.settings.decimal_sep

Decimal separator.

Type: null or string or raw lua code

Default: null

Plugin default: "."

Declared by:

plugins.ledger.settings.default_commodity

Default commodity used by ledger#align_amount_at_cursor().

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.ledger.settings.descriptions_cmd

To use a custom external system command to generate a list of descriptions for completion, set the following. If bin is set, this will default to running that command with arguments to parse the current file using the descriptions subcommand (works with ledger or hledger), otherwise it will parse the transactions in the current file itself.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.detailed_first

If you want the account completion to be sorted by level of detail/depth instead of alphabetical, set this option to 1.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.ledger.settings.extra_options

Additional default options for the ledger executable.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.ledger.settings.fillstring

String that will be used to fill the space between account name and amount in the foldtext. Set this to get some kind of lines or visual aid.

Type: null or string or raw lua code

Default: null

Plugin default: " "

Declared by:

plugins.ledger.settings.fold_blanks

By default vim will fold ledger transactions, leaving surrounding blank lines unfolded. You can use this option to hide blank lines following a transaction.

A value of 0 will disable folding of blank lines, 1 will allow folding of a single blank line between transactions; any larger value will enable folding unconditionally.

Note that only lines containing no trailing spaces are considered for folding. You can take advantage of this to disable this feature on a case-by-case basis.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.is_hledger

Whether to use ledger or hledger specific features. Setting this value is optional and in most coses will be guessed correctly based on bin, but in the event it isn’t guessed correctly or you want to use different syntax features even with your default tooling setup for the other engine this flag can be set to override the value.

Type: null or boolean

Default: null

Declared by:

plugins.ledger.settings.main

The file to be used to generate reports. The default is to use the current file.

Type: null or string or raw lua code

Default: null

Plugin default: "%"

Declared by:

plugins.ledger.settings.maxwidth

Number of columns that will be used to display the foldtext. Set this when you think that the amount is too far off to the right. When maxwidth is zero, the amount will be displayed at the far right side of the screen.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.pending_string

Text of the output of the |:Balance| command.

Type: null or string or raw lua code

Default: null

Plugin default: "Cleared or pending: "

Declared by:

plugins.ledger.settings.qf_hide_file

Flag to show or hide filenames in the quickfix window:

Filenames in the quickfix window are hidden by default. Set this to 1 is you want filenames to be visible.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.ledger.settings.qf_reconcile_format

Format of the reconcile quickfix window (see |:Reconcile|). The format is specified using the standard Ledger syntax for --format.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_register_format

Format of quickfix register reports (see |:Register|). The format is specified using the standard Ledger syntax for --format.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.ledger.settings.qf_size

Size of the quickfix window.

This is the number of lines of a horizontal quickfix window, or the number of columns of a vertical quickfix window.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 10

Declared by:

plugins.ledger.settings.qf_vertical

Position of the quickfix/location list. Set to 1 to open the quickfix window in a vertical split.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.target_string

Text of the output of the |:Balance| command.

Type: null or string or raw lua code

Default: null

Plugin default: "Difference from target: "

Declared by:

plugins.ledger.settings.use_location_list

Flag that tells whether a location list or a quickfix list should be used: The default is to use the quickfix window. Set to 1 to use a location list.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.ledger.settings.winpos

Position of a report buffer.

Use b for bottom, t for top, l for left, r for right. Use uppercase letters if you want the window to always occupy the full width or height.

Type: null or string or raw lua code

Default: null

Plugin default: "B"

Declared by: